List
Returns a list of products.
Request
Headers
The "Authorization" header for this API method contains an <access_token> placeholder. Replace it with the value of an actual access token.
Name | Value |
Authorization | Bearer <access_token> |
URL
Name | Value |
Method | GET |
Endpoint |
Parameters
Name | Allowed values | Required |
page | (An integer greater than 0, default: 1) | No |
page_size | (An integer between 1 and 1000, default: 25) | No |
sort | (A valid sort value, see table below, default: "name") | No |
Allowed values:
Value | Description |
name | Sorts on name, ascending. |
-name | Sorts on name, descending. |
Response
Headers
Name | Value |
Status code | 200 |
Status message | OK |
Example
{
"meta": {
"count": 14
},
"success": true,
"products": [
{
"external_id": "c17b8994-7a31-4dda-b710-a1bb5cd97e55",
"sku": "rd001",
"gtin": "0075678164125",
"name": "Red Delicous",
"url": "https://www.example.com/products/red-delicous",
"image_url": "https://www.example.com/images/red-delicous.jpeg",
"id": 1234
}
]
}
Get
Returns a product.
Request
Headers
The "Authorization" header for this API method contains an <access_token> placeholder. Replace it with the value of an actual access token.
Name | Value |
Authorization | Bearer <access_token> |
URL
The endpoint for this API method contains an <id> placeholder. Replace it with the value of an actual product id.
Name | Value |
Method | GET |
Endpoint |
Response
Headers
Name | Value |
Status code | 200 |
Status message | OK |
Example
{
"success": true,
"product": {
"external_id": "c17b8994-7a31-4dda-b710-a1bb5cd97e55",
"sku": "rd001",
"gtin": "0075678164125",
"name": "Red Delicous",
"url": "https://www.example.com/products/red-delicous",
"image_url": "https://www.example.com/images/red-delicous.jpeg",
"id": 1234
}
}