List stores, categories, and items configured in the Direct Scale Commission Engine.Get a list of categories to a specific store.
You can get the **Request Parameter** at this call:
**storeId**
- Get Stores
The ID of the Store whose Categories are to be retrieved.Returns an array of valid Category objects.[
{
"ID": 1,
"Name": "Test Category",
"Description": "",
"ImageUrl": null,
"ParentID": 0,
"HasChildren": false,
"SubCategories": null
},
{
"ID": 115,
"Name": "Category Trace",
"Description": "",
"ImageUrl": null,
"ParentID": 0,
"HasChildren": false,
"SubCategories": null
},
{
"ID": 116,
"Name": "Category Trace 2",
"Description": "",
"ImageUrl": null,
"ParentID": 0,
"HasChildren": false,
"SubCategories": null
}
]A Store with the given Store ID was not found.Something went wrong... Here are some possible reasons for this error:
- Is the model being sent to the API incorrect?
- Did you forget a required field?
- Is the API marked as deprecated, and the date has expired?
If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.Retrieves an Item based on a valid Item ID.
You can get the **Request Parameter** at these calls:
**itemId**
- Get Items by Filter
- Get Item by SKU
- Get Items
<br><br>
The full Image path for the item is on the Disco application server, at this URL:
https://<clientID>.corpadmin.directscale<env>.com/CMS/Images/Inventory/
<br><br>
The "Discounts" array is a collection of all the prices. The "Type" field is an enumeration, "Discount, Price, RewardCost". So, if it's "0", it's the discounted price. If it's "1", it's the original price. If it's "2", it's the Reward Point cost.
<br><br>
What's happening here is that you have Type => 1 (Price) and Type => 0 (Discount), so you can show both prices (with a slash through the full price). The Id of the Item to retrieve. Returns a valid Item object.{
"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": "<p>Test Item (desc)</p>",
"LanguageCode": "en",
"ProductName": "Test Item",
"SeoKeywords": "",
"Specifications": "<p>Test Item (specs)</p>"
}
],
"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+00:00",
"Price": 10,
"PriceCurrency": "USD",
"Cv": 5,
"Qv": 4,
"RewardPointsEarned": 0,
"Start": "2000-01-01T00:00:00+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
}
]
}An Item with the given Item ID was not found.Something went wrong... Here are some possible reasons for this error:
- Is the model being sent to the API incorrect?
- Did you forget a required field?
- Is the API marked as deprecated, and the date has expired?
If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.Retrieves an Item based on a valid Item Stock Keeping Unit (SKU).
You can get the **Request Parameters** at these calls:
**sku**
- Get Item by Id
- Get Items
- Get Items by Filter
**CurrencyCode**
- **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**.
**LanguageCode**
- Get Item by Id
- Get Items
- Get Items by Filter
**Note:**
The full Image path for the item is on the Disco application server, at this URL:
https://<clientID>.corpadmin.directscale<env>.com/CMS/Images/Inventory/
<br><br>
The "Discounts" array is a collection of all the prices. The "Type" field is an enumeration, "Discount, Price, RewardCost". So, if it's "0", it's the discounted price. If it's "1", it's the original price. If it's "2", it's the Reward Point cost.
<br><br>
What's happening here is that you have Type => 1 (Price) and Type => 0 (Discount), so you can show both prices (with a slash through the full price).The SKU of the Item to retrieve. The 3-character ISO currency code indicating pricing to be returned.The 2-character ISO language code indicating language of translations.Returns a valid Item object.{
"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": "<p>Test Item (desc)</p>",
"LanguageCode": "en",
"ProductName": "Test Item",
"SeoKeywords": "",
"Specifications": "<p>Test Item (specs)</p>"
}
],
"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+00:00",
"Price": 10,
"PriceCurrency": "USD",
"Cv": 5,
"Qv": 4,
"RewardPointsEarned": 0,
"Start": "2000-01-01T00:00:00+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
}
]
}An Item with the given Item SKU was not found.Something went wrong... Here are some possible reasons for this error:
- Is the model being sent to the API incorrect?
- Did you forget a required field?
- Is the API marked as deprecated, and the date has expired?
If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.Return all items in a given country and category. Optional filter parameters will limit translations, prices, and products returned.
**Note:**
The full Image path for the item is on the Disco application server, at this URL:
https://\<clientId\>.corpadmin.directscale<env>.com/CMS/Images/Inventory/
<br><br>
The "Discounts" array is a collection of all the prices. The "Type" field is an enumeration, "Discount, Price, RewardCost". So, if it's "0", it's the discounted price. If it's "1", it's the original price. If it's "2", it's the Reward Point cost.
<br><br>
What's happening here is that you have Type => 1 (Price) and Type => 0 (Discount), so you can show both prices (with a slash through the full price).
<br><br>
You can get the **Request Parameters** at these calls:
**categoryId**
- Get Categories
**CurrencyCode**
- **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**.
**LanguageCode**
- Get Item by Id
- Get Items
- Get Items by Filter
**RegionID**
- Get Regions
**PriceGroup**
- Order: Get Price Group(s)
**StoreID**
- Get StoresThe Id of the Category whose Items are to be retrieved.The 3-character ISO currency code indicating pricing to be returned.The 2-character ISO language code indicating language of translations.The Region ID, fetched using "Get Regions"The Price Group ID, fetched using "Get Price Groups"The Store ID, fetched using "Get Stores"Returns an array of valid Item objects.[
{
"ItemID": 1,
"Quantity": 1,
"Cost": 0,
"ExtendedPrice": 10,
"ExtendedOriginalPrice": 10,
"ExtendedBonus": 0,
"ExtendedCV": 5,
"ExtendedQV": 4,
"ExtendedRewardPoints": 0,
"ExtendedCost": 0,
"ProductName": "Test Item",
"Description": "<p>Test Item (description)</p>",
"Specifications": "<p>Test Item (specs)</p>",
"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": "<p>Test Item (desc)</p>",
"LanguageCode": "en",
"ProductName": "Test Item",
"SeoKeywords": "",
"Specifications": "<p>Test Item (specs)</p>"
}
],
"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
}
]
}
]A Category with the given Category ID was not found.Something went wrong... Here are some possible reasons for this error:
- Is the model being sent to the API incorrect?
- Did you forget a required field?
- Is the API marked as deprecated, and the date has expired?
If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.Retrieves an array of Regions.<br/><br/>Returns an array of valid Region objects.[
{
"ID": 10,
"Name": "Test Region",
"WarehouseID": 21,
"CountryList": [],
"Locale": []
},
{
"ID": 4,
"Name": "Europe",
"WarehouseID": 1,
"CountryList": [
{
"CountryCode": "hu",
"StateCodes": [
"BE",
"BU",
"BZ"
],
"IsAllStates": false
}
],
"Locale": [
{
"StateCode": "BE",
"CountryCode": "hu"
},
{
"StateCode": "BU",
"CountryCode": "hu"
},
{
"StateCode": "BZ",
"CountryCode": "hu"
}
]
}
]Something went wrong... Here are some possible reasons for this error:
- Is the model being sent to the API incorrect?
- Did you forget a required field?
- Is the API marked as deprecated, and the date has expired?
If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.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.<br/><br/>Returns an array of valid Store objects.[
{
"ID": 1,
"Description": "Corporate"
},
{
"ID": 2,
"Description": "Wholesale"
}
]Something went wrong... Here are some possible reasons for this error:
- Is the model being sent to the API incorrect?
- Did you forget a required field?
- Is the API marked as deprecated, and the date has expired?
If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.Retrieves an array of Sub Categories.<br/><br/>
You can get the **Request Parameter** at this call:
**categoryId**
- Get CategoriesThe ID of the Category whose Sub Categories are to be retrieved.Returns an array of valid Sub Category objects.[
{
"ID": 4,
"Name": "Cameras",
"Description": "",
"ImageUrl": "/canon_eos_5d_2.jpg",
"ParentID": 2,
"HasChildren": false,
"SubCategories": null
},
{
"ID": 11,
"Name": "Apple",
"Description": "",
"ImageUrl": "",
"ParentID": 2,
"HasChildren": false,
"SubCategories": null
}
]A Category with the given Category ID was not found.Something went wrong... Here are some possible reasons for this error:
- Is the model being sent to the API incorrect?
- Did you forget a required field?
- Is the API marked as deprecated, and the date has expired?
If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.Delete an inventory item.
You can get the **Request Parameter** at these calls:
**itemId**
- Get Items by Filter
- Get Item by SKUThe Id of the item to delete.The item is successfully deleted.Item not found.Creates a new inventory item.
**WARNING:** This call does **not** have validation, so as long as the array variables are present, the call will create the desired item, no matter the fields missing.{
"Sku": "TEST01",
"KitLevel": 0,
"Category": {
"Id": 1 //Call GetCategories for Options
},
"ChargeShipping": true,
"Disabled": false,
"Height": 0.0,
"Image": "/path_to_image.jpg",
"Length": 0.0,
"LengthUnitOfMeasure": "cm", // in | cm | mm
"ManufacturerPartNum": "1896",
"OutOfStockStatus": 1, // 1: In Stock | 2: 2-3 Days | 3: Out Of Stock | 4: Pre-Order
"PackCount": 4.0,
"PackageGroupId": 1, // 1: Standard
"PreferedVendorId": 0,
"SortOrder": 0,
"TaxClassId": 0,
"ProductClass": 1, // 1: Standard Item | 2: Raw Material
"TrackStock": true,
"UnitOfMeasure": "lb", // ea | kg | gr | lb | oz | cm | mm | in | ft | yd
"Upc": "2319", // Universal Product Code
"Weight": 0.0,
"WeightUnitOfMeasure": "oz", // kg | gr | lb | oz
"Width": 0.0,
"FlagCancer": false,
"FlagBirthDefects": false,
"HasKitGroups": false,
"HsCode": "1040", // Harmonized Tariff Commodity Code
"FastStart": {
"Gen1": 0,
"Gen2": 0,
"Gen3": 0,
"Gen4": 0,
"Gen5": 0,
"Gen6": 0,
"Gen7": 0,
"Gen8": 0,
"Gen9": 0,
"Gen10": 0
},
"Images": [{
"Description": "string",
"Path": "string"
}
],
"Custom": {
"Field1": "Custom Content",
"Field5": "In fields 1-5"
},
"Languages": [{
"Description": "Description",
"LanguageCode": "en",
"ProductName": "Product",
"SeoKeywords": null,
"Specifications": "Specification"
}
],
"Options": [{
"Option": "Option Category Name",
"OptionType": 1, // 1: Standard
"Values": [{
"Option": "Option Name",
"SkuExt": "OPTION_SKU"
}
]
}
],
"OptionsMap": [], // Keep this as an empty array
"Discounts": [{
"Bonus": 0.00, // Nullable
"End": "01-01-9999",
"Price": 0.00,
"PriceCurrency": "usd",
"Cv": 0.0,
"Qv": 0.0,
"RewardPointsEarned": 0.0,
"Start": "01-01-1900",
"Type": "Discount | Price",
"Stores": [
1 // Call GetStores for Options
],
"OrderType": [
0 // 0: Corporate | 1: Wholesale | 2: Retail | 3: Enroll | 4: AutoShip | 5: Rewards | 6: Party
],
"PriceGroups": [
0 // 0: Stylist | 1: Customer | 2: Preferred Customer
],
"Regions": [
0 // Call GetRegions for Options
]
}
]
}
{
"Category": { },
"FastStart": { },
"Images": [{ }],
"Languages": [{ }],
"Options": [{
"Values": [{ }]
}],
"OptionsMap": [], // Keep this as an empty array
"Discounts": [{
"Start": "01-01-1900",
"Stores": [],
"OrderType": [],
"PriceGroups": [],
"Regions": []
}]
}
The new item was created successfully.Update an existing inventory item.
You can get the **Request Parameter** at this call:
**itemId**
- Get Item by Id
- Get Item by SKU
- Get Items by FilterThe Id of the item to update.{
"Sku": "TEST01",
"KitLevel": 0,
"Category": {
"Id": 1 //Call GetCategories for Options
},
"ChargeShipping": true,
"Disabled": false,
"Height": 0.0,
"Image": "/path_to_image.jpg",
"Length": 0.0,
"LengthUnitOfMeasure": "cm", // in | cm | mm
"ManufacturerPartNum": "1896",
"OutOfStockStatus": 1, // 1: In Stock | 2: 2-3 Days | 3: Out Of Stock | 4: Pre-Order
"PackCount": 4.0,
"PackageGroupId": 1, // 1: Standard
"PreferedVendorId": 0,
"SortOrder": 0,
"TaxClassId": 0,
"ProductClass": 1, // 1: Standard Item | 2: Raw Material
"TrackStock": true,
"UnitOfMeasure": "lb", // ea | kg | gr | lb | oz | cm | mm | in | ft | yd
"Upc": "2319", // Universal Product Code
"Weight": 0.0,
"WeightUnitOfMeasure": "oz", // kg | gr | lb | oz
"Width": 0.0,
"FlagCancer": false,
"FlagBirthDefects": false,
"HasKitGroups": false,
"HsCode": "1040", // Harmonized Tariff Commodity Code
"FastStart": {
"Gen1": 0,
"Gen2": 0,
"Gen3": 0,
"Gen4": 0,
"Gen5": 0,
"Gen6": 0,
"Gen7": 0,
"Gen8": 0,
"Gen9": 0,
"Gen10": 0
},
"Images": [{
"Description": "string",
"Path": "string"
}
],
"Custom": {
"Field1": "Custom Content",
"Field5": "In fields 1-5"
},
"Languages": [{
"Description": "Description",
"LanguageCode": "en",
"ProductName": "Product",
"SeoKeywords": null,
"Specifications": "Specification"
}
],
"Options": [{
"Option": "Option Category Name",
"OptionType": 1, // 1: Standard
"Values": [{
"Option": "Option Name",
"SkuExt": "OPTION_SKU"
}
]
}
],
"OptionsMap": [], // Keep this as an empty array
"Discounts": [{
"Bonus": 0.00, // Nullable
"End": "01-01-9999",
"Price": 0.00,
"PriceCurrency": "usd",
"Cv": 0.0,
"Qv": 0.0,
"RewardPointsEarned": 0.0,
"Start": "01-01-1900",
"Type": "Discount | Price",
"Stores": [
1 // Call GetStores for Options
],
"OrderType": [
0 // 0: Corporate | 1: Wholesale | 2: Retail | 3: Enroll | 4: AutoShip | 5: Rewards | 6: Party
],
"PriceGroups": [
0 // 0: Stylist | 1: Customer | 2: Preferred Customer
],
"Regions": [
0 // Call GetRegions for Options
]
}
]
}
The item was successfully updated.Retrieves Stock Level information for Item based on a valid Item ID and Warehouse ID.
You can get the **Request Parameters** at these calls:
**itemId**
- Get Items by Filter
- Get Item by SKU
**warehouseId**
- Get RegionsThe ID of the Item to retrieve.
The ID of the Warehouse for the given Item to retrieve. Returns a valid Stock Level object.{
"WarehouseId": 1,
"ItemId": 1,
"Committed": 2,
"OnHand": 10,
"OnOrder": 3,
"TrackStock": 0,
"Avaliable": 8
}An Item with the given Item ID or Warehouse ID was not found.Something went wrong... Here are some possible reasons for this error:
- Is the model being sent to the API incorrect?
- Did you forget a required field?
- Is the API marked as deprecated, and the date has expired?
If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.Sets the On Hand stock level for the given Warehouse and Item.
You can get the **Request Parameter** at these calls:
**itemId**
- Get Item by Id
- Get Items by Filter
- Get Item by SKU
** warehouseId **
- Get RegionsThe ItemId of the item for which you are adjusting stock.{
"warehouseId": 1, // Products: Get Regions
"onHand": 10
}The stock level for the item was successfully updated.Something went wrong... Here are some possible reasons for this error:
- Is the model being sent to the API incorrect?
- Did you forget a required field?
- Is the API marked as deprecated, and the date has expired?
If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.Return an array of all available items.<br/><br/>
**Note:**
The full Image path for the item is on the Disco application server, at this URL:
https://<clientID>.corpadmin.directscale<env>.com/CMS/Images/Inventory/
<br><br>
The "Discounts" array is a collection of all the prices. The "Type" field is an enumeration, "Discount, Price, RewardCost". So, if it's "0", it's the discounted price. If it's "1", it's the original price. If it's "2", it's the Reward Point cost.
<br><br>
What's happening here is that you have Type => 1 (Price) and Type => 0 (Discount), so you can show both prices (with a slash through the full price).Returns an array of all Item objects.[
{
"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": "<p>Test Item (desc)</p>",
"LanguageCode": "en",
"ProductName": "Test Item",
"SeoKeywords": "",
"Specifications": "<p>Test Item (specs)</p>"
}
],
"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+00:00",
"Price": 10,
"PriceCurrency": "USD",
"Cv": 5,
"Qv": 4,
"RewardPointsEarned": 0,
"Start": "2000-01-01T00:00:00+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
}
]
}
]Something went wrong... Here are some possible reasons for this error:
- Is the model being sent to the API incorrect?
- Did you forget a required field?
- Is the API marked as deprecated, and the date has expired?
If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.Return a list of top-selling items in a particular category. Optional filter parameters will limit translations, prices, and products returned.
**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).
You can get the **Request Parameters** at these calls:
**categoryId**
- Get Categories
**CurrencyCode**
- 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.
**LanguageCode**
- Get Item by Id
- Get Items
- Get Items by Filter
**RegionID**
- Get Regions
**PriceGroup**
- Order: Get Price Group(s)
**StoreID**
- Get StoresThe Id of the Category whose Items are to be retrieved.The Country Code, fetched using "Get Regions"The number of top products to retrieveThe 3-character ISO currency code indicating pricing to be returned.The 2-character ISO language code indicating language of translations.The Region ID, fetched using "Get Regions"The Price Group ID, fetched using "Get Price Groups"The Store ID, fetched using "Get Stores"Returns an array of requested top-selling item objects. If the category selected is empty the array will be empty.[
{
"ItemID": 1,
"Quantity": 1,
"Cost": 0,
"ExtendedPrice": 10,
"ExtendedOriginalPrice": 10,
"ExtendedBonus": 0,
"ExtendedCV": 5,
"ExtendedQV": 4,
"ExtendedRewardPoints": 0,
"ExtendedCost": 0,
"ProductName": "Test Item",
"Description": "<p>Test Item (description)</p>",
"Specifications": "<p>Test Item (specs)</p>",
"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": "<p>Test Item (desc)</p>",
"LanguageCode": "en",
"ProductName": "Test Item",
"SeoKeywords": "",
"Specifications": "<p>Test Item (specs)</p>"
}
],
"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
}
]
}
]A Category with the given Category ID was not found.Something went wrong... Here are some possible reasons for this error:
- Is the model being sent to the API incorrect?
- Did you forget a required field?
- Is the API marked as deprecated, and the date has expired?
If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.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. <br><br>
This call returns all warehouses configured in the system, including a warehouse ID to be used in Shipping calls, and order creation calls.Returns an array of Warehouse objects.[
{
"ID": 31,
"Name": "Costa Rica",
"Phone": "",
"Manager": "",
"Address": {
"ID": 1387971,
"Line1": "142 Provincia de Alajuela ",
"Line2": "",
"Line3": "",
"City": "San Carlos",
"State": "Alajuela",
"Zip": "21006",
"CountryCode": "cr"
}
},
{
"ID": 1,
"Name": "Enlinx",
"Phone": "",
"Manager": "",
"Address": {
"ID": 1252581,
"Line1": "6077 W Wells Park Road",
"Line2": "",
"Line3": "",
"City": "West Jordan",
"State": "UT",
"Zip": "84081",
"CountryCode": "us"
}
}
]Something went wrong... Here are some possible reasons for this error:
- Is the model being sent to the API incorrect?
- Did you forget a required field?
- Is the API marked as deprecated, and the date has expired?
If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.