Vendor API V1
Endpoints
-
GET
/vapi/v1/vendors -
GET
/vapi/v1/vendor/retailers/{retailer_id}/inventories -
GET
/vapi/v1/vendor/retailers/{retailer_id}/sales -
GET
/vapi/v1/vendor/retailers/{retailer_id}/products -
GET
/vapi/v1/vendor/retailers/{retailer_id}/purchase_orders -
GET
/vapi/v1/vendor/retailers -
GET
/vapi/v1/vendor/retailers/{id}
GET
/vapi/v1/vendors
List vendors connected to the integrator
Returns all active vendor connections. Auth requires only the integrator token.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
Authorization
|
string | header | Yes | Basic base64(integrator_token:) |
Responses
| Status | Description |
|---|---|
| 200 | Success |
| 401 | Unauthorized |
GET
/vapi/v1/vendor/retailers/{retailer_id}/inventories
Get VMI inventory data for a retailer
Returns inventory data from Redshift. Paginated with array slicing.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
Authorization
|
string | header | Yes | Basic base64(integrator_token:vendor_token) |
retailer_id
|
integer | path | Yes | Retailer ID |
sales_range_in_weeks
|
integer | query | No | Sales lookback in weeks (default 4) |
page
|
integer | query | No | Page number (default 1) |
per_page
|
integer | query | No | Results per page (default 100, max 1000) |
Responses
| Status | Description |
|---|---|
| 200 | Success |
| 401 | Unauthorized |
| 404 | Not Found |
GET
/vapi/v1/vendor/retailers/{retailer_id}/sales
Get sales data for a retailer
Returns daily sales aggregated by product type from Redshift.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
Authorization
|
string | header | Yes | Basic base64(integrator_token:vendor_token) |
retailer_id
|
integer | path | Yes | Retailer ID |
page
|
integer | query | No | Page number (default 1) |
per_page
|
integer | query | No | Results per page (default 100, max 1000) |
Responses
| Status | Description |
|---|---|
| 200 | Success |
| 401 | Unauthorized |
| 404 | Not Found |
GET
/vapi/v1/vendor/retailers/{retailer_id}/products
Get core products carried by a retailer
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
Authorization
|
string | header | Yes | Basic base64(integrator_token:vendor_token) |
retailer_id
|
integer | path | Yes | Retailer ID |
page
|
integer | query | No | Page number (default 1) |
per_page
|
integer | query | No | Results per page (default 100) |
Responses
| Status | Description |
|---|---|
| 200 | Success |
| 401 | Unauthorized |
| 404 | Not Found |
GET
/vapi/v1/vendor/retailers/{retailer_id}/purchase_orders
Get purchase orders for a retailer
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
Authorization
|
string | header | Yes | Basic base64(integrator_token:vendor_token) |
retailer_id
|
integer | path | Yes | Retailer ID |
page
|
integer | query | No | Page number (default 1) |
per_page
|
integer | query | No | Results per page (default 100) |
Responses
| Status | Description |
|---|---|
| 200 | Success |
| 401 | Unauthorized |
| 404 | Not Found |
GET
/vapi/v1/vendor/retailers
List all active retailers for the vendor
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
Authorization
|
string | header | Yes | Basic base64(integrator_token:vendor_token) |
vendor_id
|
integer | query | No | Vendor ID (alternative to vendor_token in auth header) |
Responses
| Status | Description |
|---|---|
| 200 | Success |
| 401 | Unauthorized |
GET
/vapi/v1/vendor/retailers/{id}
Get retailer details with inventory metrics
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
Authorization
|
string | header | Yes | Basic base64(integrator_token:vendor_token) |
id
|
integer | path | Yes | Retailer ID |
Responses
| Status | Description |
|---|---|
| 200 | Success |
| 401 | Unauthorized |
| 404 | Not Found |