Jump to

• Request
• Response

updateInventory

post

/ccadmin/v1/webhook/updateInventory

This event is triggered on update of inventory with the details of inventory items which change their availability status

Request

Supported Media Types

• application/json

Body ()

Root Schema : updateInventory_request

Type: object

Show Source

• availabilityDate(optional): string
  Availability date. Date format is an ISO standard such as yyyy-MM-dd.
• backorderLevel(optional): integer
  Backorder level of the variant.
• backorderThreshold(optional): integer
  Backorder threshold of the variant.
• locationId(optional): string
  ID of the location for which the inventory is being updated.
• preorderLevel(optional): integer
  Preorder level of the variant.
• preorderThreshold(optional): integer
  Preorder threshold of the variant.
• stockLevel(optional): string
  Stock level of the variant.
• stockThreshold(optional): integer
  Stock threshold.
• type(optional): string
  Inventory type, either variant or product. Defaults to variant.

{
    "properties":{
        "preorderThreshold":{
            "description":"Preorder threshold of the variant.",
            "type":"integer"
        },
        "backorderLevel":{
            "description":"Backorder level of the variant.",
            "type":"integer"
        },
        "preorderLevel":{
            "description":"Preorder level of the variant.",
            "type":"integer"
        },
        "locationId":{
            "description":"ID of the location for which the inventory is being updated.",
            "type":"string"
        },
        "availabilityDate":{
            "description":"Availability date. Date format is an ISO standard such as yyyy-MM-dd.",
            "type":"string"
        },
        "backorderThreshold":{
            "description":"Backorder threshold of the variant.",
            "type":"integer"
        },
        "stockThreshold":{
            "description":"Stock threshold.",
            "type":"integer"
        },
        "type":{
            "description":"Inventory type, either variant or product. Defaults to variant.",
            "type":"string"
        },
        "stockLevel":{
            "description":"Stock level of the variant.",
            "type":"string"
        }
    },
    "example":{
        "preorderThreshold":0,
        "backorderLevel":0,
        "preorderLevel":0,
        "locationId":"loc1",
        "availabilityDate":null,
        "backorderThreshold":0,
        "stockThreshold":"10",
        "type":"variant",
        "stockLevel":"120"
    }
}

Example:

{
    "preorderThreshold":0,
    "backorderLevel":0,
    "preorderLevel":0,
    "locationId":"loc1",
    "availabilityDate":null,
    "backorderThreshold":0,
    "stockThreshold":"10",
    "type":"variant",
    "stockLevel":"120"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

No response is returned as this is an event webhook

Body ()

Root Schema : emptyResponse

Show Source

{
    "properties":{
    }
}

Back to Top