View All Methods in this API


Version 1 This method is used to update a product along with its categories, inventory and pricing.

For non required fields, you can either omit from the JSON string or set it to a default value
(e.g. String = "", Integer/Double = 0, Boolean = false, DateTime = 1900-01-01T00:00:00.000Z)


Name Type Description Required
{"auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "", "timezone_offset": 0, "auth_type": "", "system_name": "", "system_company_no": 0 }, "product": {"product": <wi_product>, "pricing": <ArrayOfwi_product_pricing>, "inventory": <ArrayOfwi_product_inventory>, "relations": <ArrayOfminiProduct>, "attributes": <ArrayOfwi_attribute>, "categories": <ArrayOfwi_category_assign>, "media": <ArrayOfwi_media>, "variations": <ArrayOfminiProduct>, "updateIfExists": false } }
{"auth": {"api_username": "", "api_password": "", "api_key": "", "company_no": 0, "username": "", "password": "" }, "product": {"product": <wi_product> } }


By default, every API call returns an object of returnMessage as either XML or JSON depending on your content-type of the request.  With in the returnMessage structure the returnObject is specified above and differs based on the API meth.

Name Type Description
responseCode String This identifies the error that occurred for additional handling. Response codes starting with "A" are a success or "E" are an error.
message String Additional minor details on the response to display to your customers.
isError Boolean True if an error. False if succesful.
methodFailed String If there's an error, this is the method it failed at for debugging purposes.
extendedMessage String Additional instructions on how you can fix the error or what you can do with the return object.
reason String Explains why this error occurred or what was completed.
reponseTime Double How long it took to respond in seconds.
returnObject createStatus
{"responseCode": "", "message": "", "isError": false, "methodFailed": "", "extendedMessage": "", "reason": "", "responseTime": 0, "returnObject": {} }

Sample Code

This sample code is to generate a function leveraging existing core functions you've already built.

func getAPIKit() -> (url: String, dict: Dictionary<String, AnyObject>) {

    var product = <wi_product>
    var pricing = <ArrayOfwi_product_pricing>
    var inventory = <ArrayOfwi_product_inventory>
    var relations = <ArrayOfminiProduct>
    var attributes = <ArrayOfwi_attribute>
    var categories = <ArrayOfwi_category_assign>
    var media = <ArrayOfwi_media>
    var variations = <ArrayOfminiProduct>
    var updateIfExists = false

    let url = ""
    let key = "product"
    let productDict: Dictionary<String, AnyObject> = ["product": product, "pricing": pricing, "inventory": inventory, "relations": relations, "attributes": attributes, "categories": categories, "media": media, "variations": variations, "updateIfExists": updateIfExists ]
    let finalDict = User.getAuthDict(dictToAdd: productDict, dictKey: key)
    return (url, finalDict)


To get started we reccomend that you download the Alamofire project to simplify integration:, in addition to SwiftyJSON:

import Foundation

struct AUTH {
    static var api_username = <string>
    static var api_password = <string>
    static var api_key = <string>
    static var company_no = <double>
    static var username = <string>
    static var password = <string>
    static var timezone_offset = <double>
    static var auth_type = <string>
    static var system_name = <string>
    static var system_company_no = <double>}
struct PRODUCT {
    static var product = <wi_product>
    static var pricing = <ArrayOfwi_product_pricing>
    static var inventory = <ArrayOfwi_product_inventory>
    static var relations = <ArrayOfminiProduct>
    static var attributes = <ArrayOfwi_attribute>
    static var categories = <ArrayOfwi_category_assign>
    static var media = <ArrayOfwi_media>
    static var variations = <ArrayOfminiProduct>
    static var updateIfExists = <boolean>}
func updateProductRequest() {
    var updateProductObjects = [AnyObject]()
    let postsEndpoint: String = ""

    let authAndFieldsDict = ["auth": ["api_username": AUTH.api_username, "api_password": AUTH.api_password, "api_key": AUTH.api_key, "company_no": AUTH.company_no, "username": AUTH.username, "password": AUTH.password, "timezone_offset": AUTH.timezone_offset, "auth_type": AUTH.auth_type, "system_name": AUTH.system_name, "system_company_no": AUTH.system_company_no ], "product": ["product": PRODUCT.product, "pricing": PRODUCT.pricing, "inventory": PRODUCT.inventory, "relations": PRODUCT.relations, "attributes": PRODUCT.attributes, "categories": PRODUCT.categories, "media":, "variations": PRODUCT.variations, "updateIfExists": PRODUCT.updateIfExists ] ]

    Alamofire.request(.POST, postsEndpoint, parameters: authAndFieldsDict, encoding: .JSON).responseJSON { (request, response, data, error) in

      if let anError = error {

        println("error calling POST on /posts")

      } else if let jsonData: AnyObject = data {
        if let dataString = (jsonData.valueForKey("d") as! String).dataUsingEncoding(NSUTF8StringEncoding) {
            let json = JSON(data: dataString)  //use this object to parse data
            //SAMPLE PARSING
            let varData = json["returnObject"][0]["object"].stringValue

            // ----------

            //          if let updateProductDict = NSJSONSerialization.JSONObjectWithData(encoString, options: .MutableContainers, error: nil) as? NSDictionary {
            //            if let returnObjectArray = updateProductDict["returnObject"] as? NSArray {
            //              for updateProductObject in returnObjectArray {
            //                updateProductObjects.append(updateProductObject)
            //                if let item = updateProductObject["object_name"] as? NSDictionary {
            //                  let varItem = item["field_name"] as! String
            //                }
            //              }
            //              println("\n\(updateProductObjects.count) Total")
            //            }
            //          }

<!DOCTYPE html>
<title>API Call - updateProduct</title>
<script src=""></script>
<script type="text/javascript">
   $(function() {
      var dataValue = {
            "auth": {
                "api_username": "", 
                "api_password": "", 
                "api_key": "", 
                "company_no": 0, 
                "username": "", 
                "password": "", 
                "timezone_offset": 0, 
                "auth_type": "", 
                "system_name": "", 
                "system_company_no": 0, 
            "product": {
                "product": <wi_product>, 
                "pricing": <ArrayOfwi_product_pricing>, 
                "inventory": <ArrayOfwi_product_inventory>, 
                "relations": <ArrayOfminiProduct>, 
                "attributes": <ArrayOfwi_attribute>, 
                "categories": <ArrayOfwi_category_assign>, 
                "media": <ArrayOfwi_media>, 
                "variations": <ArrayOfminiProduct>, 
                "updateIfExists": false, 
         url: '',
         type: 'POST',
         data: JSON.stringify(dataValue),
         contentType: 'application/json; charset=utf-8',
         dataType: 'json',
         error: function (XMLHttpRequest, textStatus, errorThrown) {
         success: function (result) {
                var obj = JSON.parse(result.d).returnObject;

                $.each(obj, function(i) {
                    $("#divID").html(obj[i].field_name); //do something with the data
System.Net.HttpWebRequest req = System.Net.HttpWebRequest.Create("");
req.Method = "POST";
req.ContentType = "application/json; charset=utf-8";

string dataValue = "{auth: {api_username: <string>, api_password: <string>, api_key: <string>, company_no: <double>, username: <string>, password: <string>, timezone_offset: <double>, auth_type: <string>, system_name: <string>, system_company_no: <double> },product: {product: <wi_product>, pricing: <ArrayOfwi_product_pricing>, inventory: <ArrayOfwi_product_inventory>, relations: <ArrayOfminiProduct>, attributes: <ArrayOfwi_attribute>, categories: <ArrayOfwi_category_assign>, media: <ArrayOfwi_media>, variations: <ArrayOfminiProduct>, updateIfExists: <boolean> }}";

ASCIIEncoding encoding = new ASCIIEncoding();
byte[] bytes = encoding.GetBytes(dataValue);

req.ContentLength = bytes.Length;

System.IO.Stream strm = req.GetRequestStream();
strm.Write(bytes, 0, bytes.Length);

System.Net.HttpWebResponse rsp = req.GetResponse();
System.IO.Stream data = rsp.GetResponseStream();
System.IO.StreamReader rdr = new System.IO.StreamReader(data);

string response = rdr.ReadToEnd();

Dim req As System.Net.HttpWebRequest = System.Net.HttpWebRequest.Create("")
req.Method = "POST"
req.ContentType = "application/json; charset=utf-8"
Dim dataValue As String = "{auth: {api_username: <string>, api_password: <string>, api_key: <string>, company_no: <double>, username: <string>, password: <string>, timezone_offset: <double>, auth_type: <string>, system_name: <string>, system_company_no: <double> },product: {product: <wi_product>, pricing: <ArrayOfwi_product_pricing>, inventory: <ArrayOfwi_product_inventory>, relations: <ArrayOfminiProduct>, attributes: <ArrayOfwi_attribute>, categories: <ArrayOfwi_category_assign>, media: <ArrayOfwi_media>, variations: <ArrayOfminiProduct>, updateIfExists: <boolean> }}"
Dim encoding As New ASCIIEncoding()
Dim bytes As Byte() = encoding.GetBytes(dataValue)
req.ContentLength = bytes.Length
Dim strm As System.IO.Stream = req.GetRequestStream()
strm.Write(bytes, 0, bytes.Length)
Dim rsp As System.Net.HttpWebResponse = req.GetResponse()
Dim data As System.IO.Stream = rsp.GetResponseStream()
Dim rdr As New System.IO.StreamReader(data)

Dim response As String = rdr.ReadToEnd()
// This sample uses the Apache HTTP client from HTTP Components (

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();

      URIBuilder builder = new URIBuilder("");
      // Specify your subscription key
      builder.setParameter("subscription-key", "");
      URI uri =;
      HttpPost request = new HttpPost(uri);
      StringEntity reqEntity = new StringEntity("", ContentType.create("application/json"));
      HttpResponse response = httpclient.execute(request);
      HttpEntity entity = response.getEntity();
      if (entity != null) {
   catch (Exception e)

// This sample uses the HTTP_Request2 package. (for more information:
require_once 'HTTP/Request2.php';
$headers = array(
   'Content-Type' => 'application/json',

$query_params = array(
   // Specify your subscription key
   'subscription-key' => '',

$request = new Http_Request2('');
// Basic Authorization Sample
// $request-setAuth('{username}', '{password}');

$url = $request->getUrl();

   $response = $request->send();
   echo $response->getBody();
catch (HttpException $ex)
   echo $ex;


    #import <Foundation/Foundation.h>
    NSDictionary *authDic = [NSDictionary dictionaryWithObjectsAndKeys:
            <string>, @"api_username",
            <string>, @"api_password",
            <string>, @"api_key",
            <double>, @"company_no",
            <string>, @"username",
            <string>, @"password",
            <double>, @"timezone_offset",
            <string>, @"auth_type",
            <string>, @"system_name",
            <double>, @"system_company_no", nil];
    NSDictionary *productDic = [NSDictionary dictionaryWithObjectsAndKeys:
            <wi_product>, @"product",
            <ArrayOfwi_product_pricing>, @"pricing",
            <ArrayOfwi_product_inventory>, @"inventory",
            <ArrayOfminiProduct>, @"relations",
            <ArrayOfwi_attribute>, @"attributes",
            <ArrayOfwi_category_assign>, @"categories",
            <ArrayOfwi_media>, @"media",
            <ArrayOfminiProduct>, @"variations",
            <boolean>, @"updateIfExists", nil];
    NSDictionary *finalDic = [NSDictionary dictionaryWithObjectsAndKeys:
                authDic, @"auth",productDic, @"product", nil];
    NSMutableDictionary* jsonString = nil;
    jsonString = [NSJSONSerialization JSONObjectWithData: findalDic options:NSJSONReadingMutableContainers];
    NSMutableData *bodyData = [NSMutableData dataWithData:[jsonString dataUsingEncoding:NSUTF8StringEncoding]];
    NSString *urlString = @"";
    ASIFormDataRequest *request = [ASIFormDataRequest requestWithURL:[NSURL URLWithString:urlString]];    
    [request setTimeOutSeconds:250];    
    [request setRequestMethod:@"POST"];    
    [request addRequestHeader:@"Content-Type" value:@"application/json"];    
    [request addRequestHeader:[NSString stringWithFormat:@"%d",bodyData.length] value:@"Content-length"];    
    [request setPostBody:bodyData];    
    [request startSynchronous];

    NSDictionary *responseDic = (NSDictionary*)[request.responseString JSONValue];   
    if (responseDic || [responseDic objectForKey:@"d"])
        NSMutableDictionary *dicSave=[responseDic objectForKey:@"d"];
        // -------------------------------------------------------------------
        // convert into the data and NSUTF8StringEncoding
        // -------------------------------------------------------------------
        NSString *strDic=[dicSave copy];
        NSMutableDictionary *dirJson;
        if (strDic)
            NSData* dataFile=[strDic dataUsingEncoding:NSUTF8StringEncoding];
            NSString* newStr = [[NSString alloc] initWithData:dataFile
            dirJson = [newStr JSONValue] ;
        // -------------------------------------------------------------------
        NSString *str=[[dirJson objectForKey:@"returnObject"]valueForKey:@"customer_no"];
        UIAlertView *alert=[[UIAlertView alloc]initWithTitle:@"Error" message:@"An Error Occurred" delegate:nil cancelButtonTitle:@"Ok" otherButtonTitles:nil];
        [alert show];
require 'net/http'

uri = URI('')

uri.query = URI.encode_www_form({
   # Specify your subscription key
   'subscription-key' => '',

request =

# Basic Authorization Sample
# request.basic_auth 'username', 'password'
request['Content-type'] = 'application/json'

request.body = ""

response = Net::HTTP.start(, uri.port, :use_ssl => uri.scheme == 'https') do |http|

puts response.body
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
   # Basic Authorization Sample
   # 'Authorization': 'Basic %s' % base64.encodestring('{username}:{password}'),
   'Content-type': 'application/json',

params = urllib.urlencode({
   # Specify your subscription key
   'subscription-key': '',

   conn = httplib.HTTPSConnection('')
   conn.request("POST", "/customer/customer/registerCustomer?%s" % params, "", headers)
   response = conn.getresponse()
   data =
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 = {
   # Basic Authorization Sample
   # 'Authorization': 'Basic %s' % base64.encodestring('{username}:{password}'),
   'Content-type': 'application/json',

params = urllib.parse.urlencode({
   # Specify your subscription key
   'subscription-key': '',

   conn = http.client.HTTPSConnection('')
   conn.request("POST", "/customer/customer/registerCustomer?%s" % params, "", headers)
   response = conn.getresponse()
   data =
except Exception as e:
   print("[Errno {0}] {1}".format(e.errno, e.strerror))


REM for Basic Authorization use: --user {username}:{password}
REM Specify values for path parameters (shown as {...}), your subscription key and values for query parameters
curl -v -X POST ""^
 -H "Content-Type: application/json"