sales

Retrieves an order by id

Retrieves an order by id

get/sales/v1/orders/{orderId}

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

Path parameters

orderIdstring required

orderId

Response

Order

createdAtstring
createdBystring
discountAmountinteger

DiscountAmount is in the smallest currency unit (satang). e.g. 1 THB = 100.

fulfillmentMethod'PICKUP' | 'DELIVERY'
grossAmountinteger

GrossAmount is the price before discount in the smallest currency unit (satang). e.g. 1 THB = 100.

idstring
netAmountinteger

NetAmount is the price after discount in the smallest currency unit (satang). e.g. 1 THB = 100.

numberOfItemsinteger
orderNumberstring
pricePerUnitinteger

PricePerUnit is in the smallest currency unit (satang). e.g. 1 THB = 100.

promoCodestring
salesMemberNamestring
status'PENDING' | 'PAID' | 'CANCELED'
updatedAtstring
updatedBystring

Changes

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