Test Item (desc)
", "LanguageCode": "en", "ProductName": "Test Item", "SeoKeywords": "", "Specifications": "Test Item (specs)
" } ], "Options": [ { "OptionId": 3, "Option": "Color", "OptionType": 1, "Values": [ { "Option": "Blue", "SkuExt": "-B" }, { "Option": "Green", "SkuExt": "-G" }, { "Option": "Red", "SkuExt": "-R" } ] }, { "OptionId": 4, "Option": "Size", "OptionType": 1, "Values": [ { "Option": "Lage", "SkuExt": "-L" }, { "Option": "Medium", "SkuExt": "-M" }, { "Option": "Small", "SkuExt": "-S" } ] } ], "OptionsMap": [ { "Key": "Red|Small", "Checked": true, "ItemId": 154, "Image": "", "ExtSku": "-R-S", "StockLevels": [ ] }, { "Key": "Red|Medium", "Checked": true, "ItemId": 155, "Image": "", "ExtSku": "-R-M", "StockLevels": [ ] }, { "Key": "Red|Lage", "Checked": true, "ItemId": 156, "Image": "", "ExtSku": "-R-L", "StockLevels": [ ] }, { "Key": "Green|Small", "Checked": true, "ItemId": 157, "Image": "", "ExtSku": "-G-S", "StockLevels": [ ] }, { "Key": "Green|Medium", "Checked": true, "ItemId": 158, "Image": "", "ExtSku": "-G-M", "StockLevels": [ ] }, { "Key": "Green|Lage", "Checked": true, "ItemId": 159, "Image": "", "ExtSku": "-G-L", "StockLevels": [ ] }, { "Key": "Blue|Small", "Checked": true, "ItemId": 160, "Image": "", "ExtSku": "-B-S", "StockLevels": [ ] }, { "Key": "Blue|Medium", "Checked": true, "ItemId": 161, "Image": "", "ExtSku": "-B-M", "StockLevels": [ ] }, { "Key": "Blue|Lage", "Checked": true, "ItemId": 162, "Image": "", "ExtSku": "-B-L", "StockLevels": [ ] } ], "Discounts": [ { "Id": 175, "Bonus": null, "End": "9998-12-31T00:00:00.0000000+00:00", "Price": 10, "PriceCurrency": "USD", "Cv": 5, "Qv": 4, "RewardPointsEarned": 0, "Start": "2000-01-01T00:00:00.0000000+00:00", "Type": 1, "Stores": [ 1, 2, 3, 4, 5 ], "OrderType": [ 1, 2 ], "PriceGroups": [ 1, 2 ], "Regions": [ 1 ] } ], "KitGroups": [ { "Name": "Kit Group 1", "Items": [ { "ItemId": 22, "Name": "Kit 1 Item 1", "Quantity": 2 }, { "ItemId": 19, "Name": "Kit 1 Item 2", "Quantity": 1 }, { "ItemId": 97, "Name": "Kit 1 Item 3", "Quantity": 2 } ] }, { "Name": "Kit Group 2", "Items": [ { "ItemId": 20, "Name": "Kit 2 Item 1", "Quantity": 1 }, { "ItemId": 21, "Name": "Kit 2 Item 2", "Quantity": 3 } ] } ], "BillOfMaterials": [ { "ItemId": 19, "Name": "BOM Item 1", "Quantity": 1 }, { "ItemId": 23, "Name": "BOM Item 2", "Quantity": 1 } ], "StockLevels": [ { "WarehouseId": 1, "ItemId": 1, "Avaliable": 100, "Committed": 100, "OnHand": 200, "OnOrder": 0, "OutOfStock": false, "TrackStock": 1 } ] } } } }, "404": { "description": "An Item with the given Item ID was not found." }, "500": { "description": "Something went wrong... Here are some possible reasons for this error:\n- Is the model being sent to the API incorrect?\n- Did you forget a required field?\n- Is the API marked as deprecated, and the date has expired?\n\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists." } } } }, "/item/sku/{sku}": { "get": { "tags": [ "Products" ], "summary": "Get Item by SKU", "description": "Retrieves an Item based on a valid Item Stock Keeping Unit (SKU).\r\n\r\nYou can get the **Request Parameters** at these calls:\r\n\r\n**sku**\r\n- Get Item by Id\r\n- Get Items\r\n- Get Items by Filter\r\n\r\n**CurrencyCode**\r\n- **Get Regions** displays the country/state codes of the warehouses. If you are concerned about having the proper **CurrencyCode**, then this will allow you to know what region warehouse support team to call to get the confirmed **CurrencyCode**.\r\n\r\n**LanguageCode**\r\n- Get Item by Id\r\n- Get Items\r\n- Get Items by Filter\r\n\r\n**Note:**\r\nThe full Image path for the item is on the Disco application server, at this URL:\r\nhttps://Test Item (desc)
", "LanguageCode": "en", "ProductName": "Test Item", "SeoKeywords": "", "Specifications": "Test Item (specs)
" } ], "Options": [ { "OptionId": 3, "Option": "Color", "OptionType": 1, "Values": [ { "Option": "Blue", "SkuExt": "-B" }, { "Option": "Green", "SkuExt": "-G" }, { "Option": "Red", "SkuExt": "-R" } ] }, { "OptionId": 4, "Option": "Size", "OptionType": 1, "Values": [ { "Option": "Lage", "SkuExt": "-L" }, { "Option": "Medium", "SkuExt": "-M" }, { "Option": "Small", "SkuExt": "-S" } ] } ], "OptionsMap": [ { "Key": "Red|Small", "Checked": true, "ItemId": 154, "Image": "", "ExtSku": "-R-S", "StockLevels": [ ] }, { "Key": "Red|Medium", "Checked": true, "ItemId": 155, "Image": "", "ExtSku": "-R-M", "StockLevels": [ ] }, { "Key": "Red|Lage", "Checked": true, "ItemId": 156, "Image": "", "ExtSku": "-R-L", "StockLevels": [ ] }, { "Key": "Green|Small", "Checked": true, "ItemId": 157, "Image": "", "ExtSku": "-G-S", "StockLevels": [ ] }, { "Key": "Green|Medium", "Checked": true, "ItemId": 158, "Image": "", "ExtSku": "-G-M", "StockLevels": [ ] }, { "Key": "Green|Lage", "Checked": true, "ItemId": 159, "Image": "", "ExtSku": "-G-L", "StockLevels": [ ] }, { "Key": "Blue|Small", "Checked": true, "ItemId": 160, "Image": "", "ExtSku": "-B-S", "StockLevels": [ ] }, { "Key": "Blue|Medium", "Checked": true, "ItemId": 161, "Image": "", "ExtSku": "-B-M", "StockLevels": [ ] }, { "Key": "Blue|Lage", "Checked": true, "ItemId": 162, "Image": "", "ExtSku": "-B-L", "StockLevels": [ ] } ], "Discounts": [ { "Id": 175, "Bonus": null, "End": "9998-12-31T00:00:00.0000000+00:00", "Price": 10, "PriceCurrency": "USD", "Cv": 5, "Qv": 4, "RewardPointsEarned": 0, "Start": "2000-01-01T00:00:00.0000000+00:00", "Type": 1, "Stores": [ 1, 2, 3, 4, 5 ], "OrderType": [ 1, 2 ], "PriceGroups": [ 1, 2 ], "Regions": [ 1 ] } ], "KitGroups": [ { "Name": "Kit Group 1", "Items": [ { "ItemId": 22, "Name": "Kit 1 Item 1", "Quantity": 2 }, { "ItemId": 19, "Name": "Kit 1 Item 2", "Quantity": 1 }, { "ItemId": 97, "Name": "Kit 1 Item 3", "Quantity": 2 } ] }, { "Name": "Kit Group 2", "Items": [ { "ItemId": 20, "Name": "Kit 2 Item 1", "Quantity": 1 }, { "ItemId": 21, "Name": "Kit 2 Item 2", "Quantity": 3 } ] } ], "BillOfMaterials": [ { "ItemId": 19, "Name": "BOM Item 1", "Quantity": 1 }, { "ItemId": 23, "Name": "BOM Item 2", "Quantity": 1 } ], "StockLevels": [ { "WarehouseId": 1, "ItemId": 1, "Avaliable": 100, "Committed": 100, "OnHand": 200, "OnOrder": 0, "OutOfStock": false, "TrackStock": 1 } ] } } } }, "404": { "description": "An Item with the given Item SKU was not found." }, "500": { "description": "Something went wrong... Here are some possible reasons for this error:\n- Is the model being sent to the API incorrect?\n- Did you forget a required field?\n- Is the API marked as deprecated, and the date has expired?\n\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists." } } } }, "/categories/{categoryId}/items": { "get": { "tags": [ "Products" ], "summary": "Get Items by Filter", "description": "Return all items in a given country and category. Optional filter parameters will limit translations, prices, and products returned.\n**Note:**\nThe full Image path for the item is on the Disco application server, at this URL:\nhttps://\\Test Item (description)
", "Specifications": "Test Item (specs)
", "SEO": null, "LanguageCode": "en", "SKU": "DRTSCL", "Category": "Test Category", "CategoryId": 1, "ChargeShipping": true, "Custom": { "ItemId": 0, "Field1": "", "Field2": "", "Field3": "", "Field4": "", "Field5": "" }, "Height": 0, "ImageUrl": "/testitem.jpg", "Length": 0, "LengthUOM": "cm", "MPN": "", "PackCount": 0, "PackageGroupID": 1, "TaxClassID": 0, "UnitOfMeasure": "", "UPC": "", "Weight": 1, "WeightUOM": "kg", "Width": 0, "FlagBirthDefects": false, "HasKitGroups": false, "FlagCancer": false, "PriceGroup": 1, "Price": 10, "CurrencyCode": "usd", "OriginalPrice": 10, "OutOfStockStatus": 1, "Bonus": 0, "CV": 5, "QV": 4, "RewardPoints": 0, "StoreId": 0, "HasOptions": true, "PriceGroups": [ 1 ], "StockLevels": [ { "WarehouseId": 1, "ItemId": 1, "Avaliable": 100, "Committed": 100, "OnHand": 200, "OnOrder": 0, "OutOfStock": false, "TrackStock": 1 } ], "KitGroups": [ { "Name": "Kit Group 1", "Items": [ { "ItemId": 22, "Name": "Kit 1 Item 1", "Quantity": 2 }, { "ItemId": 19, "Name": "Kit 1 Item 2", "Quantity": 1 }, { "ItemId": 97, "Name": "Kit 1 Item 3", "Quantity": 2 } ] }, { "Name": "Kit Group 2", "Items": [ { "ItemId": 20, "Name": "Kit 2 Item 1", "Quantity": 1 }, { "ItemId": 21, "Name": "Kit 2 Item 2", "Quantity": 3 } ] } ], "Images": [ { "Description": "/testitem.jpg", "Path": "/testitem.jpg" } ], "Prices": [ { "PriceGroupId": 1, "Price": 10, "PriceCurrency": "usd", "OriginalPrice": 10, "Bonus": 0, "CV": 5, "QV": 4, "RewardPoints": 0 } ], "ItemOptions": [ { "OptionId": 3, "Option": "Color", "OptionType": 1, "Values": [ { "Option": "Blue", "SkuExt": "-B" }, { "Option": "Green", "SkuExt": "-G" }, { "Option": "Red", "SkuExt": "-R" } ] }, { "OptionId": 4, "Option": "Size", "OptionType": 1, "Values": [ { "Option": "Lage", "SkuExt": "-L" }, { "Option": "Medium", "SkuExt": "-M" }, { "Option": "Small", "SkuExt": "-S" } ] } ], "Languages": [ { "Description": "Test Item (desc)
", "LanguageCode": "en", "ProductName": "Test Item", "SeoKeywords": "", "Specifications": "Test Item (specs)
" } ], "OptionsMap": [ { "Key": "Red|Small", "Checked": true, "ItemId": 154, "Image": "", "ExtSku": "-R-S", "StockLevels": [ ] }, { "Key": "Red|Medium", "Checked": true, "ItemId": 155, "Image": "", "ExtSku": "-R-M", "StockLevels": [ ] }, { "Key": "Red|Lage", "Checked": true, "ItemId": 156, "Image": "", "ExtSku": "-R-L", "StockLevels": [ ] }, { "Key": "Green|Small", "Checked": true, "ItemId": 157, "Image": "", "ExtSku": "-G-S", "StockLevels": [ ] }, { "Key": "Green|Medium", "Checked": true, "ItemId": 158, "Image": "", "ExtSku": "-G-M", "StockLevels": [ ] }, { "Key": "Green|Lage", "Checked": true, "ItemId": 159, "Image": "", "ExtSku": "-G-L", "StockLevels": [ ] }, { "Key": "Blue|Small", "Checked": true, "ItemId": 160, "Image": "", "ExtSku": "-B-S", "StockLevels": [ ] }, { "Key": "Blue|Medium", "Checked": true, "ItemId": 161, "Image": "", "ExtSku": "-B-M", "StockLevels": [ ] }, { "Key": "Blue|Lage", "Checked": true, "ItemId": 162, "Image": "", "ExtSku": "-B-L", "StockLevels": [ ] } ], "BillOfMaterials": [ { "ItemId": 19, "Name": "BOM Item 1", "Quantity": 1 }, { "ItemId": 23, "Name": "BOM Item 2", "Quantity": 1 } ] } ] } } }, "404": { "description": "A Category with the given Category ID was not found." }, "500": { "description": "Something went wrong... Here are some possible reasons for this error:\n- Is the model being sent to the API incorrect?\n- Did you forget a required field?\n- Is the API marked as deprecated, and the date has expired?\n\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists." } } } }, "/stores": { "get": { "tags": [ "Products" ], "summary": "Get Stores", "description": "The DirectScale commission engine contains a collection of \"stores\". Products and product categories are categorized into specific \"stores\". For instance, Retail, Wholesale, etc., listings that contain products and categories.Test Item (desc)
", "LanguageCode": "en", "ProductName": "Test Item", "SeoKeywords": "", "Specifications": "Test Item (specs)
" } ], "Options": [ { "OptionId": 3, "Option": "Color", "OptionType": 1, "Values": [ { "Option": "Blue", "SkuExt": "-B" }, { "Option": "Green", "SkuExt": "-G" }, { "Option": "Red", "SkuExt": "-R" } ] }, { "OptionId": 4, "Option": "Size", "OptionType": 1, "Values": [ { "Option": "Lage", "SkuExt": "-L" }, { "Option": "Medium", "SkuExt": "-M" }, { "Option": "Small", "SkuExt": "-S" } ] } ], "OptionsMap": [ { "Key": "Red|Small", "Checked": true, "ItemId": 154, "Image": "", "ExtSku": "-R-S", "StockLevels": [ ] }, { "Key": "Red|Medium", "Checked": true, "ItemId": 155, "Image": "", "ExtSku": "-R-M", "StockLevels": [ ] }, { "Key": "Red|Lage", "Checked": true, "ItemId": 156, "Image": "", "ExtSku": "-R-L", "StockLevels": [ ] }, { "Key": "Green|Small", "Checked": true, "ItemId": 157, "Image": "", "ExtSku": "-G-S", "StockLevels": [ ] }, { "Key": "Green|Medium", "Checked": true, "ItemId": 158, "Image": "", "ExtSku": "-G-M", "StockLevels": [ ] }, { "Key": "Green|Lage", "Checked": true, "ItemId": 159, "Image": "", "ExtSku": "-G-L", "StockLevels": [ ] }, { "Key": "Blue|Small", "Checked": true, "ItemId": 160, "Image": "", "ExtSku": "-B-S", "StockLevels": [ ] }, { "Key": "Blue|Medium", "Checked": true, "ItemId": 161, "Image": "", "ExtSku": "-B-M", "StockLevels": [ ] }, { "Key": "Blue|Lage", "Checked": true, "ItemId": 162, "Image": "", "ExtSku": "-B-L", "StockLevels": [ ] } ], "Discounts": [ { "Id": 175, "Bonus": null, "End": "9998-12-31T00:00:00.0000000+00:00", "Price": 10, "PriceCurrency": "USD", "Cv": 5, "Qv": 4, "RewardPointsEarned": 0, "Start": "2000-01-01T00:00:00.0000000+00:00", "Type": 1, "Stores": [ 1, 2, 3, 4, 5 ], "OrderType": [ 1, 2 ], "PriceGroups": [ 1, 2 ], "Regions": [ 1 ] } ], "KitGroups": [ { "Name": "Kit Group 1", "Items": [ { "ItemId": 22, "Name": "Kit 1 Item 1", "Quantity": 2 }, { "ItemId": 19, "Name": "Kit 1 Item 2", "Quantity": 1 }, { "ItemId": 97, "Name": "Kit 1 Item 3", "Quantity": 2 } ] }, { "Name": "Kit Group 2", "Items": [ { "ItemId": 20, "Name": "Kit 2 Item 1", "Quantity": 1 }, { "ItemId": 21, "Name": "Kit 2 Item 2", "Quantity": 3 } ] } ], "BillOfMaterials": [ { "ItemId": 19, "Name": "BOM Item 1", "Quantity": 1 }, { "ItemId": 23, "Name": "BOM Item 2", "Quantity": 1 } ], "StockLevels": [ { "WarehouseId": 1, "ItemId": 1, "Avaliable": 100, "Committed": 100, "OnHand": 200, "OnOrder": 0, "OutOfStock": false, "TrackStock": 1 } ] } ] } } }, "500": { "description": "Something went wrong... Here are some possible reasons for this error:\n- Is the model being sent to the API incorrect?\n- Did you forget a required field?\n- Is the API marked as deprecated, and the date has expired?\n\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists." } } } }, "/item/{itemId}/stockLevel/{warehouseId}": { "get": { "tags": [ "Products" ], "summary": "Get Stock Level", "description": "Retrieves Stock Level information for Item based on a valid Item ID and Warehouse ID.\n\nYou can get the **Request Parameters** at these calls:\n\n**itemId**\n- Get Items by Filter\n- Get Item by SKU\n\n**warehouseId**\n- Get Regions", "operationId": "get-stock-level", "parameters": [ { "name": "itemId", "in": "path", "description": "The ID of the Item to retrieve. \n", "required": true, "schema": { "type": "int" } }, { "name": "warehouseId", "in": "path", "description": "The ID of the Warehouse for the given Item to retrieve. ", "required": true, "schema": { "type": "int" } } ], "responses": { "200": { "description": "Returns a valid Stock Level object.", "content": { "application/json": { "example": { "WarehouseId": 1, "ItemId": 1, "Committed": 2, "OnHand": 10, "OnOrder": 3, "TrackStock": 0, "Avaliable": 8 } } } }, "404": { "description": "An Item with the given Item ID or Warehouse ID was not found." }, "500": { "description": "Something went wrong... Here are some possible reasons for this error:\n- Is the model being sent to the API incorrect?\n- Did you forget a required field?\n- Is the API marked as deprecated, and the date has expired?\n\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists." } } } }, "/items/{itemId}/stockLevel": { "put": { "tags": [ "Products" ], "summary": "Update Stock Level", "description": "Sets the On Hand stock level for the given Warehouse and Item.\r\n\r\nYou can get the **Request Parameter** at these calls:\r\n\r\n**itemId**\r\n- Get Item by Id\r\n- Get Items by Filter\r\n- Get Item by SKU\r\n\r\n** warehouseId **\r\n- Get Regions", "operationId": "update-stock-level", "parameters": [ { "name": "itemId", "in": "path", "description": "The ItemId of the item for which you are adjusting stock.", "required": true, "schema": { "type": "int" } } ], "requestBody": { "content": { "application/json": { "example": "{\n \"warehouseId\": 1, // Products: Get Regions\n \"onHand\": 10\n}" } } }, "responses": { "200": { "description": "The stock level for the item was successfully updated." }, "500": { "description": "Something went wrong... Here are some possible reasons for this error:\n- Is the model being sent to the API incorrect?\n- Did you forget a required field?\n- Is the API marked as deprecated, and the date has expired?\n\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists." } } } }, "/categories/{categoryId}/topproducts": { "get": { "summary": "Get Top-selling Products", "description": "Return a list of top-selling items in a particular category. Optional filter parameters will limit translations, prices, and products returned.\n\n**NOTE:** This call runs a sales query to fetch the top-selling products, which is then cached and kept for 4 hours, for each category/region/etc. The first time this call is made, it could take several seconds, but subsequently should only take milliseconds for cache retrieval (until the 4 hours pass).\n\nYou can get the **Request Parameters** at these calls:\n\n**categoryId**\n- Get Categories\n\n**CurrencyCode**\n- Get Regions displays the country/state codes of the warehouses. If you are concerned about having the proper CurrencyCode, then this will allow you to know what region warehouse support team to call to get the confirmed CurrencyCode.\n\n**LanguageCode**\n- Get Item by Id\n- Get Items\n- Get Items by Filter\n\n**RegionID**\n- Get Regions\n\n**PriceGroup**\n- Order: Get Price Group(s)\n\n**StoreID**\n- Get Stores", "operationId": "5e823ee05fcb855a7ea1f293", "parameters": [ { "name": "categoryId", "in": "path", "description": "The Id of the Category whose Items are to be retrieved.", "required": true, "schema": { "type": "string" } }, { "name": "numberOfProducts", "in": "query", "description": "The number of top products to retrieve", "required": true, "schema": { "enum": [ 1 ], "type": "int", "default": 1 } }, { "name": "CurrencyCode", "in": "query", "description": "The 3-character ISO currency code indicating pricing to be returned.", "required": true, "schema": { "enum": [ "usd" ], "type": "string", "default": "usd" } }, { "name": "LanguageCode", "in": "query", "description": "The 2-character ISO language code indicating language of translations.", "required": true, "schema": { "enum": [ "en" ], "type": "string", "default": "en" } }, { "name": "RegionID", "in": "query", "description": "The Region ID, fetched using \"Get Regions\"", "required": true, "schema": { "enum": [ 1 ], "type": "int", "default": 1 } }, { "name": "PriceGroup", "in": "query", "description": "The Price Group ID, fetched using \"Get Price Groups\"", "required": true, "schema": { "enum": [ 1 ], "type": "int", "default": 1 } }, { "name": "StoreID", "in": "query", "description": "The Store ID, fetched using \"Get Stores\"", "required": true, "schema": { "enum": [ 1 ], "type": "int" } }, { "name": "CountryCode", "in": "query", "description": "The Country Code, fetched using \"Get Regions\"", "schema": { "enum": [ "US" ], "type": "string", "default": "US" } } ], "responses": { "200": { "description": "Returns an array of requested top-selling item objects. If the category selected is empty the array will be empty.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryLineItemArray" }, "example": [ { "ItemID": 1, "Quantity": 1, "Cost": 0, "ExtendedPrice": 10, "ExtendedOriginalPrice": 10, "ExtendedBonus": 0, "ExtendedCV": 5, "ExtendedQV": 4, "ExtendedRewardPoints": 0, "ExtendedCost": 0, "ProductName": "Test Item", "Description": "Test Item (description)
", "Specifications": "Test Item (specs)
", "SEO": null, "LanguageCode": "en", "SKU": "DRTSCL", "Category": "Test Category", "CategoryId": 1, "ChargeShipping": true, "Custom": { "ItemId": 0, "Field1": "", "Field2": "", "Field3": "", "Field4": "", "Field5": "" }, "Height": 0, "ImageUrl": "/testitem.jpg", "Length": 0, "LengthUOM": "cm", "MPN": "", "PackCount": 0, "PackageGroupID": 1, "TaxClassID": 0, "UnitOfMeasure": "", "UPC": "", "Weight": 1, "WeightUOM": "kg", "Width": 0, "FlagBirthDefects": false, "HasKitGroups": false, "FlagCancer": false, "PriceGroup": 1, "Price": 10, "CurrencyCode": "usd", "OriginalPrice": 10, "OutOfStockStatus": 1, "Bonus": 0, "CV": 5, "QV": 4, "RewardPoints": 0, "StoreId": 0, "HasOptions": true, "PriceGroups": [ 1 ], "StockLevels": [ { "WarehouseId": 1, "ItemId": 1, "Avaliable": 100, "Committed": 100, "OnHand": 200, "OnOrder": 0, "OutOfStock": false, "TrackStock": 1 } ], "KitGroups": [ { "Name": "Kit Group 1", "Items": [ { "ItemId": 22, "Name": "Kit 1 Item 1", "Quantity": 2 }, { "ItemId": 19, "Name": "Kit 1 Item 2", "Quantity": 1 }, { "ItemId": 97, "Name": "Kit 1 Item 3", "Quantity": 2 } ] }, { "Name": "Kit Group 2", "Items": [ { "ItemId": 20, "Name": "Kit 2 Item 1", "Quantity": 1 }, { "ItemId": 21, "Name": "Kit 2 Item 2", "Quantity": 3 } ] } ], "Images": [ { "Description": "/testitem.jpg", "Path": "/testitem.jpg" } ], "Prices": [ { "PriceGroupId": 1, "Price": 10, "PriceCurrency": "usd", "OriginalPrice": 10, "Bonus": 0, "CV": 5, "QV": 4, "RewardPoints": 0 } ], "ItemOptions": [ { "OptionId": 3, "Option": "Color", "OptionType": 1, "Values": [ { "Option": "Blue", "SkuExt": "-B" }, { "Option": "Green", "SkuExt": "-G" }, { "Option": "Red", "SkuExt": "-R" } ] }, { "OptionId": 4, "Option": "Size", "OptionType": 1, "Values": [ { "Option": "Lage", "SkuExt": "-L" }, { "Option": "Medium", "SkuExt": "-M" }, { "Option": "Small", "SkuExt": "-S" } ] } ], "Languages": [ { "Description": "Test Item (desc)
", "LanguageCode": "en", "ProductName": "Test Item", "SeoKeywords": "", "Specifications": "Test Item (specs)
" } ], "OptionsMap": [ { "Key": "Red|Small", "Checked": true, "ItemId": 154, "Image": "", "ExtSku": "-R-S", "StockLevels": [ ] }, { "Key": "Red|Medium", "Checked": true, "ItemId": 155, "Image": "", "ExtSku": "-R-M", "StockLevels": [ ] }, { "Key": "Red|Lage", "Checked": true, "ItemId": 156, "Image": "", "ExtSku": "-R-L", "StockLevels": [ ] }, { "Key": "Green|Small", "Checked": true, "ItemId": 157, "Image": "", "ExtSku": "-G-S", "StockLevels": [ ] }, { "Key": "Green|Medium", "Checked": true, "ItemId": 158, "Image": "", "ExtSku": "-G-M", "StockLevels": [ ] }, { "Key": "Green|Lage", "Checked": true, "ItemId": 159, "Image": "", "ExtSku": "-G-L", "StockLevels": [ ] }, { "Key": "Blue|Small", "Checked": true, "ItemId": 160, "Image": "", "ExtSku": "-B-S", "StockLevels": [ ] }, { "Key": "Blue|Medium", "Checked": true, "ItemId": 161, "Image": "", "ExtSku": "-B-M", "StockLevels": [ ] }, { "Key": "Blue|Lage", "Checked": true, "ItemId": 162, "Image": "", "ExtSku": "-B-L", "StockLevels": [ ] } ], "BillOfMaterials": [ { "ItemId": 19, "Name": "BOM Item 1", "Quantity": 1 }, { "ItemId": 23, "Name": "BOM Item 2", "Quantity": 1 } ] } ] } } }, "404": { "description": "A Category with the given Category ID was not found." }, "500": { "description": "Something went wrong... Here are some possible reasons for this error:\n- Is the model being sent to the API incorrect?\n- Did you forget a required field?\n- Is the API marked as deprecated, and the date has expired?\n\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists." } } } }, "/warehouses": { "get": { "tags": [ "Products", "Orders", "Packages" ], "summary": "Get Warehouses", "description": "The DirectScale commission engine contains a collection of \"warehouses\". These represent storage locations for products, and are added and configured uniquely for each client. These warehouses receive (or fetch) shipment requests from DirectScale to build packages of product to send out via shipping providers.Test Item (desc)
", "LanguageCode": "en", "ProductName": "Test Item", "SeoKeywords": "", "Specifications": "Test Item (specs)
" } ], "Options": [ { "OptionId": 3, "Option": "Color", "OptionType": 1, "Values": [ { "Option": "Blue", "SkuExt": "-B" }, { "Option": "Green", "SkuExt": "-G" }, { "Option": "Red", "SkuExt": "-R" } ] }, { "OptionId": 4, "Option": "Size", "OptionType": 1, "Values": [ { "Option": "Lage", "SkuExt": "-L" }, { "Option": "Medium", "SkuExt": "-M" }, { "Option": "Small", "SkuExt": "-S" } ] } ], "OptionsMap": [ { "Key": "Red|Small", "Checked": true, "ItemId": 154, "Image": "", "ExtSku": "-R-S", "StockLevels": [ ] }, { "Key": "Red|Medium", "Checked": true, "ItemId": 155, "Image": "", "ExtSku": "-R-M", "StockLevels": [ ] }, { "Key": "Red|Lage", "Checked": true, "ItemId": 156, "Image": "", "ExtSku": "-R-L", "StockLevels": [ ] }, { "Key": "Green|Small", "Checked": true, "ItemId": 157, "Image": "", "ExtSku": "-G-S", "StockLevels": [ ] }, { "Key": "Green|Medium", "Checked": true, "ItemId": 158, "Image": "", "ExtSku": "-G-M", "StockLevels": [ ] }, { "Key": "Green|Lage", "Checked": true, "ItemId": 159, "Image": "", "ExtSku": "-G-L", "StockLevels": [ ] }, { "Key": "Blue|Small", "Checked": true, "ItemId": 160, "Image": "", "ExtSku": "-B-S", "StockLevels": [ ] }, { "Key": "Blue|Medium", "Checked": true, "ItemId": 161, "Image": "", "ExtSku": "-B-M", "StockLevels": [ ] }, { "Key": "Blue|Lage", "Checked": true, "ItemId": 162, "Image": "", "ExtSku": "-B-L", "StockLevels": [ ] } ], "Discounts": [ { "Id": 175, "Bonus": null, "End": "9998-12-31T00:00:00Z", "Price": 10, "PriceCurrency": "USD", "Cv": 5, "Qv": 4, "RewardPointsEarned": 0, "Start": "2000-01-01T00:00:00Z", "Type": 1, "Stores": [ 1, 2, 3, 4, 5 ], "OrderType": [ 1, 2 ], "PriceGroups": [ 1, 2 ], "Regions": [ 1 ] } ], "KitGroups": [ { "Name": "Kit Group 1", "Items": [ { "ItemId": 22, "Name": "Kit 1 Item 1", "Quantity": 2 }, { "ItemId": 19, "Name": "Kit 1 Item 2", "Quantity": 1 }, { "ItemId": 97, "Name": "Kit 1 Item 3", "Quantity": 2 } ] }, { "Name": "Kit Group 2", "Items": [ { "ItemId": 20, "Name": "Kit 2 Item 1", "Quantity": 1 }, { "ItemId": 21, "Name": "Kit 2 Item 2", "Quantity": 3 } ] } ], "BillOfMaterials": [ { "ItemId": 19, "Name": "BOM Item 1", "Quantity": 1 }, { "ItemId": 23, "Name": "BOM Item 2", "Quantity": 1 } ], "StockLevels": [ { "WarehouseId": 1, "ItemId": 1, "Avaliable": 100, "Committed": 100, "OnHand": 200, "OnOrder": 0, "OutOfStock": false, "TrackStock": 1 } ] } }, "InventoryLineItem": { "type": "object", "properties": { "ItemID": { "type": "integer" }, "Quantity": { "type": "integer" }, "Cost": { "type": "integer" }, "ExtendedPrice": { "type": "integer" }, "ExtendedOriginalPrice": { "type": "integer" }, "ExtendedBonus": { "type": "integer" }, "ExtendedCV": { "type": "integer" }, "ExtendedQV": { "type": "integer" }, "ExtendedRewardPoints": { "type": "integer" }, "ExtendedCost": { "type": "integer" }, "ProductName": { "type": "string" }, "Description": { "type": "string" }, "Specifications": { "type": "string" }, "SEO": { }, "LanguageCode": { "type": "string" }, "SKU": { "type": "string" }, "Category": { "type": "string" }, "CategoryId": { "type": "integer" }, "ChargeShipping": { "type": "boolean" }, "Custom": { "type": "object", "properties": { "ItemId": { "type": "integer" }, "Field1": { "type": "string" }, "Field2": { "type": "string" }, "Field3": { "type": "string" }, "Field4": { "type": "string" }, "Field5": { "type": "string" } } }, "Height": { "type": "integer" }, "ImageUrl": { "type": "string" }, "Length": { "type": "integer" }, "LengthUOM": { "type": "string" }, "MPN": { "type": "string" }, "PackCount": { "type": "integer" }, "PackageGroupID": { "type": "integer" }, "TaxClassID": { "type": "integer" }, "UnitOfMeasure": { "type": "string" }, "UPC": { "type": "string" }, "Weight": { "type": "integer" }, "WeightUOM": { "type": "string" }, "Width": { "type": "integer" }, "FlagBirthDefects": { "type": "boolean" }, "HasKitGroups": { "type": "boolean" }, "FlagCancer": { "type": "boolean" }, "PriceGroup": { "type": "integer" }, "Price": { "type": "integer" }, "CurrencyCode": { "type": "string" }, "OriginalPrice": { "type": "integer" }, "OutOfStockStatus": { "type": "integer" }, "Bonus": { "type": "integer" }, "CV": { "type": "integer" }, "QV": { "type": "integer" }, "RewardPoints": { "type": "integer" }, "StoreId": { "type": "integer" }, "HasOptions": { "type": "boolean" }, "PriceGroups": { "type": "array", "items": { "type": "integer" } }, "StockLevels": { "type": "array", "items": { "required": [ "WarehouseId", "ItemId", "Avaliable", "Committed", "OnHand", "OnOrder", "OutOfStock", "TrackStock" ], "type": "object", "properties": { "WarehouseId": { "type": "integer" }, "ItemId": { "type": "integer" }, "Avaliable": { "type": "integer" }, "Committed": { "type": "integer" }, "OnHand": { "type": "integer" }, "OnOrder": { "type": "integer" }, "OutOfStock": { "type": "boolean" }, "TrackStock": { "type": "integer" } } } }, "KitGroups": { "type": "array", "items": { "required": [ "Name", "Items" ], "type": "object", "properties": { "Name": { "type": "string" }, "Items": { "type": "array", "items": { "required": [ "ItemId", "Name", "Quantity" ], "type": "object", "properties": { "ItemId": { "type": "integer" }, "Name": { "type": "string" }, "Quantity": { "type": "integer" } } } } } } }, "Images": { "type": "array", "items": { "required": [ "Description", "Path" ], "type": "object", "properties": { "Description": { "type": "string" }, "Path": { "type": "string" } } } }, "Prices": { "type": "array", "items": { "required": [ "PriceGroupId", "Price", "PriceCurrency", "OriginalPrice", "Bonus", "CV", "QV", "RewardPoints" ], "type": "object", "properties": { "PriceGroupId": { "type": "integer" }, "Price": { "type": "integer" }, "PriceCurrency": { "type": "string" }, "OriginalPrice": { "type": "integer" }, "Bonus": { "type": "integer" }, "CV": { "type": "integer" }, "QV": { "type": "integer" }, "RewardPoints": { "type": "integer" } } } }, "ItemOptions": { "type": "array", "items": { "required": [ "OptionId", "Option", "OptionType", "Values" ], "type": "object", "properties": { "OptionId": { "type": "integer" }, "Option": { "type": "string" }, "OptionType": { "type": "integer" }, "Values": { "type": "array", "items": { "required": [ "Option", "SkuExt" ], "type": "object", "properties": { "Option": { "type": "string" }, "SkuExt": { "type": "string" } } } } } } }, "Languages": { "type": "array", "items": { "required": [ "Description", "LanguageCode", "ProductName", "SeoKeywords", "Specifications" ], "type": "object", "properties": { "Description": { "type": "string" }, "LanguageCode": { "type": "string" }, "ProductName": { "type": "string" }, "SeoKeywords": { "type": "string" }, "Specifications": { "type": "string" } } } }, "OptionsMap": { "type": "array", "items": { "required": [ "Key", "Checked", "ItemId", "Image", "ExtSku", "StockLevels" ], "type": "object", "properties": { "Key": { "type": "string" }, "Checked": { "type": "boolean" }, "ItemId": { "type": "integer" }, "Image": { "type": "string" }, "ExtSku": { "type": "string" }, "StockLevels": { "type": "array" } } } }, "BillOfMaterials": { "type": "array", "items": { "required": [ "ItemId", "Name", "Quantity" ], "type": "object", "properties": { "ItemId": { "type": "integer" }, "Name": { "type": "string" }, "Quantity": { "type": "integer" } } } } }, "example": { "ItemID": 1, "Quantity": 1, "Cost": 0, "ExtendedPrice": 10, "ExtendedOriginalPrice": 10, "ExtendedBonus": 0, "ExtendedCV": 5, "ExtendedQV": 4, "ExtendedRewardPoints": 0, "ExtendedCost": 0, "ProductName": "Test Item", "Description": "Test Item (description)
", "Specifications": "Test Item (specs)
", "SEO": null, "LanguageCode": "en", "SKU": "DRTSCL", "Category": "Test Category", "CategoryId": 1, "ChargeShipping": true, "Custom": { "ItemId": 0, "Field1": "", "Field2": "", "Field3": "", "Field4": "", "Field5": "" }, "Height": 0, "ImageUrl": "/testitem.jpg", "Length": 0, "LengthUOM": "cm", "MPN": "", "PackCount": 0, "PackageGroupID": 1, "TaxClassID": 0, "UnitOfMeasure": "", "UPC": "", "Weight": 1, "WeightUOM": "kg", "Width": 0, "FlagBirthDefects": false, "HasKitGroups": false, "FlagCancer": false, "PriceGroup": 1, "Price": 10, "CurrencyCode": "usd", "OriginalPrice": 10, "OutOfStockStatus": 1, "Bonus": 0, "CV": 5, "QV": 4, "RewardPoints": 0, "StoreId": 0, "HasOptions": true, "PriceGroups": [ 1 ], "StockLevels": [ { "WarehouseId": 1, "ItemId": 1, "Avaliable": 100, "Committed": 100, "OnHand": 200, "OnOrder": 0, "OutOfStock": false, "TrackStock": 1 } ], "KitGroups": [ { "Name": "Kit Group 1", "Items": [ { "ItemId": 22, "Name": "Kit 1 Item 1", "Quantity": 2 }, { "ItemId": 19, "Name": "Kit 1 Item 2", "Quantity": 1 }, { "ItemId": 97, "Name": "Kit 1 Item 3", "Quantity": 2 } ] }, { "Name": "Kit Group 2", "Items": [ { "ItemId": 20, "Name": "Kit 2 Item 1", "Quantity": 1 }, { "ItemId": 21, "Name": "Kit 2 Item 2", "Quantity": 3 } ] } ], "Images": [ { "Description": "/testitem.jpg", "Path": "/testitem.jpg" } ], "Prices": [ { "PriceGroupId": 1, "Price": 10, "PriceCurrency": "usd", "OriginalPrice": 10, "Bonus": 0, "CV": 5, "QV": 4, "RewardPoints": 0 } ], "ItemOptions": [ { "OptionId": 3, "Option": "Color", "OptionType": 1, "Values": [ { "Option": "Blue", "SkuExt": "-B" }, { "Option": "Green", "SkuExt": "-G" }, { "Option": "Red", "SkuExt": "-R" } ] }, { "OptionId": 4, "Option": "Size", "OptionType": 1, "Values": [ { "Option": "Lage", "SkuExt": "-L" }, { "Option": "Medium", "SkuExt": "-M" }, { "Option": "Small", "SkuExt": "-S" } ] } ], "Languages": [ { "Description": "Test Item (desc)
", "LanguageCode": "en", "ProductName": "Test Item", "SeoKeywords": "", "Specifications": "Test Item (specs)
" } ], "OptionsMap": [ { "Key": "Red|Small", "Checked": true, "ItemId": 154, "Image": "", "ExtSku": "-R-S", "StockLevels": [ ] }, { "Key": "Red|Medium", "Checked": true, "ItemId": 155, "Image": "", "ExtSku": "-R-M", "StockLevels": [ ] }, { "Key": "Red|Lage", "Checked": true, "ItemId": 156, "Image": "", "ExtSku": "-R-L", "StockLevels": [ ] }, { "Key": "Green|Small", "Checked": true, "ItemId": 157, "Image": "", "ExtSku": "-G-S", "StockLevels": [ ] }, { "Key": "Green|Medium", "Checked": true, "ItemId": 158, "Image": "", "ExtSku": "-G-M", "StockLevels": [ ] }, { "Key": "Green|Lage", "Checked": true, "ItemId": 159, "Image": "", "ExtSku": "-G-L", "StockLevels": [ ] }, { "Key": "Blue|Small", "Checked": true, "ItemId": 160, "Image": "", "ExtSku": "-B-S", "StockLevels": [ ] }, { "Key": "Blue|Medium", "Checked": true, "ItemId": 161, "Image": "", "ExtSku": "-B-M", "StockLevels": [ ] }, { "Key": "Blue|Lage", "Checked": true, "ItemId": 162, "Image": "", "ExtSku": "-B-L", "StockLevels": [ ] } ], "BillOfMaterials": [ { "ItemId": 19, "Name": "BOM Item 1", "Quantity": 1 }, { "ItemId": 23, "Name": "BOM Item 2", "Quantity": 1 } ] } }, "InventoryLineItemArray": { "type": "array", "items": { "required": [ "ItemID", "Quantity", "Cost", "ExtendedPrice", "ExtendedOriginalPrice", "ExtendedBonus", "ExtendedCV", "ExtendedQV", "ExtendedRewardPoints", "ExtendedCost", "ProductName", "Description", "Specifications", "SEO", "LanguageCode", "SKU", "Category", "CategoryId", "ChargeShipping", "Custom", "Height", "ImageUrl", "Length", "LengthUOM", "MPN", "PackCount", "PackageGroupID", "TaxClassID", "UnitOfMeasure", "UPC", "Weight", "WeightUOM", "Width", "FlagBirthDefects", "HasKitGroups", "FlagCancer", "PriceGroup", "Price", "CurrencyCode", "OriginalPrice", "OutOfStockStatus", "Bonus", "CV", "QV", "RewardPoints", "StoreId", "HasOptions", "PriceGroups", "StockLevels", "KitGroups", "Images", "Prices", "ItemOptions", "Languages", "OptionsMap", "BillOfMaterials" ], "type": "object", "properties": { "ItemID": { "type": "integer" }, "Quantity": { "type": "integer" }, "Cost": { "type": "integer" }, "ExtendedPrice": { "type": "integer" }, "ExtendedOriginalPrice": { "type": "integer" }, "ExtendedBonus": { "type": "integer" }, "ExtendedCV": { "type": "integer" }, "ExtendedQV": { "type": "integer" }, "ExtendedRewardPoints": { "type": "integer" }, "ExtendedCost": { "type": "integer" }, "ProductName": { "type": "string" }, "Description": { "type": "string" }, "Specifications": { "type": "string" }, "SEO": { }, "LanguageCode": { "type": "string" }, "SKU": { "type": "string" }, "Category": { "type": "string" }, "CategoryId": { "type": "integer" }, "ChargeShipping": { "type": "boolean" }, "Custom": { "type": "object", "properties": { "ItemId": { "type": "integer" }, "Field1": { "type": "string" }, "Field2": { "type": "string" }, "Field3": { "type": "string" }, "Field4": { "type": "string" }, "Field5": { "type": "string" } } }, "Height": { "type": "integer" }, "ImageUrl": { "type": "string" }, "Length": { "type": "integer" }, "LengthUOM": { "type": "string" }, "MPN": { "type": "string" }, "PackCount": { "type": "integer" }, "PackageGroupID": { "type": "integer" }, "TaxClassID": { "type": "integer" }, "UnitOfMeasure": { "type": "string" }, "UPC": { "type": "string" }, "Weight": { "type": "integer" }, "WeightUOM": { "type": "string" }, "Width": { "type": "integer" }, "FlagBirthDefects": { "type": "boolean" }, "HasKitGroups": { "type": "boolean" }, "FlagCancer": { "type": "boolean" }, "PriceGroup": { "type": "integer" }, "Price": { "type": "integer" }, "CurrencyCode": { "type": "string" }, "OriginalPrice": { "type": "integer" }, "OutOfStockStatus": { "type": "integer" }, "Bonus": { "type": "integer" }, "CV": { "type": "integer" }, "QV": { "type": "integer" }, "RewardPoints": { "type": "integer" }, "StoreId": { "type": "integer" }, "HasOptions": { "type": "boolean" }, "PriceGroups": { "type": "array", "items": { "type": "integer" } }, "StockLevels": { "type": "array", "items": { "required": [ "WarehouseId", "ItemId", "Avaliable", "Committed", "OnHand", "OnOrder", "OutOfStock", "TrackStock" ], "type": "object", "properties": { "WarehouseId": { "type": "integer" }, "ItemId": { "type": "integer" }, "Avaliable": { "type": "integer" }, "Committed": { "type": "integer" }, "OnHand": { "type": "integer" }, "OnOrder": { "type": "integer" }, "OutOfStock": { "type": "boolean" }, "TrackStock": { "type": "integer" } } } }, "KitGroups": { "type": "array", "items": { "required": [ "Name", "Items" ], "type": "object", "properties": { "Name": { "type": "string" }, "Items": { "type": "array", "items": { "required": [ "ItemId", "Name", "Quantity" ], "type": "object", "properties": { "ItemId": { "type": "integer" }, "Name": { "type": "string" }, "Quantity": { "type": "integer" } } } } } } }, "Images": { "type": "array", "items": { "required": [ "Description", "Path" ], "type": "object", "properties": { "Description": { "type": "string" }, "Path": { "type": "string" } } } }, "Prices": { "type": "array", "items": { "required": [ "PriceGroupId", "Price", "PriceCurrency", "OriginalPrice", "Bonus", "CV", "QV", "RewardPoints" ], "type": "object", "properties": { "PriceGroupId": { "type": "integer" }, "Price": { "type": "integer" }, "PriceCurrency": { "type": "string" }, "OriginalPrice": { "type": "integer" }, "Bonus": { "type": "integer" }, "CV": { "type": "integer" }, "QV": { "type": "integer" }, "RewardPoints": { "type": "integer" } } } }, "ItemOptions": { "type": "array", "items": { "required": [ "OptionId", "Option", "OptionType", "Values" ], "type": "object", "properties": { "OptionId": { "type": "integer" }, "Option": { "type": "string" }, "OptionType": { "type": "integer" }, "Values": { "type": "array", "items": { "required": [ "Option", "SkuExt" ], "type": "object", "properties": { "Option": { "type": "string" }, "SkuExt": { "type": "string" } } } } } } }, "Languages": { "type": "array", "items": { "required": [ "Description", "LanguageCode", "ProductName", "SeoKeywords", "Specifications" ], "type": "object", "properties": { "Description": { "type": "string" }, "LanguageCode": { "type": "string" }, "ProductName": { "type": "string" }, "SeoKeywords": { "type": "string" }, "Specifications": { "type": "string" } } } }, "OptionsMap": { "type": "array", "items": { "required": [ "Key", "Checked", "ItemId", "Image", "ExtSku", "StockLevels" ], "type": "object", "properties": { "Key": { "type": "string" }, "Checked": { "type": "boolean" }, "ItemId": { "type": "integer" }, "Image": { "type": "string" }, "ExtSku": { "type": "string" }, "StockLevels": { "type": "array" } } } }, "BillOfMaterials": { "type": "array", "items": { "required": [ "ItemId", "Name", "Quantity" ], "type": "object", "properties": { "ItemId": { "type": "integer" }, "Name": { "type": "string" }, "Quantity": { "type": "integer" } } } } } } }, "InventoryItemArray": { "type": "array", "items": { "required": [ "Id", "Sku", "KitLevel", "Category", "ChargeShipping", "Disabled", "Height", "Image", "Length", "LengthUnitOfMeasure", "ManufacturerPartNum", "OutOfStockStatus", "PackCount", "PackageGroupId", "PreferedVendorId", "SortOrder", "TaxClassId", "ProductClass", "TrackStock", "UnitOfMeasure", "Upc", "Weight", "WeightUnitOfMeasure", "Width", "FlagCancer", "FlagBirthDefects", "HasKitGroups", "HasOptions", "HsCode", "Custom", "FastStart", "Images", "Languages", "Options", "OptionsMap", "Discounts", "KitGroups", "BillOfMaterials", "StockLevels" ], "type": "object", "properties": { "Id": { "type": "integer" }, "Sku": { "type": "string" }, "KitLevel": { "type": "integer" }, "Category": { "type": "object", "properties": { "Id": { "type": "integer" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "DisplayIndex": { "type": "integer" }, "ImageUrl": { }, "ParentId": { "type": "integer" }, "ProductLineId": { "type": "integer" }, "ShortDescription": { "type": "string" }, "StoreIds": { "type": "array" }, "HasChildren": { "type": "boolean" } } }, "ChargeShipping": { "type": "boolean" }, "Disabled": { "type": "boolean" }, "Height": { "type": "integer" }, "Image": { "type": "string" }, "Length": { "type": "integer" }, "LengthUnitOfMeasure": { "type": "string" }, "ManufacturerPartNum": { "type": "string" }, "OutOfStockStatus": { "type": "integer" }, "PackCount": { "type": "integer" }, "PackageGroupId": { "type": "integer" }, "PreferedVendorId": { "type": "integer" }, "SortOrder": { "type": "integer" }, "TaxClassId": { "type": "integer" }, "ProductClass": { "type": "integer" }, "TrackStock": { "type": "boolean" }, "UnitOfMeasure": { "type": "string" }, "Upc": { "type": "string" }, "Weight": { "type": "integer" }, "WeightUnitOfMeasure": { "type": "string" }, "Width": { "type": "integer" }, "FlagCancer": { "type": "boolean" }, "FlagBirthDefects": { "type": "boolean" }, "HasKitGroups": { "type": "boolean" }, "HasOptions": { "type": "boolean" }, "HsCode": { "type": "string" }, "Custom": { "type": "object", "properties": { "ItemId": { "type": "integer" }, "Field1": { "type": "string" }, "Field2": { "type": "string" }, "Field3": { "type": "string" }, "Field4": { "type": "string" }, "Field5": { "type": "string" } } }, "FastStart": { "type": "object", "properties": { "Gen1": { "type": "integer" }, "Gen2": { "type": "integer" }, "Gen3": { "type": "integer" }, "Gen4": { "type": "integer" }, "Gen5": { "type": "integer" }, "Gen6": { "type": "integer" }, "Gen7": { "type": "integer" }, "Gen8": { "type": "integer" }, "Gen9": { "type": "integer" }, "Gen10": { "type": "integer" } } }, "Images": { "type": "array", "items": { "required": [ "Description", "Path" ], "type": "object", "properties": { "Description": { "type": "string" }, "Path": { "type": "string" } } } }, "Languages": { "type": "array", "items": { "required": [ "Description", "LanguageCode", "ProductName", "SeoKeywords", "Specifications" ], "type": "object", "properties": { "Description": { "type": "string" }, "LanguageCode": { "type": "string" }, "ProductName": { "type": "string" }, "SeoKeywords": { "type": "string" }, "Specifications": { "type": "string" } } } }, "Options": { "type": "array", "items": { "required": [ "OptionId", "Option", "OptionType", "Values" ], "type": "object", "properties": { "OptionId": { "type": "integer" }, "Option": { "type": "string" }, "OptionType": { "type": "integer" }, "Values": { "type": "array", "items": { "required": [ "Option", "SkuExt" ], "type": "object", "properties": { "Option": { "type": "string" }, "SkuExt": { "type": "string" } } } } } } }, "OptionsMap": { "type": "array", "items": { "required": [ "Key", "Checked", "ItemId", "Image", "ExtSku", "StockLevels" ], "type": "object", "properties": { "Key": { "type": "string" }, "Checked": { "type": "boolean" }, "ItemId": { "type": "integer" }, "Image": { "type": "string" }, "ExtSku": { "type": "string" }, "StockLevels": { "type": "array" } } } }, "Discounts": { "type": "array", "items": { "required": [ "Id", "Bonus", "End", "Price", "PriceCurrency", "Cv", "Qv", "RewardPointsEarned", "Start", "Type", "Stores", "OrderType", "PriceGroups", "Regions" ], "type": "object", "properties": { "Id": { "type": "integer" }, "Bonus": { }, "End": { "type": "string" }, "Price": { "type": "integer" }, "PriceCurrency": { "type": "string" }, "Cv": { "type": "integer" }, "Qv": { "type": "integer" }, "RewardPointsEarned": { "type": "integer" }, "Start": { "type": "string" }, "Type": { "type": "integer" }, "Stores": { "type": "array", "items": { "type": "integer" } }, "OrderType": { "type": "array", "items": { "type": "integer" } }, "PriceGroups": { "type": "array", "items": { "type": "integer" } }, "Regions": { "type": "array", "items": { "type": "integer" } } } } }, "KitGroups": { "type": "array", "items": { "required": [ "Name", "Items" ], "type": "object", "properties": { "Name": { "type": "string" }, "Items": { "type": "array", "items": { "required": [ "ItemId", "Name", "Quantity" ], "type": "object", "properties": { "ItemId": { "type": "integer" }, "Name": { "type": "string" }, "Quantity": { "type": "integer" } } } } } } }, "BillOfMaterials": { "type": "array", "items": { "required": [ "ItemId", "Name", "Quantity" ], "type": "object", "properties": { "ItemId": { "type": "integer" }, "Name": { "type": "string" }, "Quantity": { "type": "integer" } } } }, "StockLevels": { "type": "array", "items": { "required": [ "WarehouseId", "ItemId", "Avaliable", "Committed", "OnHand", "OnOrder", "OutOfStock", "TrackStock" ], "type": "object", "properties": { "WarehouseId": { "type": "integer" }, "ItemId": { "type": "integer" }, "Avaliable": { "type": "integer" }, "Committed": { "type": "integer" }, "OnHand": { "type": "integer" }, "OnOrder": { "type": "integer" }, "OutOfStock": { "type": "boolean" }, "TrackStock": { "type": "integer" } } } } } }, "example": [ { "Id": 1, "Sku": "DRTSCL", "KitLevel": 0, "Category": { "Id": 1, "Name": "Test Category", "Description": "Test Category", "DisplayIndex": 0, "ImageUrl": null, "ParentId": 0, "ProductLineId": 0, "ShortDescription": "Test Category", "StoreIds": [ ], "HasChildren": false }, "ChargeShipping": true, "Disabled": false, "Height": 0, "Image": "/testitem.jpg", "Length": 0, "LengthUnitOfMeasure": "cm", "ManufacturerPartNum": "", "OutOfStockStatus": 1, "PackCount": 0, "PackageGroupId": 1, "PreferedVendorId": 0, "SortOrder": 0, "TaxClassId": 0, "ProductClass": 1, "TrackStock": true, "UnitOfMeasure": "", "Upc": "", "Weight": 1, "WeightUnitOfMeasure": "kg", "Width": 0, "FlagCancer": false, "FlagBirthDefects": false, "HasKitGroups": false, "HasOptions": true, "HsCode": "", "Custom": { "ItemId": 0, "Field1": "", "Field2": "", "Field3": "", "Field4": "", "Field5": "" }, "FastStart": { "Gen1": 0, "Gen2": 0, "Gen3": 0, "Gen4": 0, "Gen5": 0, "Gen6": 0, "Gen7": 0, "Gen8": 0, "Gen9": 0, "Gen10": 0 }, "Images": [ { "Description": "/testitem.jpg", "Path": "/testitem.jpg" } ], "Languages": [ { "Description": "", "LanguageCode": "ab", "ProductName": "", "SeoKeywords": "", "Specifications": "" }, { "Description": "Test Item (desc)
", "LanguageCode": "en", "ProductName": "Test Item", "SeoKeywords": "", "Specifications": "Test Item (specs)
" } ], "Options": [ { "OptionId": 3, "Option": "Color", "OptionType": 1, "Values": [ { "Option": "Blue", "SkuExt": "-B" }, { "Option": "Green", "SkuExt": "-G" }, { "Option": "Red", "SkuExt": "-R" } ] }, { "OptionId": 4, "Option": "Size", "OptionType": 1, "Values": [ { "Option": "Lage", "SkuExt": "-L" }, { "Option": "Medium", "SkuExt": "-M" }, { "Option": "Small", "SkuExt": "-S" } ] } ], "OptionsMap": [ { "Key": "Red|Small", "Checked": true, "ItemId": 154, "Image": "", "ExtSku": "-R-S", "StockLevels": [ ] }, { "Key": "Red|Medium", "Checked": true, "ItemId": 155, "Image": "", "ExtSku": "-R-M", "StockLevels": [ ] }, { "Key": "Red|Lage", "Checked": true, "ItemId": 156, "Image": "", "ExtSku": "-R-L", "StockLevels": [ ] }, { "Key": "Green|Small", "Checked": true, "ItemId": 157, "Image": "", "ExtSku": "-G-S", "StockLevels": [ ] }, { "Key": "Green|Medium", "Checked": true, "ItemId": 158, "Image": "", "ExtSku": "-G-M", "StockLevels": [ ] }, { "Key": "Green|Lage", "Checked": true, "ItemId": 159, "Image": "", "ExtSku": "-G-L", "StockLevels": [ ] }, { "Key": "Blue|Small", "Checked": true, "ItemId": 160, "Image": "", "ExtSku": "-B-S", "StockLevels": [ ] }, { "Key": "Blue|Medium", "Checked": true, "ItemId": 161, "Image": "", "ExtSku": "-B-M", "StockLevels": [ ] }, { "Key": "Blue|Lage", "Checked": true, "ItemId": 162, "Image": "", "ExtSku": "-B-L", "StockLevels": [ ] } ], "Discounts": [ { "Id": 175, "Bonus": null, "End": "9998-12-31T00:00:00Z", "Price": 10, "PriceCurrency": "USD", "Cv": 5, "Qv": 4, "RewardPointsEarned": 0, "Start": "2000-01-01T00:00:00Z", "Type": 1, "Stores": [ 1, 2, 3, 4, 5 ], "OrderType": [ 1, 2 ], "PriceGroups": [ 1, 2 ], "Regions": [ 1 ] } ], "KitGroups": [ { "Name": "Kit Group 1", "Items": [ { "ItemId": 22, "Name": "Kit 1 Item 1", "Quantity": 2 }, { "ItemId": 19, "Name": "Kit 1 Item 2", "Quantity": 1 }, { "ItemId": 97, "Name": "Kit 1 Item 3", "Quantity": 2 } ] }, { "Name": "Kit Group 2", "Items": [ { "ItemId": 20, "Name": "Kit 2 Item 1", "Quantity": 1 }, { "ItemId": 21, "Name": "Kit 2 Item 2", "Quantity": 3 } ] } ], "BillOfMaterials": [ { "ItemId": 19, "Name": "BOM Item 1", "Quantity": 1 }, { "ItemId": 23, "Name": "BOM Item 2", "Quantity": 1 } ], "StockLevels": [ { "WarehouseId": 1, "ItemId": 1, "Avaliable": 100, "Committed": 100, "OnHand": 200, "OnOrder": 0, "OutOfStock": false, "TrackStock": 1 } ] } ] } }, "securitySchemes": { "apiKeyHeader": { "type": "apiKey", "name": "Ocp-Apim-Subscription-Key", "in": "header" }, "apiKeyQuery": { "type": "apiKey", "name": "subscription-key", "in": "query" } } }, "security": [ { "apiKeyHeader": [ ] }, { "apiKeyQuery": [ ] } ] }