Root Schema : updateInventory_request
Type: object
Show Source
{
"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
{
"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
{
"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
{
"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
{
"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
{
"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
{
"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
{
"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
{
"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"
}
}
}