atlas

List orders

List orders from the online store and sales tool List orders from the online store and sales tool

get/atlas/v1/orders

Request

  • Base URL: https://api.beamcheckout.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.beamcheckout.com/atlas/v1/orders
  • Auth: OAuth 2 (implicit, authorization URL "")

Query parameters

orderNumber_iprefixstring

query by order number prefix case-insensitive

customerName_ilikestring

query by customer name full text search case-insensitive

zortOrderId_iprefixstring

query by zort order id prefix case-insensitive

trackingNumber_iprefixstring

query by tracking number prefix case-insensitive

status_instring[]

status_in

source_instring[]

source_in

createdAt_gtestring

filter on orders whose createdAt is greater than or equal to this value

createdAt_ltestring

filter on orders whose createdAt is less than or equal to this value

limitinteger

limit

afterCursorstring

cursor from endCursor of the previous page

beforeCursorstring

cursor from startCursor of the next page

Response

success

endCursorstring
hasNextPageboolean
hasPrevPageboolean
startCursorstring

Changes

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