sales

Retrieves an order summary from month-to-date

Retrieves an order summary from month-to-date

get/sales/v1/orders/summary

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

Query parameters

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

GetOrderSummaryResponse

totalDevicesSoldinteger

TotalDevicesSold is a total devices sold from month-to-date

totalNetAmountinteger

TotalNetAmount is a sum of net amount from month-to-date in the smallest currency unit (satang). e.g. 1 THB = 100.

totalOrdersinteger

TotalOrders is a total number of orders from month-to-date

Changes

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