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

• count(optional): integer
  Count of updated items

  Example: 1
• date(optional): string
  The timestamp at which the inventory got updated in format yyyy-MM-dd HH:mm:ss

  Example: 2019-12-20 09:41:43
• inventoryInfo(optional): object inventoryInfo
  Inventory information

{
    "properties":{
        "date":{
            "description":"The timestamp at which the inventory got updated in format yyyy-MM-dd HH:mm:ss",
            "type":"string",
            "example":"2019-12-20 09:41:43"
        },
        "inventoryInfo":{
            "description":"Inventory information",
            "type":"object",
            "properties":{
                "updatedItems":{
                    "description":"Array of updated items",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "oldAvailabilityStatus":{
                                "description":"The availability status of the SKU before update",
                                "type":"string",
                                "example":"outOfStock"
                            },
                            "sku":{
                                "description":"Properties of SKU from Product Catalog",
                                "type":"object",
                                "properties":{
                                    "parentProducts":{
                                        "description":"Properties of parent product of the SKU from Product Catalog",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "longDescription":{
                                                    "description":"Long description of the product",
                                                    "type":"string"
                                                },
                                                "displayName":{
                                                    "description":"Display name of the product",
                                                    "type":"string",
                                                    "example":"Cam_test_1"
                                                },
                                                "description":{
                                                    "description":"Description of the product",
                                                    "type":"string"
                                                },
                                                "active":{
                                                    "description":"Product active property",
                                                    "type":"boolean",
                                                    "example":true
                                                },
                                                "primaryFullImageURL":{
                                                    "description":"Product image URL",
                                                    "type":"string",
                                                    "example":"/img/no-image.jpg"
                                                },
                                                "id":{
                                                    "description":"Product ID",
                                                    "type":"string",
                                                    "example":"Cam_test_1"
                                                }
                                            }
                                        }
                                    },
                                    "locationId":{
                                        "description":"Location ID of the item",
                                        "type":"string"
                                    },
                                    "active":{
                                        "description":"SKU active property",
                                        "type":"boolean",
                                        "example":true
                                    },
                                    "variants":{
                                        "description":"Array containing variant info of the SKU",
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "optionValue":{
                                                    "description":"Value of the variant for this SKU",
                                                    "type":"string",
                                                    "example":"Banana Mania"
                                                },
                                                "optionName":{
                                                    "description":"Name of the variant",
                                                    "type":"string",
                                                    "example":"color"
                                                }
                                            }
                                        }
                                    },
                                    "id":{
                                        "description":"SKU ID",
                                        "type":"string",
                                        "example":"Cam_test_SKU_2"
                                    }
                                }
                            },
                            "newAvailabilityStatus":{
                                "description":"The availability status of the SKU after update",
                                "type":"string",
                                "example":"inStock"
                            }
                        }
                    }
                }
            }
        },
        "count":{
            "description":"Count of updated items",
            "type":"integer",
            "example":1
        }
    }
}

Nested Schema : inventoryInfo

Type: object

Inventory information

Show Source

• updatedItems(optional): array updatedItems
  Array of updated items

{
    "description":"Inventory information",
    "type":"object",
    "properties":{
        "updatedItems":{
            "description":"Array of updated items",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "oldAvailabilityStatus":{
                        "description":"The availability status of the SKU before update",
                        "type":"string",
                        "example":"outOfStock"
                    },
                    "sku":{
                        "description":"Properties of SKU from Product Catalog",
                        "type":"object",
                        "properties":{
                            "parentProducts":{
                                "description":"Properties of parent product of the SKU from Product Catalog",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "longDescription":{
                                            "description":"Long description of the product",
                                            "type":"string"
                                        },
                                        "displayName":{
                                            "description":"Display name of the product",
                                            "type":"string",
                                            "example":"Cam_test_1"
                                        },
                                        "description":{
                                            "description":"Description of the product",
                                            "type":"string"
                                        },
                                        "active":{
                                            "description":"Product active property",
                                            "type":"boolean",
                                            "example":true
                                        },
                                        "primaryFullImageURL":{
                                            "description":"Product image URL",
                                            "type":"string",
                                            "example":"/img/no-image.jpg"
                                        },
                                        "id":{
                                            "description":"Product ID",
                                            "type":"string",
                                            "example":"Cam_test_1"
                                        }
                                    }
                                }
                            },
                            "locationId":{
                                "description":"Location ID of the item",
                                "type":"string"
                            },
                            "active":{
                                "description":"SKU active property",
                                "type":"boolean",
                                "example":true
                            },
                            "variants":{
                                "description":"Array containing variant info of the SKU",
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "optionValue":{
                                            "description":"Value of the variant for this SKU",
                                            "type":"string",
                                            "example":"Banana Mania"
                                        },
                                        "optionName":{
                                            "description":"Name of the variant",
                                            "type":"string",
                                            "example":"color"
                                        }
                                    }
                                }
                            },
                            "id":{
                                "description":"SKU ID",
                                "type":"string",
                                "example":"Cam_test_SKU_2"
                            }
                        }
                    },
                    "newAvailabilityStatus":{
                        "description":"The availability status of the SKU after update",
                        "type":"string",
                        "example":"inStock"
                    }
                }
            }
        }
    }
}

Nested Schema : updatedItems

Type: array

Array of updated items

Show Source

• Array of: object items

{
    "description":"Array of updated items",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "oldAvailabilityStatus":{
                "description":"The availability status of the SKU before update",
                "type":"string",
                "example":"outOfStock"
            },
            "sku":{
                "description":"Properties of SKU from Product Catalog",
                "type":"object",
                "properties":{
                    "parentProducts":{
                        "description":"Properties of parent product of the SKU from Product Catalog",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "longDescription":{
                                    "description":"Long description of the product",
                                    "type":"string"
                                },
                                "displayName":{
                                    "description":"Display name of the product",
                                    "type":"string",
                                    "example":"Cam_test_1"
                                },
                                "description":{
                                    "description":"Description of the product",
                                    "type":"string"
                                },
                                "active":{
                                    "description":"Product active property",
                                    "type":"boolean",
                                    "example":true
                                },
                                "primaryFullImageURL":{
                                    "description":"Product image URL",
                                    "type":"string",
                                    "example":"/img/no-image.jpg"
                                },
                                "id":{
                                    "description":"Product ID",
                                    "type":"string",
                                    "example":"Cam_test_1"
                                }
                            }
                        }
                    },
                    "locationId":{
                        "description":"Location ID of the item",
                        "type":"string"
                    },
                    "active":{
                        "description":"SKU active property",
                        "type":"boolean",
                        "example":true
                    },
                    "variants":{
                        "description":"Array containing variant info of the SKU",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "optionValue":{
                                    "description":"Value of the variant for this SKU",
                                    "type":"string",
                                    "example":"Banana Mania"
                                },
                                "optionName":{
                                    "description":"Name of the variant",
                                    "type":"string",
                                    "example":"color"
                                }
                            }
                        }
                    },
                    "id":{
                        "description":"SKU ID",
                        "type":"string",
                        "example":"Cam_test_SKU_2"
                    }
                }
            },
            "newAvailabilityStatus":{
                "description":"The availability status of the SKU after update",
                "type":"string",
                "example":"inStock"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• newAvailabilityStatus(optional): string
  The availability status of the SKU after update

  Example: inStock
• oldAvailabilityStatus(optional): string
  The availability status of the SKU before update

  Example: outOfStock
• sku(optional): object sku
  Properties of SKU from Product Catalog

{
    "type":"object",
    "properties":{
        "oldAvailabilityStatus":{
            "description":"The availability status of the SKU before update",
            "type":"string",
            "example":"outOfStock"
        },
        "sku":{
            "description":"Properties of SKU from Product Catalog",
            "type":"object",
            "properties":{
                "parentProducts":{
                    "description":"Properties of parent product of the SKU from Product Catalog",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "longDescription":{
                                "description":"Long description of the product",
                                "type":"string"
                            },
                            "displayName":{
                                "description":"Display name of the product",
                                "type":"string",
                                "example":"Cam_test_1"
                            },
                            "description":{
                                "description":"Description of the product",
                                "type":"string"
                            },
                            "active":{
                                "description":"Product active property",
                                "type":"boolean",
                                "example":true
                            },
                            "primaryFullImageURL":{
                                "description":"Product image URL",
                                "type":"string",
                                "example":"/img/no-image.jpg"
                            },
                            "id":{
                                "description":"Product ID",
                                "type":"string",
                                "example":"Cam_test_1"
                            }
                        }
                    }
                },
                "locationId":{
                    "description":"Location ID of the item",
                    "type":"string"
                },
                "active":{
                    "description":"SKU active property",
                    "type":"boolean",
                    "example":true
                },
                "variants":{
                    "description":"Array containing variant info of the SKU",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "optionValue":{
                                "description":"Value of the variant for this SKU",
                                "type":"string",
                                "example":"Banana Mania"
                            },
                            "optionName":{
                                "description":"Name of the variant",
                                "type":"string",
                                "example":"color"
                            }
                        }
                    }
                },
                "id":{
                    "description":"SKU ID",
                    "type":"string",
                    "example":"Cam_test_SKU_2"
                }
            }
        },
        "newAvailabilityStatus":{
            "description":"The availability status of the SKU after update",
            "type":"string",
            "example":"inStock"
        }
    }
}

Nested Schema : sku

Type: object

Properties of SKU from Product Catalog

Show Source

• active(optional): boolean
  SKU active property

  Example: true
• id(optional): string
  SKU ID

  Example: Cam_test_SKU_2
• locationId(optional): string
  Location ID of the item
• parentProducts(optional): array parentProducts
  Properties of parent product of the SKU from Product Catalog
• variants(optional): array variants
  Array containing variant info of the SKU

{
    "description":"Properties of SKU from Product Catalog",
    "type":"object",
    "properties":{
        "parentProducts":{
            "description":"Properties of parent product of the SKU from Product Catalog",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "longDescription":{
                        "description":"Long description of the product",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"Display name of the product",
                        "type":"string",
                        "example":"Cam_test_1"
                    },
                    "description":{
                        "description":"Description of the product",
                        "type":"string"
                    },
                    "active":{
                        "description":"Product active property",
                        "type":"boolean",
                        "example":true
                    },
                    "primaryFullImageURL":{
                        "description":"Product image URL",
                        "type":"string",
                        "example":"/img/no-image.jpg"
                    },
                    "id":{
                        "description":"Product ID",
                        "type":"string",
                        "example":"Cam_test_1"
                    }
                }
            }
        },
        "locationId":{
            "description":"Location ID of the item",
            "type":"string"
        },
        "active":{
            "description":"SKU active property",
            "type":"boolean",
            "example":true
        },
        "variants":{
            "description":"Array containing variant info of the SKU",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "optionValue":{
                        "description":"Value of the variant for this SKU",
                        "type":"string",
                        "example":"Banana Mania"
                    },
                    "optionName":{
                        "description":"Name of the variant",
                        "type":"string",
                        "example":"color"
                    }
                }
            }
        },
        "id":{
            "description":"SKU ID",
            "type":"string",
            "example":"Cam_test_SKU_2"
        }
    }
}

Nested Schema : parentProducts

Type: array

Properties of parent product of the SKU from Product Catalog

Show Source

• Array of: object items

{
    "description":"Properties of parent product of the SKU from Product Catalog",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "longDescription":{
                "description":"Long description of the product",
                "type":"string"
            },
            "displayName":{
                "description":"Display name of the product",
                "type":"string",
                "example":"Cam_test_1"
            },
            "description":{
                "description":"Description of the product",
                "type":"string"
            },
            "active":{
                "description":"Product active property",
                "type":"boolean",
                "example":true
            },
            "primaryFullImageURL":{
                "description":"Product image URL",
                "type":"string",
                "example":"/img/no-image.jpg"
            },
            "id":{
                "description":"Product ID",
                "type":"string",
                "example":"Cam_test_1"
            }
        }
    }
}

Nested Schema : variants

Type: array

Array containing variant info of the SKU

Show Source

• Array of: object items

{
    "description":"Array containing variant info of the SKU",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "optionValue":{
                "description":"Value of the variant for this SKU",
                "type":"string",
                "example":"Banana Mania"
            },
            "optionName":{
                "description":"Name of the variant",
                "type":"string",
                "example":"color"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• active(optional): boolean
  Product active property

  Example: true
• description(optional): string
  Description of the product
• displayName(optional): string
  Display name of the product

  Example: Cam_test_1
• id(optional): string
  Product ID

  Example: Cam_test_1
• longDescription(optional): string
  Long description of the product
• primaryFullImageURL(optional): string
  Product image URL

  Example: /img/no-image.jpg

{
    "type":"object",
    "properties":{
        "longDescription":{
            "description":"Long description of the product",
            "type":"string"
        },
        "displayName":{
            "description":"Display name of the product",
            "type":"string",
            "example":"Cam_test_1"
        },
        "description":{
            "description":"Description of the product",
            "type":"string"
        },
        "active":{
            "description":"Product active property",
            "type":"boolean",
            "example":true
        },
        "primaryFullImageURL":{
            "description":"Product image URL",
            "type":"string",
            "example":"/img/no-image.jpg"
        },
        "id":{
            "description":"Product ID",
            "type":"string",
            "example":"Cam_test_1"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• optionName(optional): string
  Name of the variant

  Example: color
• optionValue(optional): string
  Value of the variant for this SKU

  Example: Banana Mania

{
    "type":"object",
    "properties":{
        "optionValue":{
            "description":"Value of the variant for this SKU",
            "type":"string",
            "example":"Banana Mania"
        },
        "optionName":{
            "description":"Name of the variant",
            "type":"string",
            "example":"color"
        }
    }
}

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