API reference
- Getting Started with Your API
- SDKs and Toolkits
- Location Administration Overview
- PUTActivate a vendor by setting its status to Active
- PUTDeactivate a vendor by setting its status to InActive
- GETGet all locations associated with a vendor
- PUTUpdate vendor locations (bulk operation with upsert or full replace)
- POSTAdd locations to a vendor (bulk operation)
- GETGets a specific vendor by vendor code
- PUTUpdate a specific vendor
- DELDeletes a specific vendor
- GETGets a specific vendor SKU mapping by UPC
- PUTUpdate a specific vendor SKU mapping
- DELDeletes a specific vendor SKU mapping
- GETGets list of vendor SKU mappings by filter, sort and paging
- POSTCreate a new vendor SKU mapping
- GETGets list of vendors by filter, sort and paging
- POSTCreate a new vendor
- GETGets vendor SKU mappings for the vendor associated with a location
- POSTRemove multiple locations from a vendor (bulk operation, idempotent)
Error
A valid request URL is required to generate request examples{
"items": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"tenantId": 123,
"upc": "<string>",
"vendorCode": "<string>",
"vendorPrice": 123,
"vendorSku": "<string>"
}
],
"pageCount": 123,
"pageSize": 123,
"startIndex": 123,
"totalCount": 123
}Gets vendor SKU mappings for the vendor associated with a location
Gets vendor SKU mappings for the vendor associated with a location
GET
/
commerce
/
vendors
/
location
/
{locationCode}
/
skumappings
Error
A valid request URL is required to generate request examples{
"items": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"tenantId": 123,
"upc": "<string>",
"vendorCode": "<string>",
"vendorPrice": 123,
"vendorSku": "<string>"
}
],
"pageCount": 123,
"pageSize": 123,
"startIndex": 123,
"totalCount": 123
}Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Location code to find vendor for
Query Parameters
Starting index for pagination (default: 0)
Number of items per page (default: 100, max: 200)
Sort criteria (e.g., "upc asc", "vendorprice desc")
Filter criteria (e.g., "vendorprice gt 10.00")
limits which fields are returned in the response body
⌘I