Products
API change historyList stores, categories, and items configured in the Direct Scale Commission Engine.
Update Item
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 Filter
Request
Request URL
Request parameters
-
int
The Id of the item to update.
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
{
"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
]
}
]
}
Responses
200 OK
The item was successfully updated.
500 Internal Server Error
Code samples
@ECHO OFF
curl -v -X PUT "https://dsapi-stage.directscale.com/v1/products/items/{itemId}"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://dsapi-stage.directscale.com/v1/products/items/{itemId}?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PutAsync(uri, content);
}
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://dsapi-stage.directscale.com/v1/products/items/{itemId}");
URI uri = builder.build();
HttpPut request = new HttpPut(uri);
request.setHeader("Content-Type", "application/json");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://dsapi-stage.directscale.com/v1/products/items/{itemId}?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "PUT",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://dsapi-stage.directscale.com/v1/products/items/{itemId}";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"PUT"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://dsapi-stage.directscale.com/v1/products/items/{itemId}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_PUT);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('dsapi-stage.directscale.com')
conn.request("PUT", "/v1/products/items/{itemId}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('dsapi-stage.directscale.com')
conn.request("PUT", "/v1/products/items/{itemId}?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://dsapi-stage.directscale.com/v1/products/items/{itemId}')
request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body