openapi: 3.0.1 info: title: Walmart Cost Management Assortment Recommendations Inventory API description: 'This API allows drop ship vendor (DSV) users to update cost for items in bulk. **May 2024**
Built: 05/09/2024, 13:05:34 ' version: '1.0' servers: - url: https://api-gateway.walmart.com description: Production URL - url: https://sandbox.walmartapis.com description: Sandbox URL tags: - name: Inventory paths: /v3/inventory: get: tags: - Inventory operationId: getInventory summary: Walmart Retrieve Inventory Count for a Single Item at One Ship Node description: '

GET /v3/inventory

This request retrieves the inventory count for a single item for one specific ship node. ' parameters: - in: query name: sku required: false schema: type: string description: 'Specifies the stock keeping unit (SKU) item identifier. This value is an identifier that is specified by the drop ship vendor (DSV). It is used by the vendor in the specification file to refer to each item. Example(s):
RG-IRAE-79VD ' example: RG-IRAE-79VD - in: query name: gtin required: true schema: type: string description: 'Specifies the global trade item number (GTIN) item identifier. The global trade item number is a 14-digit number, including the check digit, that is used worldwide and identifies the Each. If the user''s number is less than 14 digits, add zeros at the beginning. Either the `sku` or `gtin` parameter will be required. The user can only submit one. Example(s):
00097531246801 ' example: 00097531246801 - in: query name: shipNode required: true schema: type: string description: "Specifies the distribution facility distributor identifier.\n\nThis parameter identifies each facility from which the inventory is requested. \nThe identifier is autogenerated during drop ship vendor (DSV) account creation. \nEvery time users add or update a facility in Supplier Center, a new identifier is generated. \nEnsure this value is up to date.\n\nExample(s):
\n123456701\n" example: '123456701' - in: header name: Accept required: false schema: type: string description: 'Specifies the data type expected in a response sent from the server. Valid values are: | Value | Meaning | | --- | --- | | application/xml | XML format for data returned in response. | | application/json | JSON format for data returned in response. | ' example: application/xml - in: header name: WM_CONSUMER.CHANNEL.TYPE required: false schema: type: string description: 'Specifies an identifier that tracks the consumer request by channel. Use the consumer channel type received during onboarding. See the system administrator or developer management for the `WM_CONSUMER.CHANNEL.TYPE` value. ' example: 0f3e4dd4-0514-4346-b39d-… - in: header name: WM_QOS.CORRELATION_ID required: true schema: type: string description: "Specifies an identifier for each API call and is used to track and debug issues.\n\n This may be any value, but cannot be null or omitted.\n" example: 6474-a253 - in: header name: WM_SEC.ACCESS_TOKEN required: true schema: type: string description: 'Specifies the access token retrieved in the Create Access Token request. This value is required for token-based authentication. ' example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM… responses: '200': description: Successful Operation content: application/json: schema: type: object properties: sku: type: string description: 'Indicates the stock keeping unit (SKU) item identifier. This is a product identifier provided by the drop ship vendor (DSV) to identify each item. Example(s):
1487132332472 ' example: '1487132332472' gtin: type: string description: 'Indicates the global trade item number (GTIN) item identifier. Example(s):
00012947218283 ' example: 00012947218283 quantity: type: object description: 'Indicates an object for information about the quantity in inventory. ' properties: unit: type: string description: 'Indicates the quantity unit of measurement of an item. Example(s):
EACH ' example: EACH amount: type: number description: 'Indicates the value for quantity of an item. Example(s):
23 ' example: 23 put: tags: - Inventory operationId: putUpdateInventory summary: Walmart Update Inventory Count for a Single Item description: '

PUT /v3/inventory

This request updates the inventory for an item, with the item global trade item number (GTIN) as the primary item identifier. Use an availability code to identify how inventory quantity is managed for an item. The following are valid availability codes: | Code | Use | | --- | --- | | AC | Use for standard or normal inventory updates. | | AA | Use for an item with infinite or unlimited inventory. Quantity is not required when set to AA. | Drop ship vendors (DSV) send the `onHand` quantity in the amount field as one whole quantity (unit and value). ' parameters: - in: query name: shipNode required: true schema: type: string description: "Specifies the distribution facility distributor identifier.\n\nThis parameter identifies each facility from which the inventory is requested. \nThe identifier is autogenerated during drop ship vendor (DSV) account creation. \nEvery time users add or update a facility in Supplier Center, a new identifier is generated. \nEnsure this value is up to date.\n\nExample(s):
\n123456701\n" example: '123456701' - in: header name: Accept required: false schema: type: string description: 'Specifies the data type expected in a response sent from the server. Valid values are: | Value | Meaning | | --- | --- | | application/xml | XML format for data returned in response. | | application/json | JSON format for data returned in response. | ' example: application/xml - in: header name: WM_CONSUMER.CHANNEL.TYPE required: false schema: type: string description: 'Specifies an identifier that tracks the consumer request by channel. Use the consumer channel type received during onboarding. See the system administrator or developer management for the `WM_CONSUMER.CHANNEL.TYPE` value. ' example: 0f3e4dd4-0514-4346-b39d-… - in: header name: WM_QOS.CORRELATION_ID required: true schema: type: string description: "Specifies an identifier for each API call and is used to track and debug issues.\n\n This may be any value, but cannot be null or omitted. \n" example: 6474-a253 - in: header name: WM_SEC.ACCESS_TOKEN required: true schema: type: string description: 'Specifies the access token retrieved in the Create Access Token request. This value is required for token-based authentication. ' example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM… requestBody: description: Request fields content: applications/json: schema: type: object required: - gtin - availabilityCode - quantity properties: gtin: type: string description: 'Specifies the global trade item number (GTIN) item identifier. The global trade item number is a 14-digit number, including the check digit, that is used worldwide and identifies the Each. If the user''s number is less than 14 digits, add zeros at the beginning. Either the `sku` or `gtin` parameter will be required. The user can only submit one. Example(s):
00097531246801 ' example: 00097531246801 availabilityCode: type: string description: "Specifies how to manage the inventory update.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| AC | The code used for standard inventory updates. Assign this code to an item with normal inventory. |\n| AA | The code used for an item with infinite inventory. If users set `AA` as the availability code, they do not need to provide inventory for the item. |\n\nExample(s):
\nAC
\nAA\n" enum: - AC - AA example: AC quantity: type: object description: 'Specifies an object for information about the quantity in inventory. ' required: - unit properties: unit: type: string description: 'Specifies the quantity unit of measurement of an item. Example(s):
EACH ' example: EACH amount: type: number description: 'Specifies the value for quantity of an item. Example(s):
23 ' example: 23 examples: GTIN: value: gtin: 00012947218283 availabilityCode: AC quantity: unit: EACH amount: 23 responses: '200': description: Successful Operation content: application/json: schema: type: object properties: sku: type: string description: 'Indicates the stock keeping unit (SKU) item identifier. This is a product identifier provided by the drop ship vendor (DSV) to identify each item. Example(s):
1487132332472 ' example: '1487132332472' gtin: type: string description: 'Indicates the global trade item number (GTIN) item identifier. Example(s):
00012947218283 ' example: 00012947218283 quantity: type: object description: 'Indicates an object for information about the quantity in inventory. ' properties: unit: type: string description: 'Indicates the quantity unit of measurement of an item. Example(s):
EACH ' example: EACH amount: type: number description: 'Indicates the value for quantity of an item. Example(s):
23 ' example: 23 /v3/feeds: post: tags: - Inventory operationId: postBulkUpdateInventory summary: Walmart Update Inventory Count for Items in Bulk description: '

POST /v3/feeds

This request updates inventory for items in bulk for suppliers. `DSV_INVENTORY`: This feed type updates inventory across multiple ship nodes across multiple products. The `DSV_INVENTORY` feed type only supports JSON requests and responses. For more information about feed types, see the DSV Inventory Guide. ' parameters: - in: query name: feedType required: true schema: type: string description: "Specifies the feed type. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| DSV_INVENTORY | This feed type updates inventory across multiple ship nodes across multiple products. |\n\nExample(s):
\nDSV_INVENTORY\n" example: DSV_INVENTORY - in: header name: Accept required: false schema: type: string description: 'Specifies the data type expected in a response sent from the server. Valid values are: | Value | Meaning | | --- | --- | | application/xml | XML format for data returned in response. | | application/json | JSON format for data returned in response. | ' example: application/xml - in: header name: WM_CONSUMER.CHANNEL.TYPE required: false schema: type: string description: 'Specifies an identifier that tracks the consumer request by channel. Use the consumer channel type received during onboarding. See the system administrator or developer management for the `WM_CONSUMER.CHANNEL.TYPE` value. ' example: 0f3e4dd4-0514-4346-b39d-… - in: header name: WM_QOS.CORRELATION_ID required: true schema: type: string description: "Specifies an identifier for each API call and is used to track and debug issues.\n\n This may be any value, but cannot be null or omitted. \n" example: 6474-a253 - in: header name: WM_SEC.ACCESS_TOKEN required: true schema: type: string description: 'Specifies the access token retrieved in the Create Access Token request. This value is required for token-based authentication. ' example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM… - in: header name: Content-Type required: true schema: type: string description: "Specifies the format of request and response body data. \n\nIt specifies if the payload is JSON, XML, form data, or other data type. \nSetting `Content-Type` appropriately is essential when exchanging formatted data with APIs.\n\nValid values are:\n\n| Value | Meaning |\n| --- | --- |\n| application/json | JSON format for request and response body data. |\n| multipart/form-data | Multipart form data format for request and response body data. |\n" example: application/json requestBody: description: Request fields content: applications/json: schema: type: object required: - InventoryFeedHeader - Inventory properties: InventoryFeedHeader: type: object description: 'Specifies an object for inventory feed header information. ' required: - version - feedType - feedDate - locale - businessUnit properties: version: type: string description: 'Specifies the inventory feed header version. Example(s):
2.0.20220829-15_11_50-api ' example: 2.0.20220829-15_11_50-api feedType: type: string description: 'Specifies the feed type for inventory feed header information. Valid values are: | Value | Meaning | | --- | --- | | DSV_INVENTORY | This feed type updates inventory across multiple ship nodes across multiple products. There are two versions: v2.x and v1.5. | | inventory | This feed type supports updating inventory across multiple ship nodes across multiple products. There is one version: v1.4. | Example(s):
DSV_INVENTORY ' example: DSV_INVENTORY feedDate: type: string format: date-time description: 'Specifies the inventory feed header feed date, in ISO 8601 format. Example(s):
2023-03-13T13:03:33.000Z ' example: '2023-03-13T13:03:33.000Z' locale: type: string description: 'Specifies the inventory feed header locale. Example(s):
en ' example: en businessUnit: type: string description: 'Specifies the inventory feed header business unit. Example(s):
WALMART_US ' example: WALMART_US Inventory: type: array description: 'Specifies an array of objects for inventory information. ' items: type: object required: - productId - shipNode - availabilityCode properties: productId: type: string description: 'Specifies the product identifier for the item. This parameter can only be a global trade item number (GTIN). The global trade item number (GTIN) is a 14-digit number, including the check digit, that is used worldwide and identifies the Each. If the user''s number is less than 14 digits, add zeros at the beginning. Example(s):
00097531246801 ' example: 00097531246801 shipNode: type: string description: "Specifies the distribution facility distributor identifier.\n\nThis parameter identifies each facility from which the inventory is requested. \nThe identifier is autogenerated during drop ship vendor (DSV) account creation. \nEvery time users add or update a facility in Supplier Center, a new identifier is generated. \nEnsure this value is up to date.\n\nExample(s):
\n123456701\n" example: '123456701' availabilityCode: type: string description: "Specifies how to manage the inventory update.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| AC | The code used for standard inventory updates. Assign this code to an item with normal inventory. |\n| AA | The code used for an item with infinite inventory. If users set `AA` as the availability code, they do not need to provide inventory for the item. |\n\nExample(s):
\nAC
\nAA\n" enum: - AC - AA example: AC quantity: type: integer description: "Specifies the number of available units a drop ship vendor (DSV) supplier has onhand to sell. \n\nThis value includes the number of units in the process of being shipped.\n\nExample(s):
\n100\n" example: 100 examples: v2.X: value: InventoryFeedHeader: feedType: DSV_INVENTORY version: 2.0.20220829-15_11_50-api businessUnit: WALMART_US locale: en feedDate: '2023-03-13T13:03:33.000Z' Inventory: - quantity: 10 productId: 01234567891011 shipNode: '123456701' availabilityCode: AC - quantity: 11 productId: 01234567891011 shipNode: '123456702' availabilityCode: AC - quantity: 12 productId: 01234567891010 shipNode: '123456701' availabilityCode: AC responses: '200': description: Successful Operation content: application/json: schema: type: object properties: feedId: type: string description: "Indicates the identifier returned from the POST Bulk Item Upload request, used for tracking the feed file. \n\nExample(s):
\n991B8779687C4D5DBC06DF18DB167192@AQkBAQA\n" example: 991B8779687C4D5DBC06DF18DB167192@AQkBAQA /v3/inventories/{id}: get: tags: - Inventory operationId: getSingleItemInventory summary: Walmart Retrieve Inventory Count for a Single Item at Specific Ship Nodes description: "

POST /v3/inventories/{id}

\n\nThis request retrieves the inventory count for an item across multiple ship nodes or for one specific ship node. \n\nUsers can specify the ship node(s) for which they want to fetch the inventory.\n" parameters: - in: path name: id required: true schema: type: string description: 'Specifies the value of the stock keeping unit (SKU) or global trade item number (GTIN) item identifier. This value is provided by the drop ship vendor (DSV) to identify each item. Example(s):
1487132332472
00012947218283 ' example: 00012947218283 - in: query name: shipNode required: false schema: type: string description: 'Specifies the distribution facility distributor identifier. This parameter identifies each facility from which the inventory is requested. The identifier is autogenerated during drop ship vendor (DSV) account creation. Every time users add or update a facility in Supplier Center, a new identifier is generated. Ensure this value is up to date. Example(s):
123456701 ' example: '123456701' - in: query name: productIdType required: true schema: type: string description: "Specifies the type of item identifier the user is searching.\n\nThe value defaults to `sku`.\n\nExample(s):
\ngtin
\nsku \n" example: sku - in: header name: Accept required: false schema: type: string description: 'Specifies the data type expected in a response sent from the server. Valid values are: | Value | Meaning | | --- | --- | | application/json | JSON format for data returned in response. | ' example: application/json - in: header name: WM_CONSUMER.CHANNEL.TYPE required: false schema: type: string description: 'Specifies an identifier that tracks the consumer request by channel. Use the consumer channel type received during onboarding. See the system administrator or developer management for the `WM_CONSUMER.CHANNEL.TYPE` value. ' example: 0f3e4dd4-0514-4346-b39d-… - in: header name: WM_QOS.CORRELATION_ID required: true schema: type: string description: "Specifies an identifier for each API call and is used to track and debug issues.\n\n This may be any value, but cannot be null or omitted. \n" example: 6474-a253 - in: header name: WM_SEC.ACCESS_TOKEN required: true schema: type: string description: 'Specifies the access token retrieved in the Create Access Token request. This value is required for token-based authentication. ' example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM… responses: '200': description: Successful Operation content: application/json: schema: type: object properties: sku: type: string description: 'Indicates the stock keeping unit (SKU) item identifier. This is a product identifier provided by the drop ship vendor (DSV) to identify each item. Example(s):
1487132332472 ' example: '1487132332472' gtin: type: string description: 'Indicates the global trade item number (GTIN) item identifier. Example(s):
00012947218283 ' example: 00012947218283 nodes: type: array description: 'Indicates an array for nodes, to include ship node and allocated quantity. ' items: type: object properties: shipNode: type: string description: 'Indicates the distribution facility distributor identifier for which the inventory is requested. Example(s):
123456701 ' example: '123456701' inputQty: type: object description: "Indicates an object for the on-hand inventory quantity of an item that is provided by the supplier. \n\nInput or on-hand inventory is the total inventory, with the amount factoring in both `availToSellQty` and `reservedQty`.\n" properties: unit: type: string description: 'Indicates the unit of measurement the quantity of an item. Example(s):
EACH ' example: EACH amount: type: number description: 'Indicates the value for the quantity of an item. Example(s):
214 ' example: 214 availToSellQty: type: object description: 'Indicates an object for the quantity of an item that is available to be allocated to orders. ' properties: unit: type: string description: 'Indicates the unit of measurement the quantity of an item. Example(s):
EACH ' example: EACH amount: type: number description: 'Indicates the value for the quantity of an item. Example(s):
21 ' example: 21 reservedQty: type: object description: 'Indicates an object for the quantity that has been ordered by the customers, but not yet shipped. ' properties: unit: type: string description: 'Indicates the unit of measurement the quantity of an item. Example(s):
EACH ' example: EACH amount: type: number description: 'Indicates the value for the quantity of an item. Example(s):
24 ' example: 24 /v3/inventories/{sku}: get: tags: - Inventory summary: Walmart Single Item Inventory by Ship Node description: This API will retrieve the inventory count for an item across all ship nodes or one specific ship node. You can specify the ship node for which you want to fetch the inventory operationId: getMultiNodeInventoryForSkuAndAllShipnodes parameters: - name: sku in: path description: 'An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item. Special characters in the sku needing encoding are: '':'', ''/'', ''?'', ''#'', ''['', '']'', ''@'', ''!'', ''$'', ''&'', "''", ''('', '')'', ''*'', ''+'', '','', '';'', ''='', ‘ ’ as well as ''%'' itself if it''s a part of sku. Make sure to encode space with %20. Other characters don''t need to be encoded.' required: true schema: type: string - name: shipNode in: query description: ShipNode Id of the ship node for which the inventory is requested required: false schema: type: string - in: header name: WM_SEC.ACCESS_TOKEN description: The access token retrieved in the Token API call required: true schema: type: string example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM..... - in: header name: WM_CONSUMER.CHANNEL.TYPE description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding required: false schema: type: string - in: header name: WM_QOS.CORRELATION_ID description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID required: true schema: type: string example: b3261d2d-028a-4ef7-8602-633c23200af6 - in: header name: WM_SVC.NAME description: Walmart Service Name required: true schema: type: string example: Walmart Service Name responses: '200': description: Successful Operation content: application/json: schema: type: object properties: sku: type: string description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. nodes: type: array items: type: object properties: shipNode: type: string description: ShipNode Id of the ship node for which the inventory is requested inputQty: required: - amount - unit type: object properties: unit: type: string description: 'The unit of measurement. Example: ''EACH''' enum: - EACH amount: type: number description: Inventory Count description: Quantity of an item that is input by the seller availToSellQty: required: - amount - unit type: object properties: unit: type: string description: 'The unit of measurement. Example: ''EACH''' enum: - EACH amount: type: number description: Inventory Count description: Quantity of an item that is available to be allocated to orders errors: type: array items: required: - code type: object properties: code: type: string field: type: string description: type: string info: type: string severity: type: string enum: - INFO - WARN - ERROR category: type: string enum: - APPLICATION - SYSTEM - REQUEST - DATA causes: type: array xml: wrapped: true items: type: object properties: code: type: string field: type: string type: type: string description: type: string xml: name: Cause errorIdentifiers: type: object additionalProperties: type: object xml: name: Error reservedQty: required: - amount - unit type: object properties: unit: type: string description: 'The unit of measurement. Example: ''EACH''' enum: - EACH amount: type: number description: Inventory Count description: Quantity that has been ordered by the customers but not yet shipped example: sku: AR-CTIX-0092 nodes: - shipNode: '100009' inputQty: unit: EACH amount: 5 availToSellQty: unit: EACH amount: 3 reservedQty: unit: EACH amount: 2 put: tags: - Inventory summary: Walmart Update Item Inventory Per Ship Node description: This API will update the inventory for an item across one or more fulfillment centers, known as ship nodes. operationId: updateMultiNodeInventory parameters: - name: sku in: path description: 'An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item. Special characters in the sku needing encoding are: '':'', ''/'', ''?'', ''#'', ''['', '']'', ''@'', ''!'', ''$'', ''&'', "''", ''('', '')'', ''*'', ''+'', '','', '';'', ''='', ‘ ’ as well as ''%'' itself if it''s a part of sku. Make sure to encode space with %20. Other characters don''t need to be encoded.' required: true schema: type: string - in: header name: WM_SEC.ACCESS_TOKEN description: The access token retrieved in the Token API call required: true schema: type: string example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM..... - in: header name: WM_CONSUMER.CHANNEL.TYPE description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding required: false schema: type: string - in: header name: WM_QOS.CORRELATION_ID description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID required: true schema: type: string example: b3261d2d-028a-4ef7-8602-633c23200af6 - in: header name: WM_SVC.NAME description: Walmart Service Name required: true schema: type: string example: Walmart Service Name requestBody: description: Request fields content: application/json: schema: required: - inventories type: object properties: inventories: required: - nodes type: object properties: nodes: type: array items: required: - inputQty - shipNode type: object properties: shipNode: type: string description: ShipNode Id of the ship node for which the inventory is requested inputQty: required: - amount - unit type: object properties: unit: type: string description: 'The unit of measurement. Example: ''EACH''' enum: - EACH amount: type: number description: Inventory Count description: Quantity that has been ordered by the customers but not yet shipped example: inventories: nodes: - shipNode: '1000005050' inputQty: unit: EACH amount: 88 - shipNode: '79897837271126017' inputQty: unit: EACH amount: 55 required: true responses: '200': description: Successful Operation content: application/json: schema: type: object properties: sku: type: string description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. nodes: type: array items: type: object properties: shipNode: type: string description: ShipNode Id of the ship node for which the inventory is requested status: type: string description: 'Node Update status. Example: ''Success''' errors: type: array description: Node Update Error description. items: required: - code type: object properties: code: type: string field: type: string description: type: string info: type: string severity: type: string enum: - INFO - WARN - ERROR category: type: string enum: - APPLICATION - SYSTEM - REQUEST - DATA causes: type: array xml: wrapped: true items: type: object properties: code: type: string field: type: string type: type: string description: type: string xml: name: Cause errorIdentifiers: type: object additionalProperties: type: object xml: name: Error example: sku: 00757642886669_test_01 nodes: - shipNode: '1000005050' status: Success - shipNode: '79897837271126017' status: Success /v3/inventories: get: tags: - Inventory summary: Walmart Multiple Item Inventory for All Ship Nodes description: This API will retrieve the inventory count for all of a seller's items across all ship nodes by item to ship node mapping. Inventory can be zero or non-zero. Please note that NextCursor value changes and it needs to be passed on from the previous call to next call. operationId: getMultiNodeInventoryForAllSkuAndAllShipNodes parameters: - name: limit in: query description: The number of items returned. Cannot be more than 50. required: false schema: type: string default: '10' - name: nextCursor in: query description: String returned from initial API call to indicate pagination. Specify nextCursor value to retrieve the next 50 items. required: false schema: type: string - in: header name: WM_SEC.ACCESS_TOKEN description: The access token retrieved in the Token API call required: true schema: type: string example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM..... - in: header name: WM_CONSUMER.CHANNEL.TYPE description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding required: false schema: type: string - in: header name: WM_QOS.CORRELATION_ID description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID required: true schema: type: string example: b3261d2d-028a-4ef7-8602-633c23200af6 - in: header name: WM_SVC.NAME description: Walmart Service Name required: true schema: type: string example: Walmart Service Name responses: '200': description: Successful Operation content: application/json: schema: type: object properties: meta: type: object properties: totalCount: type: number description: 'Total number of Skus of the Seller. Example: ''235''' nextCursor: type: string description: Used for pagination to fetch the next set of items. xml: name: meta elements: type: object properties: inventories: type: array items: type: object properties: sku: type: string description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. nodes: type: array items: type: object properties: shipNode: type: string description: ShipNode Id of the ship node for which the inventory is requested inputQty: required: - amount - unit type: object properties: unit: type: string description: 'The unit of measurement. Example: ''EACH''' enum: - EACH amount: type: number description: Inventory Count description: Quantity of an item that is input by the seller availToSellQty: required: - amount - unit type: object properties: unit: type: string description: 'The unit of measurement. Example: ''EACH''' enum: - EACH amount: type: number description: Inventory Count description: Quantity of an item that is available to be allocated to orders reservedQty: required: - amount - unit type: object properties: unit: type: string description: 'The unit of measurement. Example: ''EACH''' enum: - EACH amount: type: number description: Inventory Count description: Quantity that has been ordered by the customers but not yet shipped example: meta: totalCount: 123 nextCursor: NTVmZjIxOWEtZjRkMy00MGIwLThkOGYtYzFkNzI1NGZlYmQxIDEw elements: inventories: - sku: AI-IGH4-5509 nodes: - shipNode: '361451354333223041' inputQty: unit: EACH amount: 93 availToSellQty: unit: EACH amount: 93 reservedQty: unit: EACH amount: 0 - shipNode: '100009' inputQty: unit: EACH amount: 436 availToSellQty: unit: EACH amount: 433 reservedQty: unit: EACH amount: 3 - sku: 06397309545443 nodes: - shipNode: '100009' inputQty: unit: EACH amount: 5 availToSellQty: unit: EACH amount: 0 reservedQty: unit: EACH amount: 5 /v3/fulfillment/inventory: get: tags: - Inventory summary: Walmart Wfs Inventory description: You can use this API to get the current Available to Sell inventory quantities for all WFS items in your catalog. You can also query specific SKUs or filter to only items updated after a specific date in order to reduce the response size. operationId: getWFSInventory parameters: - name: sku in: query description: 'An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item. Special characters in the sku needing encoding are: '':'', ''/'', ''?'', ''#'', ''['', '']'', ''@'', ''!'', ''$'', ''&'', "''", ''('', '')'', ''*'', ''+'', '','', '';'', ''='', ‘ ’ as well as ''%'' itself if it''s a part of sku. Make sure to encode space with %20. Other characters don''t need to be encoded.' required: false schema: type: string - name: fromModifiedDate in: query description: last inventory modified date - starting range. required: false schema: type: string - name: toModifiedDate in: query description: last inventory modified date - starting range. required: false schema: type: string - name: limit in: query description: Number of Sku to be returned. Cannot be larger than 300. required: false schema: type: string default: '10' - name: offset in: query description: Offset is the number of records you wish to skip before selecting records. required: false schema: type: string default: '0' - name: shipNodeType in: query description: 'Currently supported: multichannel. This param is enabled only for multi channel sellers. sku becomes mandatory and other params are ineffective while using this param. sku can either contain one item or list of sku''s separated by comma (example: sku1,sku2)' required: false schema: type: string - in: header name: WM_SEC.ACCESS_TOKEN description: The access token retrieved in the Token API call required: true schema: type: string example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM..... - in: header name: WM_CONSUMER.CHANNEL.TYPE description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding required: false schema: type: string - in: header name: WM_QOS.CORRELATION_ID description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID required: true schema: type: string example: b3261d2d-028a-4ef7-8602-633c23200af6 - in: header name: WM_SVC.NAME description: Walmart Service Name required: true schema: type: string example: Walmart Service Name responses: '200': description: Successful Operation content: application/json: schema: type: object properties: headers: type: object properties: totalCount: type: integer description: Total number of results for query. format: int32 limit: type: integer description: Information about the quantity in inventory format: int32 offset: type: integer description: Offset is the number of records you wish to skip before selecting results. format: int32 payload: type: object properties: inventory: type: array items: type: object properties: sku: type: string description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. shipNodes: type: array items: type: object properties: modifiedDate: type: string description: Last changes date for the item. availToSellQty: type: integer description: The available quantity is the quantity of an item that is available to be allocated to orders. format: int32 onHandQty: type: integer description: The on-hand balance is the quantity of active inventory stored at the warehouse.Active inventory is defined as the usable amount of an item that is in the warehouse.Inventory is active if it is not damaged, expired or being inspected. format: int32 shipNodeType: type: string description: Identifies fulfillment aspect of invetory. Walmart, seller or 3PL fulfilled. Possible value is 'WFSFulfilled'. In later phase we will also add seller fulfilled inventory. x-tagGroups: - name: 1P Suppliers DSV Cost Reference tags: - DSV Cost