v2.orders

List v2 Orders

get/orders

Request

  • Base URL: https://api.cooud.com/v2
  • URL: https://api.cooud.com/v2/orders
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of orders to return.

starting_afterstring

Return orders after this Cooud order id.

ending_beforestring

Return orders before this Cooud order id.

checkout_sessionstring

Only the orders paid through this v2 checkout session (cooud_cs_…), newest first: usually none or one. Pass payment_recovery.id to find the order of a recovered sale (Flow C), or the id of any live checkout session your integration created. Scoped to the store of the key or of the Cooud-Account: a session of another account returns an empty list, never its orders. Sandbox keys always get an empty list (sandbox sessions never create orders; the simulated cooud.order.paid uses ord_sim_…). The original session of a recovered sale has no order: its declined payment was canceled. Cannot be combined with starting_after or ending_before (400 parameter_invalid).

Headers

Cooud-Compat-Datestring date required

Required per-request compat-date. Format: ISO calendar date YYYY-MM-DD. Merchants pinned to an older date have their request and response transformed by every gate whose appliesAfter is strictly greater than this date.

Response

Orders for the store bound to the bearer token.

has_moreboolean required
object'list' required
request_idstring required
url'/v2/orders' required

Changes

No recorded changes to this operation across all 1 revision of this API.