Documentation
Feedback
Guides
API Reference

API Reference
Filter By
Post
Get
Put
Delete
Patch

Pick and Pack Order changes API

The Pick and Pack Order changes API manages order modifications in a Pick and Pack order. This API supports actions like updating deadlines, adding items, modifying quantities, rejecting or replacing items, and updating item details.

This API is currently in beta and subject to changes. Use it with caution in production environments.

Order changes

BIN locations

Common parameters

Parameter name Description Type
{{accountName}} Name of the VTEX account. Used as part of the URL. Server variable.
{{environment}} Environment to use. The default value is vtexcommercestable. Used in the URL. Server variable.
X-VTEX-API-AppKey Unique identifier of the API key. Must be used together with X-VTEX-API-AppToken. Authentication header
X-VTEX-API-AppToken Secret token of the API key. Must be used together with X-VTEX-API-AppKey. Authentication header
VtexIdclientAutCookie User token valid for 24 hours. Alternative to appKey + appToken. Authentication header

Endpoints

Order changes

SummaryMethodPath
Update order deadlinePUT/orders/{orderId}/deadline
Update items of the orderPOST/order/changes

BIN locations

SummaryMethodPath
Get BIN locationGET/{skuId}/warehouses/{warehouseId}
Create BIN locationPOST/{skuId}/warehouses/{warehouseId}
Update BIN locationPUT/{skuId}/warehouses/{warehouseId}
Delete BIN locationDELETE/{skuId}/warehouses/{warehouseId}
List BIN locationsGET/{skuId}/warehouses
Delete all BIN locationsDELETE/{skuId}/warehouses

Loading API specification...