latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Commerce Orders
Gets a list of orders for a business.
get/commerce/orders
Query parameters
businessNamestring required
Unique business name identifier.
serviceName'shopify' | 'square' required
Name of commerce service.
offsetnumber
The offset is the position in the dataset of a particular record.
limitnumber
This is the size of the results set you would like (default: 100).
orderBystring
idstring
fulfillmentStatus'fulfilled' | 'partial' | 'unfulfilled' | 'cancelled' | 'unknown'
paymentStatus'pending' | 'approved' | 'paid' | 'failed' | 'cancelled' | 'refunded' | 'unknown'
status'open' | 'closed' | 'cancelled' | 'unknown' | 'draft'
startDatestring
endDatestring
Response
Example response
{
"data": [
{
"id": "450789469",
"orderNumber": "1001",
"fulfillmentRefs": [
{
"carrier": "USPS",
"trackingNumber": "1Z2345",
"service": "manual",
"trackingUrl": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z2345"
}
],
"lines": [
{
"id": "466157049",
"balances": [
{
"date": "2022-03-11T11:29:03-05:00"
}
],
"accountRef": {
"id": "145",
"name": "Example account"
},
"customerRef": {
"id": "145",
"name": "Example account"
},
"trackingCategoryRefs": [
{
"id": "4040",
"name": "Region",
"type": "class"
}
]
}
],
"refundRefs": [
{
"totalAmount": 2
}
],
"transactionSourceRefs": [
{
"id": "699519475",
"type": "payment"
}
],
"shippingAddress": {
"line1": "1234 Park Street",
"line2": "Suite 1000",
"city": "Toronto",
"region": "ON",
"country": "CAN",
"postalCode": "A0B1C2"
},
"billingAddress": {
"line1": "1234 Park Street",
"line2": "Suite 1000",
"city": "Toronto",
"region": "ON",
"country": "CAN",
"postalCode": "A0B1C2"
},
"customerRef": {
"id": "207119551",
"customerName": "Amelia Earhart",
"email": "Amelia.Earhart@example.com"
},
"currencyRef": {
"symbol": "CAD",
"name": "Canadian Dollar"
},
"totalShippingAmount": 30,
"totalGratuityAmount": 4.87,
"totalTaxAmount": 11.94,
"totalAmount": 598.94,
"createdDate": "2022-03-11T11:29:03-05:00",
"sourceModifiedDate": "2022-03-11T11:29:03-05:00"
}
],
"count": 1,
"meta": {
"reportId": [
"5fad8a342a88364234392fb5"
],
"serviceName": "xero",
"businessName": "Railz",
"createdAt": "2020-11-25T01:02:03Z",
"updatedAt": "2020-11-30T01:02:03Z",
"startDate": "2020-11-25T01:02:03Z",
"endDate": "2020-11-30T01:02:03Z"
}
}