Stock Status v3

Inform Gelato about changes in product inventory. The API support multiple SKUs in a single request, provided in an array format, maximum 100 SKU per request. Following statuses can be posted back to Gelato:

• in-stock - use when a product is back in stock
• out-of-stock - use when a product goes out of stock

POST /v3/stock/status

Request example

{
  "items": [
    {
      "SKU": "001-HOODIE-YEL-XL",
      "status": "out-of-stock",
      "quantity": 0,
      "replenishmentDate": null
    },
    {
      "SKU": "002-SHOE-BLK-42",
      "status": "in-stock",
      "quantity": 50,
      "replenishmentDate": "2021-12-31"
    }
  ]
}

Success response example

{
  "message": "product status has been updated",
  "updated_skus": [
    "001-HOODIE-YEL-XL",
    "002-SHOE-BLK-42"
  ]
}

Error response example

{
  "error": "status is not supported"
}

Request

Parameter	Type	Description
Items (required)	array	Array of items. Each item must contain the following fields: SKU, status, and quantity. Maximum 100 items per request. Sample: [{"SKU": "001-HOODIE-YEL-XL", "status": "out-of-stock", "quantity": 0}].
SKU (required)	string	SKU of the product. Sample: 001-HOODIE-YEL-XL.
status (required)	string	One of the supported values (see below): • in-stock - use when a product is back in stock • out-of-stock - use when a product goes out of stock. Sample: out-of-stock.
quantity (optional)	number	Number of items in stock. Must be greater than or equal to 0 Sample: 50.
replenishmentDate (optional)	string	Date when the SKU will be replenished. Format: YYYY-MM-DD. Example: 2024-01-21

Success response

Parameter	Type	Description
message (required)	string	The message with the success. Sample: subscribed webhook.
updated_skus	array	Array of updated SKUs. Sample: ["001-HOODIE-YEL-XL"].

Error response

Parameter	Type	Description
error (required)	string	The message with the error. Sample: status is not supported,sku shouldn't be empty.