{ "opencollection": "1.0.0", "info": { "name": "VTex Anti-fraud Provider Account Inventory API", "version": "1.0" }, "items": [ { "info": { "name": "Inventory", "type": "folder" }, "items": [ { "info": { "name": "VTex List inventory by SKU", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/logistics/pvt/inventory/skus/:skuId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "skuId", "value": "", "type": "path", "description": "Every SKU has a unique identifier called SKU ID." } ] }, "docs": "Lists your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) information by a SKU unique identifier (SKU ID)." }, { "info": { "name": "VTex List inventory per warehouse", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/logistics/pvt/inventory/items/:skuId/warehouses/:warehouseId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "skuId", "value": "", "type": "path", "description": "Every SKU has a unique identifier called SKU ID." }, { "name": "warehouseId", "value": "", "type": "path", "description": "Warehouse ID is the unique identifier of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb)." } ] }, "docs": "Lists your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) information by warehouse." }, { "info": { "name": "VTex Update inventory by SKU and warehouse", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/logistics/pvt/inventory/skus/:skuId/warehouses/:warehouseId", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "skuId", "value": "", "type": "path", "description": "SKU ID is the unique identifier of the SKU you wish to update." }, { "name": "warehouseId", "value": "", "type": "path", "description": "Warehouse ID is the unique identifier of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) associated with the SKU you wish to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the [inventory](https://help.vtex.com/tutorial/inventory-management--tutorials_139) of a SKU in a given [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb). This endpoint allows you to do the following:\r\n\r\n- **Define a quantity:** Indicate a specific number of SKUs, and it will decrease whenever a unit is sold. The store can eventually run out of inventory.\r\n\r\n- **Configure lead time:** Set the [lead time](https://help.vtex.com/en/tutorial/lead_time-shipping-" }, { "info": { "name": "VTex List inventory per dock", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/logistics/pvt/inventory/items/:skuId/docks/:dockId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "skuId", "value": "", "type": "path", "description": "Every SKU has a unique identifier called SKU ID." }, { "name": "dockId", "value": "", "type": "path", "description": "Dock ID is the unique identifier of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj)." } ] }, "docs": "Lists your inventory information by [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj)." }, { "info": { "name": "VTex List inventory per dock and warehouse", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/logistics/pvt/inventory/items/:skuId/docks/:dockId/warehouses/:warehouseId", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "skuId", "value": "", "type": "path" }, { "name": "dockId", "value": "", "type": "path" }, { "name": "warehouseId", "value": "", "type": "path" } ] }, "docs": "Lists your inventory information from the combination of a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) and a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb)." }, { "info": { "name": "VTex List inventory with dispatched reservations", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/logistics/pvt/inventory/items/:itemId/warehouses/:warehouseId/dispatched", "headers": [ { "name": "Content-Type", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "itemId", "value": "", "type": "path", "description": "SKU unique identifier called SKU ID. This field is an equivalent to `skuId`." }, { "name": "warehouseId", "value": "", "type": "path", "description": "Warehouse ID is the unique identifier of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb)." } ] }, "docs": "[Reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) is the VTEX solution that prevents stores from selling the same item more than once. Adding products to the shopping cart does not create a reservation, this only happens after the shopper completes the purchase.\r\n\r\nThis endpoint lists your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) information about dispatched reservations from a given warehouse. A reservation is cons" }, { "info": { "name": "VTex List supply lots", "type": "http" }, "http": { "method": "GET", "url": "https://{providerApiEndpoint}/api/logistics/pvt/inventory/items/:skuId/warehouses/:warehouseId/supplyLots", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "skuId", "value": "", "type": "path", "description": "ID of the SKU." }, { "name": "warehouseId", "value": "", "type": "path", "description": "ID of the warehouse where the SKU is located." } ] }, "docs": "Returns a list of the supply lots of an SKU in a specific warehouse." }, { "info": { "name": "VTex Save supply lot", "type": "http" }, "http": { "method": "PUT", "url": "https://{providerApiEndpoint}/api/logistics/pvt/inventory/items/:skuId/warehouses/:warehouseId/supplyLots/:supplyLotId", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "skuId", "value": "", "type": "path", "description": "ID of the SKU whose availability is being scheduled." }, { "name": "warehouseId", "value": "", "type": "path", "description": "ID of the warehouse where the SKU will arrive." }, { "name": "supplyLotId", "value": "", "type": "path", "description": "ID of the Supply Lot in which the SKU's scheduling should be considered." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Supply Lot. A Supply Lot lets the store sell products that are not currently available in stock but whose arrival is already scheduled.\n\nCheck out our [documentation](https://help.vtex.com/en/tutorial/setting-up-future-inventory--UMSGjooqRfkRbeoh94kS4) about this feature." }, { "info": { "name": "VTex Transfer supply lot", "type": "http" }, "http": { "method": "POST", "url": "https://{providerApiEndpoint}/api/logistics/pvt/inventory/items/:skuId/warehouses/:warehouseId/supplyLots/:supplyLotId/transfer", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "skuId", "value": "", "type": "path", "description": "ID of the SKU." }, { "name": "warehouseId", "value": "", "type": "path", "description": "ID of the warehouse where the SKU is located." }, { "name": "supplyLotId", "value": "", "type": "path", "description": "ID of the Supply Lot in which the SKU is currently located and from where it will be transfered." } ] }, "docs": "Transfers an SKU from a Supply Lot to the currently available inventory.\n\nCheck out how this transfer works in further detail by reading our [documentation](https://help.vtex.com/pt/tutorial/configurar-estoque-futuro--UMSGjooqRfkRbeoh94kS4) about this feature." } ] } ], "bundled": true }