latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Commerce Products
Get the latest products for a business available in their merchant store.
get/commerce/products
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
namestring
status'active' | 'archived' | 'draft'
startDatestring
endDatestring
Response
Example response
{
"data": [
{
"id": "632910392",
"type": "Speakers",
"name": "Amazon Echo",
"description": "Sample product description",
"createdDate": "2021-03-09T10:18:29.985Z",
"sourceModifiedDate": "2021-03-09T10:18:29.985Z",
"status": "active",
"isGiftCard": true,
"productVariants": [
{
"id": "808950810",
"name": "Pink",
"isTaxEnabled": true,
"sku": "IPOD2008PINK",
"barcode": "1234_pink",
"weight": {
"value": 1.25,
"unitOfMeasure": "lb"
},
"unitPrice": 199,
"inventory": {
"totalQuantity": 10,
"quantityPerLocation": [
{
"locationRef": {
"id": "12323"
}
}
]
},
"isShippingRequired": true,
"createdDate": "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"
}
}