{ "openapi": "3.0.0", "info": { "title": "Pick and Pack API", "description": "The Pick and Pack API provides comprehensive functionality for order management, picking operations, shipment tracking, and returns processing. The main capabilities include:\r\n\r\n- Retrieving detailed order information, including items, packages, and status\r\n- Accessing worksheet data for picking operations\r\n- Querying shipment tracking and delivery details\r\n- Getting facility information\r\n\r\n## Common issues and solutions\r\n\r\nIn case of errors making a request, check the list of common issues and their solutions below.\r\n\r\n### 1. Token expiration\r\n\r\n- Authentication token expires after 15 minutes. \r\n- Check console logs for refresh attempt. \r\n- Verify `APIKEY_ACCOUNT` format. \r\n- Ensure that endpoint URLs are correct. \r\n\r\n### 2. Variable errors\r\n\r\n- Check variable syntax. \r\n- Validate API key format. \r\n\r\n### 3. Cache-related issues\r\n\r\n- Response data might appear stale due to API caching. \r\n- Endpoints have a specific cache duration of 30 seconds. \r\n- For real-time data, consider the cache duration when implementing polling strategies. \r\n- Cache is based on specific parameters (e.g., `orderId`, `shipmentId`).", "contact": {}, "version": "1.0" }, "servers": [ { "url": "https://auth.pickingnpacking.com/prod", "description": "Server to access the authentication necessary to make a request in the Pick and Pack API." }, { "url": "https://api.pick-and-pack.com/prod/v1", "description": "Server to access the Pick and Pack API." } ], "paths": { "/token": { "post": { "tags": ["Authentication"], "summary": "Generate JWT token", "description": "Generates a `JWT` (JSON Web Token) necessary to access the Pick and Pack API information. To generate the `JWT` it's necessary to have the `API KEY`. To obtain this information, access **VTEX Admin > Shipping > Pick and Pack > Settings > Integration > API Key**.\r\n\r\n>ℹ️ The authentication token expires after 15 minutes \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Administration | **Homepage** |\r\n| Catalog | Administration | **Help home page** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Admin - Start page only | Homepage |\r\n| Admin - Start page only | Help home page |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or API keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "requestBody": { "content": { "application/json": { "schema": { "required": ["apiKey"], "type": "object", "properties": { "apiKey": { "type": "string", "description": "The `API KEY` generated in **VTEX Admin > Shipping > Pick and Pack > Settings > Integration > API Key**." } } }, "example": { "apiKey": "{pnpApiKey}" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message." }, "data": { "type": "string", "description": "JWT token." } } }, "example": { "message": "success", "data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJob3N0bmFtZSI6Imxhc3RtaWxlIiwidXNlcm5hbWUiOiJsYXN0bWlsZS5jcmlzdGlhbnJvbWVyb3Z0ZXhjb20iLCJpYXQiOjE3Mzk0NDkyNTMsImV4cCI6MTczOTQ1MDE1M30.lkb1e5XDuUBddthwaxrvi_Ub0YBEAEessJy_bvzb-do" } } } } }, "servers": [ { "url": "https://auth.pickingnpacking.com/prod", "description": "Server to access the authentication necessary to make a request in the Pick and Pack API." } ], "security": [] } }, "/orders/{orderId}": { "get": { "tags": ["Orders"], "summary": "Get order by ID", "description": "Retrieves order details by its ID.\n\n>ℹ️ The response is cached for 30 seconds based on the `orderId` parameter. The endpoint supports up to 500 requests per second, with a maximum of 100 concurrent requests.\n\n>ℹ️ [Generate a JWT token](https://developers.vtex.com/docs/api-reference/pick-and-pack-api#post-/token) to endpoint authentication. JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information as a JSON object between parties.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Administration | **Homepage** |\r\n| Catalog | Administration | **Help home page** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Admin - Start page only | Homepage |\r\n| Admin - Start page only | Help home page |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or API keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" }, { "name": "orderId", "in": "path", "description": "Order ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "1509750516095-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "Order with status, timing, items, packages, invoices, and payments.", "properties": { "orderId": { "type": "string", "description": "Unique order identifier assigned by the platform." }, "sequence": { "type": "string", "description": "Sequence number for the order." }, "status": { "type": "string", "description": "Order status.", "enum": [ "IN_PROGRESS", "PENDING", "COLLECTED", "COMPLETED", "READY_FOR_PACKING", "PACKING", "PACKED", "SORTING", "CANCELLED", "REJECTED" ], "minLength": 1 }, "createdAt": { "type": "string", "description": "Order creation date and time in ISO 8601 format.", "format": "date-time" }, "updatedAt": { "type": "string", "description": "Order last update date and time in ISO 8601 format.", "format": "date-time" }, "shippingEstimatedDateMin": { "type": "string", "description": "Minimum estimated shipping date and time in ISO 8601 format.", "format": "date-time" }, "tags": { "type": "array", "description": "List of free-form tags associated with the order.", "items": { "type": "string", "description": "Order tag." } }, "pickingTime": { "type": "number", "description": "Time spent in picking stage, in minutes (decimal)." }, "packingTime": { "type": "number", "description": "Time spent in packing stage, in minutes (decimal)." }, "shippingTime": { "type": "number", "description": "Time spent in shipping stage, in minutes (decimal)." }, "invoices": { "type": "array", "description": "Invoices associated with the order.", "items": { "type": "object", "description": "Invoice entry with key and total.", "properties": { "invoiceKey": { "type": "string", "description": "Unique invoice key or identifier." }, "invoiceTotal": { "type": "integer", "description": "Total invoice amount in minor currency units." } }, "required": [ "invoiceKey", "invoiceTotal" ] } }, "unhandledItems": { "type": "array", "description": "Order unhandled items, not yet processed to a final state.", "items": { "type": "object", "description": "Order item currently unhandled.", "properties": { "id": { "type": "string", "description": "Unhandled item ID." }, "sku": { "type": "string", "description": "Unhandled item SKU." }, "referenceCode": { "type": "string", "description": "Unhandled item reference code." }, "itemName": { "type": "string", "description": "Unhandled item name." }, "price": { "type": "number", "description": "Unhandled item price." }, "pickingPrice": { "type": "number", "nullable": true, "description": "Unit price used during picking." }, "quantity": { "type": "integer", "nullable": true, "description": "Final quantity for this item." }, "originalQuantity": { "type": "integer", "description": "Quantity originally ordered before any adjustments." }, "replacedBy": { "type": "array", "nullable": true, "items": { "type": "string", "description": "Unhandled item replaced by." }, "description": "List of unhandled item replaced by." }, "weighableProduct": { "type": "boolean", "description": "Indicates if the product was sold by weight (`true`) or not (`false`)." }, "unitMultiplier": { "type": "number", "description": "Unit multiplier applied to the item." }, "originalUnitMultiplier": { "type": "number", "description": "Original unit multiplier before any changes." }, "unitOfMeasure": { "type": "string", "description": "Unit of measure for the item." }, "images": { "type": "array", "description": "List of unhandled item images.", "items": { "type": "string", "description": "URL of an item image." } }, "ean": { "type": "string", "description": "Unhandled item EAN." }, "status": { "type": "string", "description": "Unhandled item status.", "enum": [ "IN_PROGRESS", "PENDING", "COLLECTED", "COMPLETED", "READY_FOR_PACKING", "PACKING", "PACKED", "SORTING", "CANCELLED", "REJECTED" ] }, "packedQuantity": { "type": "integer", "description": "Quantity packed for this item.", "nullable": true }, "reasons": { "type": "array", "description": "Reasons for rejection or change.", "nullable": true, "items": { "type": "object", "description": "Reason entry explaining an exception or change.", "properties": { "reasonType": { "type": "string", "description": "Reason type." }, "reasonDetail": { "type": "string", "description": "Reason for the unhandled item, such as out-of-stock." } } } }, "pickers": { "type": "array", "nullable": true, "description": "Identifiers of pickers who handled this line.", "items": { "type": "string", "description": "Picker name." } }, "worksheets": { "type": "array", "nullable": true, "description": "List of related worksheet identifiers.", "items": { "type": "string", "description": "Worksheet identifier." } }, "warehouses": { "type": "array", "description": "List of warehouse allocation or availability for this item.", "items": { "type": "object", "description": "Warehouse allocation record.", "properties": { "warehouseId": { "type": "string", "description": "Warehouse identifier." }, "warehouseName": { "type": "string", "description": "Warehouse name." }, "quantity": { "type": "integer", "description": "Quantity allocated from the warehouse." } }, "required": [ "warehouseId", "warehouseName", "quantity" ] } }, "createdAt": { "type": "string", "description": "Item created date and time in ISO 8601 timestamp.", "format": "date-time" } }, "required": [ "id", "sku", "referenceCode", "itemName", "price", "pickingPrice", "quantity", "originalQuantity", "replacedBy", "weighableProduct", "unitMultiplier", "originalUnitMultiplier", "unitOfMeasure", "images", "ean", "status", "packedQuantity", "reasons", "pickers", "worksheets", "warehouses", "createdAt" ] } }, "pickedItems": { "type": "array", "description": "List of order items picked.", "items": { "type": "object", "description": "Picked order item.", "properties": { "id": { "type": "string", "description": "Picked item identifier." }, "sku": { "type": "string", "description": "Picked item SKU." }, "referenceCode": { "type": "string", "description": "Picked item reference code." }, "itemName": { "type": "string", "description": "Picked item name." }, "price": { "type": "number", "description": "Picked item price." }, "pickingPrice": { "type": "number", "nullable": true, "description": "Unit price used during picking." }, "quantity": { "type": "integer", "nullable": true, "description": "Final quantity for this item." }, "originalQuantity": { "type": "integer", "description": "Quantity originally ordered before any adjustments." }, "replacedBy": { "type": "array", "nullable": true, "items": { "type": "string", "description": "Picked item replaced by." }, "description": "List of picked item replaced by." }, "weighableProduct": { "type": "boolean", "description": "Indicates if the product was sold by weight (`true`) or not (`false`)." }, "unitMultiplier": { "type": "number", "description": "Unit multiplier applied to the item." }, "originalUnitMultiplier": { "type": "number", "description": "Original unit multiplier before any changes." }, "unitOfMeasure": { "type": "string", "description": "Unit of measure for the item." }, "images": { "type": "array", "items": { "type": "string", "description": "Picked item image." }, "description": "List of picked item images." }, "ean": { "type": "string", "description": "Picked item EAN." }, "status": { "type": "string", "description": "Picked item status.", "enum": [ "IN_PROGRESS", "PENDING", "COLLECTED", "COMPLETED", "READY_FOR_PACKING", "PACKING", "PACKED", "SORTING", "CANCELLED", "REJECTED" ] }, "packedQuantity": { "type": "integer", "description": "Quantity packed for this picked item.", "nullable": true }, "reasons": { "type": "array", "description": "List of reasons for rejection or change.", "nullable": true, "items": { "type": "object", "description": "Reason entry explaining an exception or change.", "properties": { "reasonType": { "type": "string", "description": "Reason type." }, "reasonDetail": { "type": "string", "description": "Reason detail such as out-of-stock." } } } }, "pickers": { "type": "array", "nullable": true, "description": "Identifiers of pickers who handled this line.", "items": { "type": "string", "description": "Picker name." } }, "worksheets": { "type": "array", "nullable": true, "description": "List of related worksheet identifiers.", "items": { "type": "string", "description": "Worksheet identifier." } }, "warehouses": { "type": "array", "description": "List of warehouse allocation or availability for this item.", "items": { "type": "object", "description": "Warehouse allocation record.", "properties": { "warehouseId": { "type": "string", "description": "Warehouse identifier." }, "warehouseName": { "type": "string", "description": "Warehouse display name." }, "quantity": { "type": "integer", "description": "Quantity allocated from the warehouse." } }, "required": [ "warehouseId", "warehouseName", "quantity" ] } }, "createdAt": { "type": "string", "description": "Picked item creation date in ISO 8601 format.", "format": "date-time" } }, "required": [ "id", "sku", "referenceCode", "itemName", "price", "pickingPrice", "quantity", "originalQuantity", "replacedBy", "weighableProduct", "unitMultiplier", "originalUnitMultiplier", "unitOfMeasure", "images", "ean", "status", "packedQuantity", "reasons", "pickers", "worksheets", "warehouses", "createdAt" ] } }, "rejectedItems": { "type": "array", "description": "List of items that were rejected, for example due to being out-of-stock.", "items": { "type": "object", "description": "Rejected order item.", "properties": { "id": { "type": "string", "description": "Rejected item identifier within the order." }, "sku": { "type": "string", "description": "Rejected item SKU." }, "referenceCode": { "type": "string", "description": "Rejected item reference code." }, "itemName": { "type": "string", "description": "Rejected item name." }, "price": { "type": "number", "description": "Rejected item price." }, "pickingPrice": { "type": "number", "nullable": true, "description": "Rejected item picking price." }, "quantity": { "type": "integer", "nullable": true, "description": "Final quantity for this rejected item." }, "originalQuantity": { "type": "integer", "description": "Quantity originally ordered before any adjustments." }, "replacedBy": { "type": "array", "nullable": true, "items": { "type": "string", "description": "ID of the items that served as replacements for this one." }, "description": "List of items that replaced the current item." }, "weighableProduct": { "type": "boolean", "description": "Indicates if the product was sold by weight (`true`) or not (`false`)." }, "unitMultiplier": { "type": "number", "description": "Rejected item unit multiplier." }, "originalUnitMultiplier": { "type": "number", "description": "Original unit multiplier before any changes." }, "unitOfMeasure": { "type": "string", "description": "Unit of measure for the item." }, "images": { "type": "array", "description": "Rejected item images URLs.", "items": { "type": "string", "description": "URL of a rejected item image." } }, "ean": { "type": "string", "description": "Rejected item EAN." }, "status": { "type": "string", "description": "Rejected item status.", "enum": [ "IN_PROGRESS", "PENDING", "COLLECTED", "COMPLETED", "READY_FOR_PACKING", "PACKING", "PACKED", "SORTING", "CANCELLED", "REJECTED" ] }, "packedQuantity": { "type": "integer", "description": "Quantity packed for this item.", "nullable": true }, "reasons": { "type": "array", "description": "List of reasons for rejection or change.", "nullable": true, "items": { "type": "object", "description": "Reason entry explaining an exception or change.", "properties": { "reasonType": { "type": "string", "description": "Reason type." }, "reasonDetail": { "type": "string", "description": "Reason detail such as out-of-stock." } } } }, "pickers": { "type": "array", "description": "Identifiers of pickers who handled this item.", "items": { "type": "string", "description": "Picker name." } }, "worksheets": { "type": "array", "description": "List of related worksheet identifiers.", "items": { "type": "string", "description": "Worksheet identifier." } }, "warehouses": { "type": "array", "description": "List of warehouse allocation or availability for this item.", "items": { "type": "object", "description": "Warehouse allocation record.", "properties": { "warehouseId": { "type": "string", "description": "Warehouse identifier." }, "warehouseName": { "type": "string", "description": "Warehouse display name." }, "quantity": { "type": "integer", "description": "Quantity allocated from the warehouse." } }, "required": [ "warehouseId", "warehouseName", "quantity" ] } }, "createdAt": { "type": "string", "description": "Rejected item creation date in ISO 8601 format.", "format": "date-time" } }, "required": [ "id", "sku", "referenceCode", "itemName", "price", "pickingPrice", "quantity", "originalQuantity", "replacedBy", "weighableProduct", "unitMultiplier", "originalUnitMultiplier", "unitOfMeasure", "images", "ean", "status", "packedQuantity", "reasons", "pickers", "worksheets", "warehouses", "createdAt" ] } }, "replacedItems": { "type": "array", "description": "Items that replaced other items or were themselves replacements.", "items": { "type": "object", "description": "Replacement order item.", "properties": { "id": { "type": "string", "description": "Replaced item ID." }, "referenceCode": { "type": "string", "description": "Replaced item reference code." }, "orderSource": { "type": "string", "description": "Order source." }, "originalQuantity": { "type": "integer", "description": "Replaced item original quantity." }, "image": { "type": "string", "description": "Replaced item image." }, "temperature": { "type": "string", "nullable": true, "enum": [ "COLD", "FROZEN", "AMBIENT", "HOT" ], "description": "Replaced item temperature." } }, "required": [ "id", "referenceCode", "name", "originalQuantity", "image", "orderSource", "temperature" ] } }, "packages": { "type": "array", "description": "List of packages created for the order.", "items": { "type": "object", "description": "Order package.", "properties": { "id": { "type": "string", "description": "Package identifier." }, "status": { "type": "string", "description": "Package status.", "enum": [ "IN_PROGRESS", "PENDING", "COLLECTED", "COMPLETED", "READY_FOR_PACKING", "PACKING", "PACKED", "SORTING", "CANCELLED", "REJECTED" ] }, "itemsIds": { "type": "array", "description": "List of identifiers of items included in this package.", "items": { "type": "string", "description": "Item ID contained in the package." } } }, "required": [ "id", "status", "itemsIds" ] } }, "payment": { "type": "array", "description": "List of payments linked to this order.", "items": { "type": "object", "description": "Order payment.", "properties": { "paymentId": { "type": "string", "description": "Payment identifier." }, "paymentName": { "type": "string", "description": "Payment method name." }, "transactionId": { "type": "string", "description": "Payment gateway transaction identifier." }, "currency": { "type": "object", "description": "Currency details.", "properties": { "symbol": { "type": "string", "description": "Currency symbol." }, "code": { "type": "string", "description": "ISO 4217 currency code." }, "decimalSeparator": { "type": "string", "description": "Decimal separator character." }, "name": { "type": "string", "description": "Currency display name or code." }, "decimalDigits": { "type": "integer", "description": "Number of decimal digits." }, "groupSize": { "type": "integer", "description": "Digit group size for thousands." }, "groupSeparator": { "type": "string", "description": "Thousands group separator character." } }, "required": [ "symbol", "code", "decimalSeparator", "name", "decimalDigits", "groupSize", "groupSeparator" ] } }, "required": [ "paymentId", "paymentName", "transactionId", "currency" ] } } }, "required": [ "orderId", "sequence", "status", "createdAt", "updatedAt", "shippingEstimatedDateMin", "tags", "pickingTime", "packingTime", "shippingTime", "invoices", "unhandledItems", "pickedItems", "rejectedItems", "replacedItems", "packages", "payment" ] }, "example": { "orderId": "1509750516095-01", "sequence": "516095", "status": "IN_PROGRESS", "createdAt": "2025-02-10T15:02:50.545Z", "updatedAt": "2025-02-11T18:27:35.599Z", "shippingEstimatedDateMin": "2025-02-10T15:06:48.9411586+00:00", "tags": [], "pickingTime": 27.116, "packingTime": 14.533, "shippingTime": 0, "invoices": [ { "invoiceKey": "key-78923479834", "invoiceTotal": 2000322 } ], "unhandledItems": [], "pickedItems": [ { "id": "75", "sku": "75", "referenceCode": "000673", "itemName": "Banana, 190g Banana, 190", "price": 1699, "pickingPrice": 322, "quantity": 1, "originalQuantity": 1, "replacedBy": null, "weighableProduct": true, "unitMultiplier": 0.19, "originalUnitMultiplier": 0.19, "unitOfMeasure": "KILOGRAMS", "images": [ "https://lastmile.vteximg.com.br/arquivos/ids/155763-55-55/75.jpg?v=637917697038830000" ], "ean": "EAN174", "status": "COMPLETED", "packedQuantity": 1, "reasons": null, "pickers": ["returnsconnect"], "worksheets": ["546206888193"], "warehouses": [ { "warehouseId": "9029", "warehouseName": "ColombiaMAIN", "quantity": 1 } ], "createdAt": "2025-02-10T18:58:27.790Z" }, { "id": "137", "sku": "137", "referenceCode": "000673", "itemName": "Water 1.5 L", "price": 1000000, "pickingPrice": 1000000, "quantity": 1, "originalQuantity": 1, "replacedBy": null, "weighableProduct": false, "unitMultiplier": 1, "originalUnitMultiplier": 1, "unitOfMeasure": "UNITS", "images": [ "https://lastmile.vteximg.com.br/arquivos/ids/155828-55-55/Water.jpg?v=638115564398670000" ], "ean": "EAN241", "status": "COMPLETED", "packedQuantity": 1, "reasons": null, "pickers": ["returnsconnect"], "worksheets": ["546206888193"], "warehouses": [ { "warehouseId": "9029", "warehouseName": "ColombiaMAIN", "quantity": 1 } ], "createdAt": "2025-02-10T18:58:37.139Z" }, { "id": "140", "sku": "140", "referenceCode": "000673", "itemName": "Ball", "price": 1000000, "pickingPrice": 1000000, "quantity": 1, "originalQuantity": 1, "replacedBy": null, "weighableProduct": false, "unitMultiplier": 1, "originalUnitMultiplier": 1, "unitOfMeasure": "UNITS", "images": [ "https://lastmile.vteximg.com.br/arquivos/ids/155831-55-55/Ball.jpg?v=638115565920770000" ], "ean": "EAN244", "status": "COMPLETED", "packedQuantity": 1, "reasons": null, "pickers": ["returnsconnect"], "worksheets": ["546206888193"], "warehouses": [ { "warehouseId": "9029", "warehouseName": "ColombiaMAIN", "quantity": 1 } ], "createdAt": "2025-02-10T18:58:39.805Z" } ], "rejectedItems": [ { "id": "139", "sku": "139", "referenceCode": "000673", "itemName": "Lettuce", "price": 1000000, "pickingPrice": 1000000, "quantity": 1, "originalQuantity": 1, "replacedBy": null, "weighableProduct": false, "unitMultiplier": 1, "originalUnitMultiplier": 1, "unitOfMeasure": "UNITS", "images": [ "https://lastmile.vteximg.com.br/arquivos/ids/155830-55-55/Lettuce.jpg?v=638115565486870000" ], "ean": "EAN243", "status": "COMPLETED", "packedQuantity": null, "reasons": [ { "reasonType": "1509750516095-01", "reasonDetail": "out-of-stock" } ], "pickers": ["returnsconnect"], "worksheets": ["546206888193"], "warehouses": [ { "warehouseId": "9029", "warehouseName": "ColombiaMAIN", "quantity": 1 } ], "createdAt": "2025-02-10T18:58:31.021Z" } ], "replacedItems": [], "packages": [ { "id": "b05a0fa9-a11e-476e-bf58-677cf0431424", "status": "PACKED", "itemsIds": ["75", "140", "137"] } ], "payment": [ { "paymentId": "C92F6C921B1E450B9F22310A96EE88DC", "paymentName": "Cash", "transactionId": "8EAB87B7EB2746DAABD673664C9E15BE", "currency": { "symbol": "$", "code": "MXN", "decimalSeparator": ".", "name": "MXN", "decimalDigits": 2, "groupSize": 3, "groupSeparator": "," } } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/403Expiredtoken" }, { "$ref": "#/components/schemas/403Forbidden" } ] }, "examples": { "ExpiredToken": { "summary": "Example of an expired token error", "value": { "message": "User is not authorized to access this resource with an explicit deny", "code": "EXPIRED_TOKEN", "reason": "Expired token", "requestId": "1a36389e-0050-436e-a1d0-14cfb6508c2f" } }, "Forbidden": { "summary": "Example of a forbidden access error", "value": { "type": "business", "code": "SHR0007B", "message": "You do not have access to this order [1481120515528-01]", "date": "2024-12-04T01:03:29.495Z", "requestId": "3d292319-2129-47b6-a748-92a8be02576a" } } } } } } }, "security": [ { "Authorization": [] } ], "servers": [ { "url": "https://api.pick-and-pack.com/prod/v1", "description": "Server to access the Pick and Pack API." } ] } }, "/orders/{orderId}/tracking": { "patch": { "tags": ["Orders"], "summary": "Set order delivery", "description": "This endpoint finalizes the Pick and Pack workflow by marking the order as delivered. Additionally, it allows you to update the OMS with shipping details. All fields are optional. For more information, see [Update order tracking status](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-/tracking) endpoint.\n\n>ℹ️ [Generate a JWT token](https://developers.vtex.com/docs/api-reference/pick-and-pack-api#post-/token) to endpoint authentication. JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information as a JSON object between parties.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Administration | **Homepage** |\r\n| Catalog | Administration | **Help home page** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Admin - Start page only | Homepage |\r\n| Admin - Start page only | Help home page |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or API keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "name": "orderId", "in": "path", "description": "Order ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "1506390515917-01" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "deliveredDate": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time when the order was delivered." }, "events": { "type": "array", "description": "List of events that occurred during the delivery process.", "items": { "type": "object", "required": [ "city", "state", "description", "date" ], "description": "Event details.", "properties": { "city": { "type": "string", "description": "City where the event occurred." }, "state": { "type": "string", "description": "State where the event occurred." }, "description": { "type": "string", "description": "Event description." }, "date": { "type": "string", "description": "Date and time when the event occurred." } } } } }, "example": { "deliveredDate": "2025-02-13T02:00:00.000Z", "events": [ { "city": "São Paulo", "state": "SP", "description": "Delivery", "date": "2025-02-10T00:00:00.000Z" } ] } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "deliveredDate": { "type": "string", "format": "date-time", "nullable": true, "description": "Date and time when the order was delivered." }, "events": { "type": "array", "description": "List of events that occurred during the delivery process.", "items": { "type": "object", "required": [ "city", "state", "description", "date" ], "description": "Event details.", "properties": { "city": { "type": "string", "description": "City where the event occurred." }, "state": { "type": "string", "description": "State where the event occurred." }, "description": { "type": "string", "description": "Event description." }, "date": { "type": "string", "description": "Date and time when the event occurred." } } } }, "orderId": { "type": "string", "description": "Unique order identifier associated with this delivery tracking record." } } }, "example": { "deliveredDate": "2025-02-13T02:00:00.000Z", "events": [ { "city": "São Paulo", "state": "SP", "description": "Delivery", "date": "2025-02-10T00:00:00.000Z" } ], "orderId": "1507400515991-01" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404Notfound" }, "example": { "type": "exception", "code": "ORA0001B", "message": "The order must be invoiced to update the status to delivered", "date": "2025-02-13T11:29:50.757Z", "requestId": "a82ec832-14cc-4a53-ad50-de67538bc934" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/403Expiredtoken" }, { "$ref": "#/components/schemas/403Forbidden" } ] }, "examples": { "ExpiredToken": { "summary": "Example of an expired token error", "value": { "message": "User is not authorized to access this resource with an explicit deny", "code": "EXPIRED_TOKEN", "reason": "Expired token", "requestId": "1a36389e-0050-436e-a1d0-14cfb6508c2f" } }, "Forbidden": { "summary": "Example of a forbidden access error", "value": { "type": "business", "code": "SHR0007B", "message": "You do not have access to this order [1481120515528-01]", "date": "2024-12-04T01:03:29.495Z", "requestId": "3d292319-2129-47b6-a748-92a8be02576a" } } } } } } }, "security": [ { "Authorization": [] } ], "servers": [ { "url": "https://api.pick-and-pack.com/prod/v1", "description": "Server to access the Pick and Pack API." } ] } }, "/worksheets/{worksheetId}": { "get": { "tags": ["Worksheets"], "summary": "Get worksheet by ID", "description": "Retrieves worksheet details by ID.\n\n>ℹ️ The response is cached for 30 seconds based on the `worksheetId` parameter. The endpoint supports up to 500 requests per second, with a maximum of 100 concurrent requests.\n\n>ℹ️ [Generate a JWT token](https://developers.vtex.com/docs/api-reference/pick-and-pack-api#post-/token) to endpoint authentication. JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information as a JSON object between parties.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Administration | **Homepage** |\r\n| Catalog | Administration | **Help home page** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Admin - Start page only | Homepage |\r\n| Admin - Start page only | Help home page |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or API keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "name": "worksheetId", "in": "path", "description": "Worksheet ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "546744628006" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Order ID." }, "worksheetId": { "type": "string", "description": "Unique worksheet identifier." }, "initDate": { "type": "string", "description": "Worksheet initialization date in ISO 8601 format.", "format": "date-time" }, "finishedDate": { "type": "string", "description": "Worksheet finished date in ISO 8601 format.", "format": "date-time", "nullable": true }, "status": { "type": "string", "description": "Current worksheet status.", "enum": [ "IN_PROGRESS", "PENDING", "COLLECTED", "COMPLETED", "READY_FOR_PACKING", "PACKING", "PACKED", "SORTING", "CANCELLED", "REJECTED" ] }, "createdAt": { "type": "string", "description": "Worksheet creation date in ISO 8601 format.", "format": "date-time" }, "priority": { "type": "integer", "description": "Worksheet-level priority score. Higher score means higher priority." }, "categoriesIds": { "type": "array", "description": "List of IDs of categories involved in this worksheet.", "items": { "type": "string", "description": "Category ID." } }, "lastPickedItemTime": { "type": "number", "description": "Last pick event time in milliseconds." }, "finishEstimatedDate": { "type": "string", "description": "Estimated date and time to finish the worksheet (ISO 8601).", "format": "date-time" }, "hostname": { "type": "string", "description": "Originating host or application name." }, "pickerAssignment": { "type": "array", "description": "History of picker assignments for this worksheet.", "items": { "type": "object", "description": "Picker assignment entry.", "properties": { "active": { "type": "boolean", "description": "If the picker assignment is active (`true`) or not (`false`)." }, "assignmentDate": { "type": "string", "description": "Date and time when the picker was assigned (ISO 8601).", "format": "date-time" }, "notes": { "type": "array", "description": "List of notes related to this assignment.", "items": { "type": "object", "description": "Note information.", "properties": { "date": { "type": "string", "description": "Date and time when the note was created." }, "type": { "type": "string", "description": "Type of the note.", "enum": [ "COMMENT", "ERROR" ] }, "content": { "type": "string", "description": "Content of the note." }, "author": { "type": "string", "description": "Author of the note." } } } }, "method": { "type": "string", "nullable": true, "description": "Assignment method.", "enum": [ "MANUAL", "AUTOMATIC" ] }, "pickerId": { "type": "string", "description": "Identifier of the picker." }, "finishedDate": { "type": "string", "description": "Date and time when the assignment was finished.", "format": "date-time", "nullable": true } }, "required": [ "active", "assignmentDate", "notes", "method", "pickerId", "finishedDate" ] } }, "totalCompletedItems": { "type": "integer", "description": "Total of items completed in this worksheet." }, "totalPackedItems": { "type": "integer", "description": "Total of items packed in this worksheet." }, "updatedAt": { "type": "string", "description": "ISO 8601 timestamp of the last update to this worksheet record.", "format": "date-time" }, "lastStatusChangeTime": { "type": "integer", "description": "Last status change time in milliseconds." }, "totalItems": { "type": "integer", "description": "Total number of items in the worksheet." }, "ordersIds": { "type": "array", "description": "Orders associated with the worksheet and their summaries.", "items": { "type": "object", "description": "Order summary linked to this worksheet.", "properties": { "totalValue": { "type": "integer", "description": "Total order value in minor currency units." }, "orderId": { "type": "string", "description": "Unique order identifier." }, "unitsQuantity": { "type": "integer", "description": "Total units across all lines." }, "itemsQuantity": { "type": "integer", "description": "Number of distinct items in the order." }, "shippingEstimatedDate": { "type": "string", "description": "Estimated shipping date and time for the order in ISO 8601.", "format": "date-time" }, "isInvoiced": { "type": "boolean", "description": "Whether the order is invoiced." }, "priority": { "type": "number", "description": "Priority score for the order within the worksheet." } }, "required": [ "totalValue", "orderId", "unitsQuantity", "itemsQuantity", "shippingEstimatedDate", "isInvoiced", "priority" ] } }, "facilityId": { "type": "string", "description": "Identifier of the facility where picking occurs." }, "items": { "type": "array", "description": "All items in this worksheet with categories, assignment, and per-order breakdown.", "items": { "type": "object", "description": "Worksheet item with categories and order allocation.", "properties": { "id": { "type": "string", "description": "Item identifier." }, "name": { "type": "string", "description": "Display name of the item." }, "image": { "type": "string", "description": "URL to a product image.", "format": "uri" }, "temperature": { "type": "string", "description": "Temperature handling class.", "enum": [ "COLD", "FROZEN", "AMBIENT", "HOT" ] }, "categories": { "type": "array", "description": "Categories associated with this item.", "items": { "type": "object", "description": "Item category.", "properties": { "id": { "type": "string", "description": "Category identifier." }, "name": { "type": "string", "description": "Category name." } }, "required": [ "id", "name" ] } }, "itemAssignment": { "type": "object", "description": "Timestamps tracking assignment and picking of this item.", "properties": { "startPickingAt": { "type": "string", "description": "When picking started for the item (ISO 8601).", "format": "date-time" }, "assignedAt": { "type": "string", "description": "When the item was assigned to a picker (ISO 8601).", "format": "date-time" }, "finishedAt": { "type": "string", "description": "When picking finished for the item (ISO 8601).", "format": "date-time", "nullable": true } }, "required": [ "startPickingAt", "assignedAt", "finishedAt" ] }, "originalQuantity": { "type": "integer", "description": "Quantity originally scheduled to pick for this item." }, "completedQuantity": { "type": "integer", "description": "Quantity completed for this item." }, "pickedQuantity": { "type": "integer", "description": "Quantity physically picked.", "nullable": true }, "rejectedQuantity": { "type": "integer", "description": "Quantity rejected during picking." }, "replacedQuantity": { "type": "integer", "description": "Quantity that was replaced with substitute items." }, "orderSource": { "type": "array", "description": "Per-order allocation and pricing for this item.", "items": { "type": "object", "description": "Order-specific breakdown for this item.", "properties": { "orderId": { "type": "string", "description": "Associated order identifier." }, "sellingPrice": { "type": "integer", "description": "Applied selling price per unit in minor currency units." }, "listPrice": { "type": "integer", "description": "List price per unit in minor currency units." }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code for prices." }, "status": { "type": "string", "description": "Status of this item within the order.", "enum": [ "CREATED", "PENDING", "ASSIGNED", "PICKED", "ON_ROUTE", "INCIDENT", "RETURNED", "DELIVERED", "CANCELLED", "ON_HOLD", "TRANSFER" ] }, "quantity": { "type": "integer", "description": "Units assigned to this order." }, "pickedQuantity": { "type": "integer", "description": "Units picked for this order." }, "rejectedQuantity": { "type": "integer", "description": "Units rejected for this order." }, "replacedQuantity": { "type": "integer", "description": "Units replaced for this order." }, "replacedBy": { "type": "array", "description": "Identifiers of substitute items, if any.", "minItems": 0, "items": { "type": "string", "description": "Replacement item identifier." } }, "notes": { "type": "array", "description": "Notes related to this order-item link.", "minItems": 0, "items": { "type": "object", "description": "Note information.", "properties": { "date": { "type": "string", "description": "Date and time when the note was created." }, "type": { "type": "string", "description": "Type of the note.", "enum": [ "COMMENT", "ERROR" ] }, "content": { "type": "string", "description": "Content of the note." }, "author": { "type": "string", "description": "Author of the note." } } } } }, "required": [ "orderId", "sellingPrice", "listPrice", "currencyCode", "status", "quantity", "pickedQuantity", "rejectedQuantity", "replacedQuantity", "replacedBy", "notes" ] } } }, "required": [ "id", "referenceCode", "pickedQuantity", "originalQuantity", "image", "categories", "completedQuantity", "itemAssignment", "name", "orderSource" ] } }, "pickedItems": { "type": "array", "description": "Subset of items that have been picked (and possibly packed).", "items": { "type": "object", "description": "Picked item summary with per-order breakdown.", "properties": { "id": { "type": "string", "description": "Item identifier." }, "name": { "type": "string", "description": "Display name of the item." }, "image": { "type": "string", "description": "URL to a product image.", "format": "uri" }, "temperature": { "type": "string", "description": "Temperature handling class.", "enum": [ "COLD", "FROZEN", "AMBIENT", "HOT" ] }, "originalQuantity": { "type": "integer", "description": "Quantity originally scheduled to pick for this item." }, "pickedQuantity": { "type": "integer", "description": "Quantity physically picked." }, "packedQuantity": { "type": "integer", "description": "Quantity packed for shipment." }, "orderSource": { "type": "array", "description": "Per-order allocation and packing details for this picked item.", "items": { "type": "object", "description": "Order-specific breakdown for the picked item.", "properties": { "orderId": { "type": "string", "description": "Associated order identifier." }, "sellingPrice": { "type": "integer", "description": "Applied selling price per unit in minor currency units." }, "listPrice": { "type": "integer", "description": "List price per unit in minor currency units." }, "quantity": { "type": "integer", "description": "Units assigned to this order." }, "pickedQuantity": { "type": "integer", "description": "Units picked for this order." }, "packedQuantity": { "type": "integer", "description": "Units packed for this order." }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code for prices." } }, "required": [ "orderId", "sellingPrice", "listPrice", "quantity", "pickedQuantity", "packedQuantity", "currencyCode" ] } } }, "required": [ "id", "name", "image", "temperature", "originalQuantity", "pickedQuantity", "packedQuantity", "orderSource" ] } }, "rejectedItems": { "type": "array", "description": "Items that were rejected during picking or QA.", "minItems": 0, "items": { "type": "object", "description": "Rejected item summary.", "properties": { "id": { "type": "string", "description": "Item identifier." }, "name": { "type": "string", "description": "Display name of the item." }, "image": { "type": "string", "description": "URL to a product image.", "format": "uri" }, "temperature": { "type": "string", "description": "Temperature handling class.", "enum": [ "COLD", "FROZEN", "AMBIENT", "HOT" ] }, "originalQuantity": { "type": "integer", "description": "Quantity originally scheduled to pick for this item." }, "rejectedQuantity": { "type": "integer", "description": "Quantity rejected for this item." }, "orderSource": { "type": "array", "description": "Per-order rejection details for this item.", "items": { "type": "object", "description": "Order-specific rejection details.", "properties": { "orderId": { "type": "string", "description": "Associated order identifier." }, "quantity": { "type": "integer", "description": "Units assigned to this order." }, "rejectedQuantity": { "type": "integer", "description": "Units rejected for this order." }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code if applicable." }, "notes": { "type": "array", "description": "Notes related to the rejection.", "minItems": 0, "items": { "type": "object", "description": "Note information.", "properties": { "date": { "type": "string", "description": "Date and time when the note was created." }, "type": { "type": "string", "description": "Type of the note.", "enum": [ "COMMENT", "ERROR" ] }, "content": { "type": "string", "description": "Content of the note." }, "author": { "type": "string", "description": "Author of the note." } } } } }, "required": [ "orderId", "quantity", "rejectedQuantity", "currencyCode", "notes" ] } } }, "required": [ "id", "name", "image", "temperature", "originalQuantity", "rejectedQuantity", "replacedQuantity", "orderSource" ] } }, "replacedItems": { "type": "array", "description": "Items that were substituted by alternatives.", "minItems": 0, "items": { "type": "object", "description": "Replaced item summary.", "properties": { "id": { "type": "string", "description": "Original item identifier." }, "name": { "type": "string", "description": "Original item display name." }, "image": { "type": "string", "description": "URL to a product image.", "format": "uri" }, "temperature": { "type": "string", "description": "Temperature handling class.", "enum": [ "COLD", "FROZEN", "AMBIENT", "HOT" ] }, "originalQuantity": { "type": "integer", "description": "Quantity originally scheduled to pick for this item." }, "replacedQuantity": { "type": "integer", "description": "Quantity replaced for this item." }, "orderSource": { "type": "array", "description": "Per-order replacement details for this item.", "items": { "type": "object", "description": "Order-specific replacement details.", "properties": { "orderId": { "type": "string", "description": "Unique order identifier associated with this allocation." }, "sellingPrice": { "type": "integer", "description": "Applied selling price per unit in minor currency units." }, "listPrice": { "type": "integer", "description": "List price per unit in minor currency units." }, "quantity": { "type": "integer", "description": "Units originally assigned to this order for the item." }, "replacedQuantity": { "type": "integer", "description": "Units that were replaced by substitutes for this order." }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code for the prices." }, "unitMultiplier": { "type": "number", "description": "Multiplier applied to the base unit for this allocation." }, "unitOfMeasure": { "type": "string", "description": "Unit of measure for the item." }, "originalUnitMultiplier": { "type": "number", "description": "Original unit multiplier before any adjustments." }, "replacedBy": { "type": "array", "description": "Identifiers of substitute items that replaced the original units.", "items": { "type": "string", "description": "Replacement item identifier." } }, "reasons": { "type": "array", "description": "Reasons explaining why replacements were made.", "items": { "type": "object", "description": "Reason entry for a replacement event.", "properties": { "reasonType": { "type": "string", "description": "Reason code or category." }, "reasonDetail": { "type": "string", "description": "Human-readable explanation." } }, "required": [ "reasonType", "reasonDetail" ] } } }, "required": [ "orderId", "quantity", "replacedQuantity", "currencyCode", "notes" ] } } }, "required": [ "id", "name", "image", "temperature", "originalQuantity", "replacedQuantity", "replacedBy", "orderSource" ] } } }, "required": [ "id", "worksheetId", "initDate", "finishedDate", "status", "createdAt", "priority", "categoriesIds", "lastPickedItemTime", "finishEstimatedDate", "hostname", "pickerAssignment", "totalCompletedItems", "totalPackedItems", "updatedAt", "lastStatusChangeTime", "totalItems", "ordersIds", "facilityId", "items", "pickedItems", "replacedItems", "rejectedItems" ] }, "example": { "id": "c13ed6d8-1c86-4ad9-be63-5e2f4c5451b2", "worksheetId": "546744628006", "initDate": "2025-02-11T00:33:18.584Z", "finishedDate": null, "status": "COMPLETED", "createdAt": "2025-02-11T00:32:47.542Z", "priority": 0, "categoriesIds": ["12", "6", "7", "9"], "lastPickedItemTime": 1739233967327, "finishEstimatedDate": "2025-02-13T16:03:55.202Z", "hostname": "lastmile", "pickerAssignment": [ { "active": true, "assignmentDate": "2025-02-11T00:32:48.194Z", "notes": [], "method": "MANUAL", "pickerId": "pickertalleruno", "finishedDate": null } ], "totalCompletedItems": 4, "totalPackedItems": 4, "updatedAt": "2025-02-11T18:47:53.970Z", "lastStatusChangeTime": 1739234051187, "totalItems": 4, "ordersIds": [ { "totalValue": 14000000, "orderId": "1509780516107-01", "unitsQuantity": 16, "itemsQuantity": 4, "shippingEstimatedDate": "2025-02-10T17:41:24.986Z", "isInvoiced": true, "priority": 561.2 } ], "facilityId": "783262b09ddc4b8facee2fa50541fd1e", "items": [ { "id": "73", "name": "Tic Tac X 24 Boxes", "image": "https://lastmile.vteximg.com.br/arquivos/ids/155761-55-55/73.jpg?v=637917696200900000", "referenceCode": "12345", "temperature": "AMBIENT", "categories": [ { "id": "6", "name": "Food" } ], "itemAssignment": { "startPickingAt": "2025-02-11T00:33:17.511Z", "assignedAt": "2025-02-10T17:37:35.170Z", "finishedAt": "2025-02-11T00:34:04.417Z" }, "originalQuantity": 4, "completedQuantity": 4, "pickedQuantity": 4, "rejectedQuantity": 0, "replacedQuantity": 0, "orderSource": [ { "orderId": "1509780516107-01", "sellingPrice": 1000000, "listPrice": 1000000, "currencyCode": "MXN", "status": "DELIVERED", "quantity": 4, "pickedQuantity": 4, "rejectedQuantity": 0, "replacedQuantity": 0, "replacedBy": [], "notes": [] } ] }, { "id": "88", "name": "Electric Lunchbox Food Container Portable – Home Elements", "referenceCode": "000673", "image": "https://lastmile.vteximg.com.br/arquivos/ids/155776-55-55/88.jpg?v=637917703437530000", "temperature": "AMBIENT", "categories": [ { "id": "7", "name": "Home Appliances" } ], "itemAssignment": { "startPickingAt": "2025-02-11T00:33:18.809Z", "assignedAt": "2025-02-10T17:37:35.170Z", "finishedAt": "2025-02-11T00:34:04.417Z" }, "originalQuantity": 4, "completedQuantity": 4, "pickedQuantity": 4, "rejectedQuantity": 0, "replacedQuantity": 0, "orderSource": [ { "orderId": "1509780516107-01", "sellingPrice": 1000000, "listPrice": 1000000, "currencyCode": "MXN", "status": "DELIVERED", "quantity": 4, "pickedQuantity": 4, "rejectedQuantity": 0, "replacedQuantity": 0, "replacedBy": [], "notes": [] } ] }, { "id": "116", "name": "Pedigree Adult Dog Food 15 kg", "referenceCode": "000673", "image": "https://lastmile.vteximg.com.br/arquivos/ids/155804-55-55/116.jpg?v=637919000315400000", "temperature": "AMBIENT", "categories": [ { "id": "9", "name": "Pets" } ], "itemAssignment": { "startPickingAt": "2025-02-11T00:33:20.184Z", "assignedAt": "2025-02-10T17:37:35.170Z", "finishedAt": "2025-02-11T00:34:04.417Z" }, "originalQuantity": 4, "completedQuantity": 4, "pickedQuantity": 4, "rejectedQuantity": 0, "replacedQuantity": 0, "orderSource": [ { "orderId": "1509780516107-01", "sellingPrice": 1000000, "listPrice": 1000000, "currencyCode": "MXN", "status": "DELIVERED", "quantity": 4, "pickedQuantity": 4, "rejectedQuantity": 0, "replacedQuantity": 0, "replacedBy": [], "notes": [] } ] }, { "id": "1224", "name": "Yellow blouse, size XL", "referenceCode": "000673", "image": "https://lastmile.vteximg.com.br/arquivos/ids/155810-55-55/Blusa.png?v=637919004662770000", "temperature": "AMBIENT", "categories": [ { "id": "12", "name": "Apparel" } ], "itemAssignment": { "startPickingAt": "2025-02-11T00:33:21.546Z", "assignedAt": "2025-02-10T17:37:35.170Z", "finishedAt": "2025-02-11T00:34:04.417Z" }, "originalQuantity": 4, "completedQuantity": 4, "pickedQuantity": 4, "rejectedQuantity": 0, "replacedQuantity": 0, "orderSource": [ { "orderId": "1509780516107-01", "sellingPrice": 500000, "listPrice": 700000, "currencyCode": "MXN", "status": "DELIVERED", "quantity": 4, "pickedQuantity": 4, "rejectedQuantity": 0, "replacedQuantity": 0, "replacedBy": [], "notes": [] } ] } ], "pickedItems": [ { "id": "73", "name": "Tic Tac X 24 Boxes", "image": "https://lastmile.vteximg.com.br/arquivos/ids/155761-55-55/73.jpg?v=637917696200900000", "temperature": "AMBIENT", "originalQuantity": 4, "pickedQuantity": 4, "packedQuantity": 4, "orderSource": [ { "orderId": "1509780516107-01", "sellingPrice": 1000000, "listPrice": 1000000, "quantity": 4, "pickedQuantity": 4, "packedQuantity": 4, "currencyCode": "MXN" } ] }, { "id": "88", "name": "Electric Lunchbox Food Container Portable – Home Elements", "image": "https://lastmile.vteximg.com.br/arquivos/ids/155776-55-55/88.jpg?v=637917703437530000", "temperature": "AMBIENT", "originalQuantity": 4, "pickedQuantity": 4, "packedQuantity": 4, "orderSource": [ { "orderId": "1509780516107-01", "sellingPrice": 1000000, "listPrice": 1000000, "quantity": 4, "pickedQuantity": 4, "packedQuantity": 4, "currencyCode": "MXN" } ] }, { "id": "116", "name": "Pedigree Adult Dog Food 15 kg", "image": "https://lastmile.vteximg.com.br/arquivos/ids/155804-55-55/116.jpg?v=637919000315400000", "temperature": "AMBIENT", "originalQuantity": 4, "pickedQuantity": 4, "packedQuantity": 4, "orderSource": [ { "orderId": "1509780516107-01", "sellingPrice": 1000000, "listPrice": 1000000, "quantity": 4, "pickedQuantity": 4, "packedQuantity": 4, "currencyCode": "MXN" } ] }, { "id": "1224", "name": "Yellow blouse, size XL", "image": "https://lastmile.vteximg.com.br/arquivos/ids/155810-55-55/Blusa.png?v=637919004662770000", "temperature": "AMBIENT", "originalQuantity": 4, "pickedQuantity": 4, "packedQuantity": 4, "orderSource": [ { "orderId": "1509780516107-01", "sellingPrice": 500000, "listPrice": 700000, "quantity": 4, "pickedQuantity": 4, "packedQuantity": 4, "currencyCode": "MXN" } ] } ], "rejectedItems": [], "replacedItems": [], "historicalWorksheet": [] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404Notfound" }, "example": { "type": "exception", "code": "WORK0001B", "message": "Worksheet not found [5467446280061]", "date": "2025-02-13T11:34:36.574Z", "requestId": "c6ad79d4-8391-4238-8fa0-413274f87f93" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/403Expiredtoken" }, { "$ref": "#/components/schemas/403Forbidden" } ] }, "examples": { "ExpiredToken": { "summary": "Example of an expired token error", "value": { "message": "User is not authorized to access this resource with an explicit deny", "code": "EXPIRED_TOKEN", "reason": "Expired token", "requestId": "1a36389e-0050-436e-a1d0-14cfb6508c2f" } }, "Forbidden": { "summary": "Example of a forbidden access error", "value": { "type": "business", "code": "SHR0007B", "message": "You do not have access to this order [1481120515528-01]", "date": "2024-12-04T01:03:29.495Z", "requestId": "3d292319-2129-47b6-a748-92a8be02576a" } } } } } } }, "security": [ { "Authorization": [] } ], "servers": [ { "url": "https://api.pick-and-pack.com/prod/v1", "description": "Server to access the Pick and Pack API." } ] } }, "/worksheets": { "get": { "tags": ["Worksheets"], "summary": "Get worksheets by order ID", "description": "Lists all worksheets by order ID.\n\n>ℹ️ The response is cached for 30 seconds based on the `orderId` query parameter. The endpoint supports up to 500 requests per second, with a maximum of 100 concurrent requests.\n\n>ℹ️ [Generate a JWT token](https://developers.vtex.com/docs/api-reference/pick-and-pack-api#post-/token) to endpoint authentication. JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information as a JSON object between parties.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Administration | **Homepage** |\r\n| Catalog | Administration | **Help home page** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Admin - Start page only | Homepage |\r\n| Admin - Start page only | Help home page |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or API keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "name": "orderId", "in": "query", "description": "Order ID.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1506500515925-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "description": "List of picking worksheet summaries.", "items": { "type": "object", "description": "Summary of a worksheet.", "properties": { "id": { "type": "string", "description": "Unique order identifier.", "format": "uuid" }, "facilityId": { "type": "string", "description": "Identifier of the facility where picking occurs." }, "worksheetId": { "type": "string", "description": "Identifier for the worksheet." }, "categoriesIds": { "type": "array", "description": "IDs of categories involved in this worksheet.", "items": { "type": "string", "description": "Category identifier." } }, "finishedDate": { "type": "string", "description": "ISO 8601 timestamp when the worksheet finished.", "format": "date-time", "nullable": true }, "initDate": { "type": "string", "description": "ISO 8601 timestamp when the worksheet started.", "format": "date-time" }, "status": { "type": "string", "description": "Current worksheet status.", "enum": [ "IN_PROGRESS", "PENDING", "COLLECTED", "COMPLETED", "READY_FOR_PACKING", "PACKING", "PACKED", "SORTING", "CANCELLED", "REJECTED" ] }, "ordersIds": { "type": "array", "description": "Orders associated with the worksheet and their summaries.", "items": { "type": "object", "description": "Order summary linked to this worksheet.", "properties": { "orderId": { "type": "string", "description": "Unique order identifier." }, "unitsQuantity": { "type": "integer", "description": "Total units across all worksheets." }, "itemsQuantity": { "type": "integer", "description": "Number of distinct items in the order." } }, "required": [ "orderId", "unitsQuantity", "itemsQuantity" ] } }, "hostname": { "type": "string", "description": "Originating host or application name." }, "items": { "type": "array", "description": "Items in this worksheet.", "minItems": 0, "items": { "type": "object", "description": "Picker assignment entry.", "properties": { "active": { "type": "boolean", "description": "If the picker assignment is active (`true`) or not (`false`)." }, "assignmentDate": { "type": "string", "description": "Date and time when the picker was assigned (ISO 8601).", "format": "date-time" }, "notes": { "type": "array", "description": "List of notes related to this assignment.", "items": { "type": "object", "description": "Note information.", "properties": { "date": { "type": "string", "description": "Date and time when the note was created." }, "type": { "type": "string", "description": "Type of the note.", "enum": [ "COMMENT", "ERROR" ] }, "content": { "type": "string", "description": "Content of the note." }, "author": { "type": "string", "description": "Author of the note." } } } }, "method": { "type": "string", "nullable": true, "description": "Assignment method.", "enum": [ "MANUAL", "AUTOMATIC" ] }, "pickerId": { "type": "string", "description": "Identifier of the picker." }, "finishedDate": { "type": "string", "description": "Date and time when the assignment was finished.", "format": "date-time", "nullable": true } }, "required": [ "active", "assignmentDate", "notes", "method", "pickerId", "finishedDate" ] } }, "pickerAssignment": { "type": "array", "description": "History of picker assignments for this worksheet.", "items": { "type": "object", "description": "Picker assignment entry.", "properties": { "notes": { "type": "array", "minItems": 0, "description": "Notes related to this assignment.", "items": { "type": "object", "description": "Note information.", "properties": { "date": { "type": "string", "description": "Date and time when the note was created." }, "type": { "type": "string", "description": "Type of the note.", "enum": [ "COMMENT", "ERROR" ] }, "content": { "type": "string", "description": "Content of the note." }, "author": { "type": "string", "description": "Author of the note." } } } }, "method": { "type": "string", "description": "Assignment method.", "enum": [ "MANUAL", "AUTOMATIC" ] }, "active": { "type": "boolean", "description": "Whether the assignment is currently active." }, "assignmentDate": { "type": "string", "description": "When the assignment was created (ISO 8601).", "format": "date-time" }, "pickerId": { "type": "string", "description": "Identifier or username of the picker." }, "finishedDate": { "type": "string", "description": "When this assignment ended (ISO 8601); null if ongoing.", "format": "date-time", "nullable": true } }, "required": [ "notes", "method", "active", "assignmentDate", "pickerId" ] } }, "itemsQuantity": { "type": "integer", "description": "Number of distinct items in the worksheet." }, "unitsQuantity": { "type": "integer", "description": "Total units across all items in the worksheet." }, "completedUnitsQuantity": { "type": "integer", "description": "Total units completed." }, "packedUnitsQuantity": { "type": "integer", "description": "Total units packed." }, "deliveryWindow": { "type": "object", "description": "Requested or promised delivery window for the related orders.", "properties": { "minDate": { "type": "string", "description": "Earliest expected delivery date and time (ISO 8601).", "format": "date-time" }, "maxDate": { "type": "string", "description": "Latest expected delivery date and time (ISO 8601).", "format": "date-time" } }, "required": [ "minDate", "maxDate" ] }, "createdAt": { "type": "string", "description": "ISO 8601 timestamp when this worksheet record was created.", "format": "date-time" } }, "required": [ "id", "facilityId", "worksheetId", "categoriesIds", "finishedDate", "initDate", "status", "ordersIds", "hostname", "items", "pickerAssignment", "itemsQuantity", "unitsQuantity", "completedUnitsQuantity", "packedUnitsQuantity", "deliveryWindow", "createdAt" ] } }, "example": [ { "id": "c13ed6d8-1c86-4ad9-be63-5e2f4c5451b2", "facilityId": "783262b09ddc4b8facee2fa50541fd1e", "worksheetId": "546744628006", "categoriesIds": ["12", "6", "7", "9"], "finishedDate": null, "initDate": "2025-02-11T00:33:18.584Z", "status": "COMPLETED", "ordersIds": [ { "orderId": "1509780516107-01", "unitsQuantity": 16, "itemsQuantity": 4 } ], "hostname": "lastmile", "items": [], "pickerAssignment": [ { "notes": [], "method": "MANUAL", "active": true, "assignmentDate": "2025-02-11T00:32:48.194Z", "pickerId": "pickertalleruno", "finishedDate": null } ], "itemsQuantity": 4, "unitsQuantity": 16, "completedUnitsQuantity": 16, "packedUnitsQuantity": 4, "deliveryWindow": { "minDate": "2025-02-13T16:03:55.202Z", "maxDate": "2025-02-13T16:03:55.202Z" }, "createdAt": "2025-02-11T00:32:47.542Z" } ] } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400Badrequest" }, "example": { "type": "business", "code": "GEN0001B", "message": "Query string parameter {orderId} is required", "date": "2025-02-13T11:36:45.256Z", "requestId": "e1703db0-aaf9-4b80-9726-c8adc9bb9e92" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/403Expiredtoken" }, { "$ref": "#/components/schemas/403Forbidden" } ] }, "examples": { "ExpiredToken": { "summary": "Example of an expired token error", "value": { "message": "User is not authorized to access this resource with an explicit deny", "code": "EXPIRED_TOKEN", "reason": "Expired token", "requestId": "1a36389e-0050-436e-a1d0-14cfb6508c2f" } }, "Forbidden": { "summary": "Example of a forbidden access error", "value": { "type": "business", "code": "SHR0007B", "message": "You do not have access to this order [1481120515528-01]", "date": "2024-12-04T01:03:29.495Z", "requestId": "3d292319-2129-47b6-a748-92a8be02576a" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404Notfound" }, "example": { "type": "exception", "code": "WORK0001B", "message": "Worksheet not found [5467446280061]", "date": "2025-02-13T11:34:36.574Z", "requestId": "c6ad79d4-8391-4238-8fa0-413274f87f93" } } } } }, "security": [ { "Authorization": [] } ], "servers": [ { "url": "https://api.pick-and-pack.com/prod/v1", "description": "Server to access the Pick and Pack API." } ] } }, "/facilities/{facilityId}": { "get": { "tags": ["Facilities"], "summary": "Get facility by ID", "description": "Retrieves facility details by ID.\n\n>ℹ️ The response is cached for 30 seconds based on the `facilityId` parameter. The endpoint supports up to 500 requests per second, with a maximum of 100 concurrent requests.\n\n>ℹ️ [Generate a JWT token](https://developers.vtex.com/docs/api-reference/pick-and-pack-api#post-/token) to endpoint authentication. JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information as a JSON object between parties.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Administration | **Homepage** |\r\n| Catalog | Administration | **Help home page** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Admin - Start page only | Homepage |\r\n| Admin - Start page only | Help home page |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or API keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "name": "facilityId", "in": "path", "description": "Facility ID.", "required": true, "style": "simple", "schema": { "type": "string", "example": "783262b09ddc4b8facee2fa50541fd1e" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "Facility location record with address, contact details, and geo-coordinates.", "properties": { "id": { "type": "string", "description": "Unique facility identifier." }, "address": { "type": "string", "description": "Primary street address line." }, "addressComplement": { "type": "string", "description": "Additional address details such as apartment, suite, or references." }, "city": { "type": "string", "description": "City or locality name." }, "contactInformation": { "type": "object", "description": "Primary contact information for the facility.", "properties": { "email": { "type": "string", "description": "Contact email address.", "format": "email" }, "name": { "type": "string", "description": "Contact person's name or department name." }, "phone": { "type": "string", "description": "Contact phone number." } }, "required": [ "email", "name", "phone" ] }, "country": { "type": "string", "description": "ISO 3166-1 alpha-3 country code." }, "location": { "type": "object", "description": "Geographical coordinates of the facility in decimal degrees.", "properties": { "latitude": { "type": "number", "description": "Latitude in decimal degrees." }, "longitude": { "type": "number", "description": "Longitude in decimal degrees." } }, "required": [ "latitude", "longitude" ] }, "name": { "type": "string", "description": "Facility display name." }, "neighborhood": { "type": "string", "description": "Neighborhood or district name." }, "number": { "type": "string", "description": "Street number or building number." }, "postalCode": { "type": "string", "description": "Postal or ZIP code." }, "reference": { "type": "string", "description": "Reference landmark or directions to help locate the facility." }, "state": { "type": "string", "description": "State, province, or region name." } }, "required": [ "id", "address", "addressComplement", "city", "contactInformation", "country", "location", "name", "neighborhood", "number", "postalCode", "reference", "state" ] }, "example": { "id": "783262b09ddc4b8facee2fa50541fd1e", "address": "Centro Comercial El Tesoro", "addressComplement": "Local 650", "city": "Medellín", "contactInformation": { "email": "test@test.com", "name": "lastmile", "phone": "310001293" }, "country": "COL", "location": { "latitude": 6.196547799999999, "longitude": -75.558908 }, "name": "lastmile", "neighborhood": "El Poblado", "number": "650", "postalCode": "050022", "reference": "Centro Comercial El Tesoro", "state": "Antioquia" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404Notfound" }, "example": { "type": "exception", "code": "FAC0001B", "message": "Facility not found [783262b09ddc4b8facee2fa50541fd1e1]", "date": "2025-02-13T11:47:41.367Z", "requestId": "3a7ab942-e023-4b45-93ca-9e30e553c60d" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/403Expiredtoken" }, { "$ref": "#/components/schemas/403Forbidden" } ] }, "examples": { "ExpiredToken": { "summary": "Example of an expired token error", "value": { "message": "User is not authorized to access this resource with an explicit deny", "code": "EXPIRED_TOKEN", "reason": "Expired token", "requestId": "1a36389e-0050-436e-a1d0-14cfb6508c2f" } }, "Forbidden": { "summary": "Example of a forbidden access error", "value": { "type": "business", "code": "FAC0002B", "message": "You do not have access to this facility [eab44b9c48134c35b778586959129818]", "date": "2025-02-13T11:48:29.430Z", "requestId": "8f294625-193b-48d4-be5c-5de400a236e7" } } } } } } }, "security": [ { "Authorization": [] } ], "servers": [ { "url": "https://api.pick-and-pack.com/prod/v1", "description": "Server to access the Pick and Pack API." } ] } }, "/shipments/{shipmentId}": { "get": { "tags": ["Shipments"], "summary": "Get shipment by shipment ID", "description": "Retrieves detailed information about a shipment using either the internal system ID or the carrier's tracking ID.\n\n>ℹ️ The response is cached for 30 seconds based on the `shipmentId` parameter and `X-PNP-FilterMethod` header. The endpoint supports up to 500 requests per second, with a maximum of 100 concurrent requests.\n\n>ℹ️ [Generate a JWT token](https://developers.vtex.com/docs/api-reference/pick-and-pack-api#post-/token) to endpoint authentication. JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information as a JSON object between parties. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Administration | **Homepage** |\r\n| Catalog | Administration | **Help home page** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Admin - Start page only | Homepage |\r\n| Admin - Start page only | Help home page |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or API keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "name": "shipmentId", "in": "path", "description": "Shipment ID. Its value depends on the `X-PNP-FilterMethod` header. Use internal UUID when using `BY_INTERNAL_ID` filter or carrier tracking number when using `BY_EXTERNAL_ID` filter.", "required": true, "style": "simple", "schema": { "type": "number", "example": 550693447769717380942093217914 } }, { "name": "X-PNP-FilterMethod", "in": "header", "description": "Determines how the `shipmentId` will be interpreted. Its values can be `BY_INTERNAL_ID` or `BY_EXTERNAL_ID`.", "required": true, "style": "simple", "schema": { "type": "string", "example": "BY_EXTERNAL_ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "Shipment record with carrier, agent, package contents, tracking, and timing information.", "properties": { "id": { "type": "string", "description": "Unique shipment identifier." }, "orderId": { "type": "string", "description": "Order identifier associated with this shipment." }, "carrierId": { "type": "string", "description": "Internal or external identifier for the carrier." }, "serviceId": { "type": "string", "description": "Carrier service identifier used to create the shipment." }, "carrierName": { "type": "string", "description": "Display name of the carrier." }, "seller": { "type": "string", "description": "Selling entity or merchant of record." }, "status": { "type": "string", "description": "Current shipment status.", "enum": [ "CREATED", "PENDING", "ASSIGNED", "PICKED", "ON_ROUTE", "INCIDENT", "RETURNED", "DELIVERED", "CANCELLED", "ON_HOLD", "TRANSFER" ] }, "agent": { "type": "object", "description": "Delivery agent assigned to the shipment.", "properties": { "id": { "type": "string", "description": "Identifier of the agent in the carrier system." }, "name": { "type": "string", "description": "Full name of the agent." }, "vehicle": { "type": "string", "description": "Vehicle type used by the agent.", "enum": [ "SCOOTER", "VAN", "CAR", "TRUCK", "BIKE", "WALK", "DRONE" ] } }, "required": [ "id", "name", "vehicle" ] }, "trackingUrl": { "type": "string", "description": "Public tracking URL for this shipment.", "format": "uri" }, "totalDistanceTraveled": { "type": "integer", "description": "Total distance traveled for this delivery." }, "comments": { "type": "string", "description": "Free-form comments or summary for the shipment." }, "evidences": { "type": "array", "description": "Proof-of-delivery evidences such as photos or signatures.", "items": { "type": "object", "description": "Evidence record captured during pickup or delivery.", "properties": { "date": { "type": "string", "description": "Timestamp when the evidence was captured (ISO 8601).", "format": "date-time" }, "type": { "type": "string", "description": "Evidence type." }, "content": { "type": "string", "description": "URL to the evidence content.", "format": "uri" }, "author": { "type": "string", "description": "Person who captured or submitted the evidence." } }, "required": [ "date", "type", "content", "author" ] } }, "packages": { "type": "array", "description": "Packages included in this shipment.", "items": { "type": "object", "description": "Package with valuation, contents, and dimensions.", "properties": { "totalValue": { "type": "integer", "description": "Total declared value of the package in minor currency units." }, "envelope": { "type": "string", "description": "Packaging type." }, "orderId": { "type": "string", "description": "Order identifier tied to this package." }, "weight": { "type": "string", "description": "Package weight as a string in kilograms." }, "description": { "type": "string", "description": "Free-text description of the package." }, "id": { "type": "string", "description": "Unique package identifier." }, "categories": { "type": "array", "description": "Category labels describing the package contents.", "items": { "type": "string", "description": "Category name." } }, "items": { "type": "array", "description": "Items contained in the package.", "items": { "type": "object", "description": "Item contained in the package.", "properties": { "name": { "type": "string", "description": "Display name of the item." }, "image": { "type": "string", "description": "URL to a product image.", "format": "uri" }, "ean": { "type": "string", "description": "EAN for the item." }, "quantity": { "type": "integer", "description": "Quantity of this item in the package." }, "id": { "type": "string", "description": "Item identifier." }, "price": { "type": "number", "description": "Unit price in minor currency units." } }, "required": [ "name", "image", "ean", "quantity", "id", "price" ] } }, "dimensions": { "type": "object", "description": "Outer dimensions of the package.", "properties": { "width": { "type": "string", "description": "Package width as a string in centimeters." }, "length": { "type": "string", "description": "Package length as a string in centimeters." }, "height": { "type": "string", "description": "Package height as a string in centimeters." } }, "required": [ "width", "length", "height" ] } }, "required": [ "totalValue", "envelope", "orderId", "weight", "description", "id", "categories", "items", "dimensions" ] } }, "type": { "type": "string", "description": "Fulfillment flow type for the order or shipment. This field defines how the item will be handled and routed within the logistics process.\n\rThe acceptable values are:\n\r- `PICKUP`: The customer picks up the product in person at the store or designated [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\n\r- `DELIVERY`: The product is picked up from a warehouse or distribution center and delivered directly to the customer's home.\n\r- `PICKUP_DELIVERY`: The product is first picked up at the store and then delivered to the customer's home.\n\r- `TRANSFER`: The product is shipped from one store to another store for availability or further processing.\n\r- `RETURN`: The customer returns the product to the store for review or further handling.", "enum": [ "PICKUP", "DELIVERY", "PICKUP_DELIVERY", "TRANSFER", "RETURN" ] }, "notes": { "type": "array", "description": "Operational notes recorded during the shipment lifecycle.", "items": { "type": "object", "description": "Structured note entry.", "properties": { "date": { "type": "string", "description": "Timestamp when the note was recorded (ISO 8601).", "format": "date-time" }, "type": { "type": "string", "description": "Note type or category.", "enum": ["COMMENT"] }, "content": { "type": "string", "description": "Note text content." }, "author": { "type": "string", "description": "User or agent who created the note." } }, "required": [ "date", "type", "content", "author" ] } }, "paymentMethod": { "type": "string", "description": "Payment method categorization.", "enum": ["ONLINE", "CASH", "CREDIT_CARD", "DEBIT_CARD", "OTHER"] }, "carrierServiceType": { "type": "string", "description": "Service area/type offered by the carrier.", "enum": [ "LOCAL", "NATIONAL", "INTERNATIONAL" ] }, "timezone": { "type": "object", "description": "Timezone context used for the timestamps.", "properties": { "offset": { "type": "integer", "description": "Offset from UTC in minutes." }, "value": { "type": "string", "description": "Timezone identifier." } }, "required": ["offset", "value"] }, "tags": { "type": "array", "description": "Free-form tags associated with the shipment.", "minItems": 0, "items": { "type": "string", "description": "Tag string." } }, "deliveredDate": { "type": "string", "description": "Timestamp when the shipment was delivered (ISO 8601).", "format": "date-time" }, "sender": { "type": "object", "description": "Origin (ship-from) party details.", "properties": { "name": { "type": "string", "description": "Sender name." }, "city": { "type": "string", "description": "City of origin." }, "state": { "type": "string", "description": "State/province/region of origin." }, "country": { "type": "string", "description": "ISO 3166-1 country code." }, "pickupDate": { "type": "string", "description": "Pickup date and time at origin (ISO 8601).", "format": "date-time" }, "zipCode": { "type": "string", "description": "Postal/ZIP code of origin." } }, "required": [ "name", "city", "state", "country", "pickupDate", "zipCode" ] }, "receiver": { "type": "object", "description": "Destination (ship-to) party details.", "properties": { "name": { "type": "string", "description": "Receiver name." }, "city": { "type": "string", "description": "Destination city." }, "state": { "type": "string", "description": "Destination state/province/region." }, "country": { "type": "string", "description": "ISO 3166-1 country code of destination." }, "deliveryDate": { "type": "string", "description": "Delivery date and time at destination (ISO 8601).", "format": "date-time" }, "zipCode": { "type": "string", "description": "Destination postal/ZIP code." } }, "required": [ "name", "city", "state", "country", "deliveryDate", "zipCode" ] }, "labels": { "type": "array", "minItems": 0, "description": "Label identifiers or URLs associated with the shipment (implementation-defined).", "items": { "type": "object", "description": "Label information.", "properties": { "id": { "type": "string", "description": "Label identifier or URL." }, "type": { "type": "string", "description": "Label type or category.", "enum": ["PDF", "BASE64", "TEXT", "ZPL"] }, "url": { "type": "string", "description": "URL to access the label.", "format": "uri" }, "name": { "type": "string", "description": "Label name." } } } } }, "required": [ "id", "orderId", "carrierId", "serviceId", "carrierName", "seller", "status", "agent", "trackingUrl", "totalDistanceTraveled", "comments", "evidences", "packages", "type", "notes", "paymentMethod", "carrierServiceType", "timezone", "tags", "deliveredDate", "sender", "receiver", "labels" ] }, "example": { "id": "d39e8dd7-0ab9-48c8-b16b-3e46933e113a", "orderId": "1506500515925-01", "carrierId": "627eb3b93a19fdc0cf5fe087", "serviceId": "550693447769717380942093217914", "carrierName": "Lastmile", "seller": "lastmile", "status": "DELIVERED", "agent": { "id": "1977157", "name": "adrianprod adrianprod", "vehicle": "CAR" }, "trackingUrl": "https://lastmile.northlatam.com/tracking/index.html?jobID=41d9275cc4557ac5827e60c273646a33", "totalDistanceTraveled": 0, "comments": "-", "evidences": [ { "date": "2025-01-31T19:41:41.780Z", "type": "IMAGE", "content": "https://jungl.s3.dualstack.us-west-2.amazonaws.com/acknowledgement_images/1738352496351563420251131-550693447Signature.jpg", "author": "adrianprod adrianprod" } ], "packages": [ { "totalValue": 1040000, "envelope": "BOX QATEST", "orderId": "1506500515925-01", "weight": "0", "description": "Caja", "id": "17aa920c-a364-4412-a288-7b269b88f403", "categories": ["Caja"], "items": [ { "name": "Bolígrafo", "image": "https://lastmile.vteximg.com.br/arquivos/ids/156015-55-55/7713133.jpg?v=638375748726030000", "ean": "4145670347237", "quantity": 1, "id": "2366", "price": 20000 }, { "name": "Woolite Detergente Liquido Ropa Oscura", "image": "https://lastmile.vteximg.com.br/arquivos/ids/155732-55-55/45.jpg?v=637917078466000000", "ean": "EAN144", "quantity": 1, "id": "45", "price": 1000000 }, { "name": "Cerveza Heineken Sixpack 269ml", "image": "https://lastmile.vteximg.com.br/arquivos/ids/155704-55-55/17.jpg?v=637917044926730000", "ean": "EAN116", "quantity": 2, "id": "17", "price": 10000 }, { "name": "Crema De Whisky Baileys 1lt", "image": "https://lastmile.vteximg.com.br/arquivos/ids/155706-55-55/19.jpg?v=637917046641670000", "ean": "EAN118", "quantity": 2, "id": "19", "price": 10000 } ], "dimensions": { "width": "60", "length": "60", "height": "60" } } ], "type": "PICKUP_DELIVERY", "notes": [ { "date": "2025-01-31T19:41:42.301Z", "type": "COMMENT", "content": "Testing", "author": "adrianprod adrianprod" }, { "date": "2025-01-31T19:42:06.162Z", "type": "COMMENT", "content": "Qqqqqq", "author": "adrianprod adrianprod" } ], "paymentMethod": "ONLINE", "carrierServiceType": "NATIONAL", "timezone": { "offset": 0, "value": "America/Bogota" }, "tags": [], "deliveredDate": "2025-01-31T19:42:04.953Z", "sender": { "name": "lastmile", "city": "Vancouver", "state": "BC", "country": "CAN", "pickupDate": "2025-01-28T20:24:28.838Z", "zipCode": "V5Z 2M9" }, "receiver": { "name": "deww", "city": "Medellín", "state": "ANTIOQUIA", "country": "COL", "deliveryDate": "2025-01-29T19:55:16.000Z", "zipCode": "05001" }, "labels": [] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/404Notfound" }, "example": { "type": "exception", "code": "TRP0005E", "message": "Shipment not found [550693447769717380942093217914]", "date": "2025-02-13T12:05:17.760Z", "requestId": "93e458c1-791e-433a-86c5-b8b23ef28a50" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/403Forbidden" }, { "$ref": "#/components/schemas/403Expiredtoken" } ] }, "examples": { "Forbidden": { "summary": "Forbidden", "value": { "type": "business", "code": "SHP0002B", "message": "You do not have access to this shipment [da6c9988-7659-4cbd-bee3-5b44309eae07]", "date": "2025-02-13T12:06:53.729Z", "requestId": "0ef88fe5-6077-49f4-8716-8ba6020c56d1" } }, "ExpiredToken": { "summary": "Expired Token", "value": { "message": "User is not authorized to access this resource with an explicit deny", "code": "EXPIRED_TOKEN", "reason": "Expired token", "requestId": "1a36389e-0050-436e-a1d0-14cfb6508c2f" } } } } } } }, "security": [ { "Authorization": [] } ], "servers": [ { "url": "https://api.pick-and-pack.com/prod/v1", "description": "Server to access the Pick and Pack API." } ] } }, "/shipments": { "get": { "tags": ["Shipments"], "summary": "List shipments by order ID", "description": "Lists all shipments by order ID.\n\n>ℹ️ The endpoint supports up to 500 requests per second, with a maximum of 100 concurrent requests.\n\n>ℹ️ [Generate a JWT token](https://developers.vtex.com/docs/api-reference/pick-and-pack-api#post-/token) to endpoint authentication. JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information as a JSON object between parties. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Catalog | Administration | **Homepage** |\r\n| Catalog | Administration | **Help home page** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Admin - Start page only | Homepage |\r\n| Admin - Start page only | Help home page |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or API keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).", "parameters": [ { "name": "orderId", "in": "query", "description": "Order ID.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1468301611294-01" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "description": "List of shipment summary records.", "items": { "type": "object", "description": "Summary view of a shipment including carrier, status, counts, and timing.", "properties": { "id": { "type": "string", "description": "Unique shipment identifier." }, "serviceId": { "type": "string", "description": "Carrier service identifier used to create the shipment." }, "orderId": { "type": "string", "description": "Order identifier associated with this shipment." }, "carrierId": { "type": "string", "description": "Internal or external identifier for the carrier." }, "status": { "type": "string", "description": "Current shipment status.", "enum": [ "CREATED", "PENDING", "ASSIGNED", "PICKED", "ON_ROUTE", "INCIDENT", "RETURNED", "DELIVERED", "CANCELLED", "ON_HOLD", "TRANSFER" ] }, "carrierName": { "type": "string", "description": "Display name of the carrier." }, "paymentMethod": { "type": "string", "description": "Payment method categorization.", "enum": ["ONLINE", "CASH", "CREDIT_CARD", "DEBIT_CARD", "OTHER"] }, "tags": { "type": "array", "description": "Free-form tags associated with the shipment.", "items": { "type": "string", "description": "Tag string." } }, "deliveredDate": { "type": "string", "description": "Timestamp when the shipment was delivered (ISO 8601).", "format": "date-time" }, "customerId": { "type": "string", "description": "Platform-specific customer identifier." }, "customerAddressId": { "type": "string", "description": "Identifier of the customer's address." }, "source": { "type": "string", "description": "Origin location label." }, "destination": { "type": "string", "description": "Destination location label." }, "courierId": { "type": "string", "description": "Identifier of the courier assigned to the job.", "nullable": true }, "courierName": { "type": "string", "description": "Full name of the courier.", "nullable": true }, "seller": { "type": "string", "description": "Seller of record." }, "packagesQuantity": { "type": "integer", "description": "Total number of packages in the shipment." }, "itemsQuantity": { "type": "integer", "description": "Total number of items across all packages." }, "serviceType": { "type": "string", "description": "Fulfillment flow type.", "enum": ["PICKUP_DELIVERY", "DELIVERY", "PICKUP"] }, "creationDate": { "type": "string", "description": "Timestamp when the shipment record/job was created (ISO 8601).", "format": "date-time" } }, "required": [ "id", "serviceId", "orderId", "carrierId", "status", "carrierName", "paymentMethod", "tags", "deliveredDate", "customerId", "customerAddressId", "source", "destination", "courierId", "courierName", "seller", "packagesQuantity", "itemsQuantity", "serviceType", "creationDate" ] } }, "example": [ { "id": "d39e8dd7-0ab9-48c8-b16b-3e46933e113a", "serviceId": "550693447769717380942093217914", "orderId": "1506500515925-01", "carrierId": "627eb3b93a19fdc0cf5fe087", "status": "DELIVERED", "carrierName": "Lastmile", "paymentMethod": "ONLINE", "tags": [], "deliveredDate": "2025-01-31T19:42:04.953Z", "customerId": "-", "customerAddressId": "Bello - Medellin", "source": "Vancouver-CAN", "destination": "Medellín-COL", "courierId": "1977157", "courierName": "adrianprod adrianprod", "seller": "lastmile", "packagesQuantity": 1, "itemsQuantity": 6, "serviceType": "PICKUP_DELIVERY", "creationDate": "2025-01-28T19:56:48.033Z" } ] } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/400Badrequest" }, "example": { "type": "business", "code": "ORD0001B", "message": "Query string parameter {orderId} is required", "date": "2025-02-13T12:14:18.795Z", "requestId": "1bb652b1-dc75-4f0c-9c0a-3cd021eaa1ea" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/403Forbidden" }, { "$ref": "#/components/schemas/403Expiredtoken" } ] }, "examples":{ "Forbidden": { "summary": "Example of a forbidden access error", "value": { "type": "business", "code": "SHP0003B", "message": "You do not have access to this order [1468301611294-01]", "date": "2025-02-13T12:19:21.530Z", "requestId": "6eee326d-bc6d-4a0f-ac74-96fbcd2212b3" } }, "ExpiredToken": { "summary": "Example of an expired token error", "value": { "message": "User is not authorized to access this resource with an explicit deny", "code": "EXPIRED_TOKEN", "reason": "Expired token", "requestId": "1a36389e-0050-436e-a1d0-14cfb6508c2f" } } } } } } }, "security": [ { "Authorization": [] } ], "servers": [ { "url": "https://api.pick-and-pack.com/prod/v1", "description": "Server to access the Pick and Pack API." } ] } } }, "components": { "parameters": { "Content-Type": { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, "Accept": { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } } }, "schemas": { "403Expiredtoken": { "type": "object", "description": "Expired token error response.", "properties": { "message": { "type": "string", "description": "Error message." }, "code": { "type": "string", "description": "Error code." }, "reason": { "type": "string", "description": "Reason for the error." }, "requestId": { "type": "string", "description": "Request ID." } } }, "403Forbidden": { "type": "object", "description": "Forbidden error response.", "properties": { "type": { "type": "string", "description": "Type of the error." }, "code": { "type": "string", "description": "Error code." }, "message": { "type": "string", "description": "Error message." }, "date": { "type": "string", "description": "Date and time when the error occurred." }, "requestId": { "type": "string", "description": "Request ID." } } }, "404Notfound": { "description": "Not Found error response.", "type": "object", "properties": { "type": { "type": "string", "description": "Type of the error." }, "code": { "type": "string", "description": "Error code." }, "message": { "type": "string", "description": "Error message." }, "date": { "type": "string", "description": "Date and time when the error occurred." }, "requestId": { "type": "string", "description": "Request ID." } } }, "400Badrequest": { "type": "object", "description": "Bad request error response.", "properties": { "type": { "type": "string", "description": "Type of the error." }, "code": { "type": "string", "description": "Error code." }, "message": { "type": "string", "description": "Error message." }, "date": { "type": "string", "description": "Date and time when the error occurred." }, "requestId": { "type": "string", "description": "Request ID." } } } }, "securitySchemes": { "Authorization": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Authentication JWT created by the [Generate JWT token](https://developers.vtex.com/docs/api-reference/pick-and-pack-api#post-/token?endpoint=post-/token). JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information as a JSON object between parties." } } }, "security": [ { "Authorization": [] } ], "tags": [ { "name": "Authentication" }, { "name": "Orders" }, { "name": "Worksheets" }, { "name": "Facilities" }, { "name": "Shipments" } ] }