Products
Supported product attributes:
| Attribute | Type | Description |
|---|---|---|
id | number | Unique identifier of the product. |
name | string | Name of the product. |
description | string | Description of the product. |
sku | string | Stock Keeping Unit identification code. |
active | boolean | Indicator of whether the product is active. Line items cannot be created from inactive products. |
max_discount | number | Maximum discount that can be applied to the product in percents. |
max_markup | number | Maximum markup that can be applied to the product in percents. |
cost | string | Cost of the product. Eg. "10.25" |
cost_currency | string | Currency of the product cost, specified in 3-character currency code (ISO4217) format. Visible only to account administrators. Eg. "EUR" |
prices | array | Array specifying products prices in different currencies. |
created_at | string | Date and time that the product was created in UTC (ISO8601 format). |
Endpoints
Stream Product
Read the stream of product events.
See the Firehose Overview article for more details on request and response formats and parameters.
Action
GET /v3/products/stream
Examples
Read the stream of product events
GET /v3/products/stream?position=tailAccept: application/jsonAuthorization: Bearer $ACCESS_TOKENUser-Agent: $CLIENT_NAME
HTTP/1.1 200 OKContent-Type: application/json{"items": [{"data": {"cost": "22.36","cost_currency": "USD","description": "Super gloves","active": true,"created_at": "2017-06-21T06:40:21Z","name": "Gloves","max_discount": 35,"id": 1180540,"sku": "902211946-7","prices": [{"amount": "33.61","currency": "USD"}],"max_markup": 794},"meta": {"event_cause": "interaction","sequence": 2,"event_id": "unJp3ZIhQqGt5gqqAe9NPw","event_type": "updated","previous": {"prices": [{"amount": "31.69","currency": "USD"}],"max_markup": 662},"type": "product","event_time": "2017-06-21T06:40:23Z"}}],"meta": {"links": {"next": "https://api.getbase.com/v3/products/stream?position=ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg=="},"position": "ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg==","top": false}}