sales

Lists sales orders from month-to-date

Lists sales orders from month-to-date

get/sales/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/sales/v1/orders
  • Auth: OAuth 2 (implicit, authorization URL "")

Query parameters

querystring

filters on sales order whose id prefix partially matched with this value (case insensitive)

status'PENDING' | 'PAID' | 'CANCELED'

filter on sales order whose status is equal to this value

limitinteger

limit

offsetinteger

offset

createdAt_gtestring

filter on sales orders whose created at is greater than or equal to this value; defaults to start of current month

createdAt_ltestring

filter on sales orders whose created at is less than or equal to this value; defaults to no upper bound

Response

OrdersList

totalCountinteger

Changes

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