Inventory

The inventory request contains a list of partner product SKUs.

The request is sent by Gelato Connect API to an {inventoryUrl} that is obtained from the Subscribe request.

The response should contain a list of partner product SKUs with the relevant stock status and stock count (optional) at the time of the request.

Your API must return the same number of SKUs requested by Gelato. If Gelato requests the status of a specific SKU, you must return it. If there is no SKU with a status, we will take no action.

If you remove an SKU from your catalog without informing Gelato, your API should return the removed SKU with an * out-of-stock* status when requested.

If you provide JIT or non-JIT SKUs with stock status and amount, ensure that you do not report an amount of 0 with a stock status of in-stock. In this case, we will categorize it as out-of-stock.

POST /{inventoryUrl}

Request example

{
  "version": "1.0",
  "SKU": [
    "001-HOODIE-YEL-XL",
    "002-HOODIE-YEL-L",
    "003-HOODIE-YEL-M"
  ]
}

Response example

{
  "items": [
    {
      "SKU": "001-HOODIE-YEL-XL",
      "status": "in-stock",
      "amount": 5,
      "replenishmentDate": null
    },
    {
      "SKU": "002-HOODIE-YEL-L",
      "status": "out-of-stock",
      "amount": 0,
      "replenishmentDate": "2021-12-31"
    },
    {
      "SKU": "003-HOODIE-YEL-M",
      "status": "out-of-stock",
      "amount": 0,
      "replenishmentDate": null
    }
  ]
}

Request

InventoryRequest

Parameter	Type	Description
version (required)	string	Gelato Connect API version. Sample: 1.0
SKU (required)	string[]	List of products SKU. Sample: 001-HOODIE-YEL-XL, 002-HOODIE-YEL-L, 003-HOODIE-YEL-M

Response

InventoryResponse

Parameter	Type	Description
items (required)	InventoryResponseItem[]	An array of inventory response items.

InventoryResponseItem

Parameter	Type	Description
SKU (required)	string	SKU of a product. Sample: 001-HOODIE-YEL-XL.
status (required)	string	Actual stock status of a product. Sample: in-stock or out-of-stock
amount (optional)	number	Number of items in stock. Sample: 5
replenishmentDate (optional)	string	Date when the SKU will be replenished. Format: YYYY-MM-DD. Example: 2024-01-21