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{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"contactInfo": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"email": "<string>",
"phone": "<string>"
},
"inventoryRefresh": "<string>",
"locations": [
{
"data": null,
"locationCode": "<string>",
"receiverId": "<string>"
}
],
"name": "<string>",
"status": "<string>",
"tenantId": 123,
"vendorCode": "<string>"
}Activate a vendor by setting its status to Active
Activate a vendor by setting its status to Active
PUT
/
commerce
/
vendors
/
{vendorCode}
/
activate
Error
A valid request URL is required to generate request examples{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"contactInfo": {
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"email": "<string>",
"phone": "<string>"
},
"inventoryRefresh": "<string>",
"locations": [
{
"data": null,
"locationCode": "<string>",
"receiverId": "<string>"
}
],
"name": "<string>",
"status": "<string>",
"tenantId": 123,
"vendorCode": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Unique vendor code
Query Parameters
limits which fields are returned in the response body
⌘I