API 2 Reference

Welcome to the API 2, the next-generation API framework from InkSoft. API 2 features predictable, resource-oriented URLs which return data in the format of your choice (XML or JSON). We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application.

API 2 is currently in beta, which means all methods and objects are subject to change with shorter notice than usual. If breaking changes are necessary, they will be communicated via email at least two weeks before they go live.

We welcome any feedback and thank you for helping make API 2 the best it can be!

Code Examples

Code examples for the InkSoft API are available in several languages by making a selection above.

Choose between C# and jQuery for the request examples, and between JSON and XML for sample responses and object structures.

Live Response

Compose your method call using the Edit button next to any method, then click the Execute button to test the method call and see the response live!

Base URL

https://www.appareljunction.com/Apparel_Junction/Api2

API 2 Overview

  • API 2 is built with the front end in mind, although server-to-server calls are also supported
  • API 2 uses role-based authentication in addition to API key for flexible security options
  • API 2 provides a clean, consistent object structure
  • API 2 takes JSON inputs and returns a response using the format of your choice (JSON or XML)
  • The default format for API 2 calls is JSON
  • API 2 uses POST for calls that save information vs GET for calls that return information
  • API 2 uses HTTP response codes to indicate a success or failure result
  • API 2 provides a rich set of documentation, with composition and testing features

The following video introduces API 2 and provides an overview of key features:

The API Response Object

All API results are returned within a standard response object.

The result will be contained in the Data property.

Any messages (typically error messages) will be included in the Messages array.

OK indicates success (true) or failure (false), and StatusCode is a text representation of the HTTP status code returned with the response. 

{"Data":false,"OK":false,"Messages":[{"Content":"Unable to locate user","Title":null,"Severity":"ERROR"}],"StatusCode":"BadRequest"}

HTTP Status Codes

API 2 uses HTTP response codes to indicate a success or failure result. This allows frameworks like jQuery to automatically execute a separate function on a failure result without the need to examine the result itself (though the result is still present and available for examination).

Video Guide: API 2 Status Codes

The following video introduces explains the different HTTP status codes used by API 2:

Status Code 200 : OK

A status code of 200 indicates a success or true result. For example, SignIn will return with a status code of 200 if the result is true (the user is signed in).

Status Code 400 : Bad Request

A status code of 400 indicates a failure or false result. For example, SignIn will return with a status code of 400 if the result is false (the user is not signed in).

Status Code 404 : Not Found

A status code of 404 is not returned with an API result. A status code of 404 indicates that a resource cannot be found: either the URL for the call or the verb used is incorrect. For example, SignIn will return with a status code of 404 if the verb GET is used (instead of POST).

Status Code 500 : Internal Server Error

A status code of 500 indicates an error. For example, Register will return with a status code of 500 if an attempt is made to register a new account with an email address that belongs to an existing account (a user with that email address already exists).

Introduction to Use Cases

The following use cases represent common scenarios for which API 2 can be used. Each use case includes a walkthrough of the steps and API calls involved. Code samples are provided in the right pane, and downloadable working examples are provided for some use cases.

The API methods and objects referenced in each use case display as hyperlinks. As with other sections of the API 2 documentation, clicking a link will navigate to the relevant method or object documentation.

Single Sign On

Users, Sessions, Authentication, and Password Management

Single Sign On (SSO) is a strategy for coordinating authentication between InkSoft and a third party software system that allows a user that has been authenticated on one system to continue authenticated onto another system without the need to sign in again.

The Session Object

At the heart of single Single Sign-On is the Session. A session contains information about an authenticated user, and is referenced by a Globally Unique IDentifier (GUID) known as a session token.

Register (creates a new user) and SignIn (authenticates an existing user) both return a Session, which contains a property called Token. This is the session token, and should be saved (preferably in a cookie or local storage) in order to make subsequent calls that require an active session.

Managing Users

Create a New User

When a user account is created in your system, a corresponding account should be created in the InkSoft system by using the Register API call. The Register call creates a new user in the InkSoft system and returns the Session for that user. The UserId contained in the session can be used when saving and retrieving art and designs, as well as other functions.

The InkSoft user ID should be stored in your system, typically either by adding a column to your user table or by creating a lookup table to associate InkSoft user IDs with your own internal user IDs.

Update a User

UpdateUser can be used to synchronize user information with your system.

Authenticate a User

SignIn can be used to authenticate a user against the InkSoft system. A successful authentication returns the Session for that user, the Token property of which should be saved for subsequent calls that require SessionToken.

Retrieve a Session

Once a user has been created or authenticated and their session token stored, their session information can be retrieved at any time by calling GetSession.

Change a Password

Once a user has been authenticated, ChangeCurrentUserPassword can be used to change the user's password.

Video Guide: Single Sign On

The following video covers key concepts and API methods for implementing single sign on.

Click here to download the example code.

Create a New User and Store the Session Token in a Cookie

$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/Register',
  dataType: 'text',
  data: 'Email=test@inksoft.com&FirstName=John&LastName=Doe&Password=MySecretPassword33221&ConfirmPassword=MySecretPassword33221&SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&TaxIdNumber=123-23-1111&TaxResellerNumber=1234&NonTaxable=false&RememberMe=true&SubscribeToNewsletter=true&Format=JSON',
  processData: false,
  crossDomain: true,
  success: function (res) { 
      var sess = JSON.parse(res).Data;

      var sessionToken = sess.Token;

      $.cookie('SessionToken', sessionToken);
  },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

Authenticate a User and Store the Session Token in a Cookie

$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/SignIn',
  dataType: 'text',
  data: 'Email=test@inksoft.com&Password=MySecretPassword33221&Format=JSON',
  processData: false,
  crossDomain: true,
  success: function (res) { 
      var sesss = JSON.parse(res).Data;                                                           

      var sessionToken = sess.Token;

      $.cookie('SessionToken', sessionToken);
  },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

Verify a Session

var sessionToken = $.cookie('SessionToken');
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetSession?SessionToken=' + sessionToken + '&Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { 
      var sess = JSON.parse(res).Data;
      alert('Session Verified: ' + sess.Token); 
  },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

Creating a Custom Art Catalog

Lookup by ID, Product, Store and Customer

Creating a custom art catalog is simple using API 2.

Retrieve a List of Categories

GetClipArtCategories returns a full list of Category objects for the current store. Each category contains information such as name, item count and cover art URL that can be used to display information and provide a navigation structure to your visitors.

Retrieve a List of Arts by Category

GetStoreArt returns a list of Art objects for the current store. By specifying CategoryId, only art assigned to the specified category will be returned. By specifying CreatedBy, only art created by the desired user will be returned. Additionally, MaxResults can be used to limit the size of the result set.

Customize an Art

To allow a user to customize an art object, pass the art ID to the designer's ArtID parameter. The designer will start with the specified art selected and on the product.

Video Guide: Creating a Custom Art Catalog

The following video introduces the key concepts and API calls involved in creating a custom art catalog.

Click here to download the example code.

Retrieve a List of Art Categories

$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetClipArtCategories?Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

Retrieve a List of Art by Category

$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetStoreArt?CategoryId=1000172&Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

Creating a Custom Design Catalog

Lookup by ID, Product, Store and Customer

Creating a custom design catalog is simple using API 2.

Retrieve a List of Categories

GetDesignCategories returns a list of Category objects for the current store. Each category contains information such as name, item count and cover art URL that can be used to display information and provide a navigation structure to your visitors.

Retrieve a List of Designs by Category

GetDesignSummaries returns a list of Design objects for the current store. By specifying DesignCategoryId, only designs assigned to the specified category will be returned.

Customize a Design

To allow a user to edit a design, pass the design ID to the designer's DesignID parameter. The designer will start with the specified design selected and on the product.

Video Guide: Creating a Custom Design Catalog

The following video introduces the key concepts and API calls involved in creating a custom design catalog.

Click here to download the example code.

Retrieve a List of Design Categories

$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetDesignCategories?Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

Retrieve a List of Designs by Category

$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetDesignSummaries?DesignCategoryId=1000020&Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

Creating a Custom Product Catalog

Creating custom product pages begins with understanding the structure of InkSoft products.

Product, Styles and Sizes

Each Product contains one or more ProductStyles. Styles are most often used to represent different product colors, and each style contains a unique integer ID.

Each ProductStyle contains one or more ProductStyleSizes. A size of one style may share the same name as a size of another style, but each size has its own unique integer ID.

Retrieve a List of Product Categories

GetProductCatgories returns a list of Category objects for the current store. Each category contains information such as name, item count and cover art URL that can be used to display information and provide a navigation structure to your visitors.

Retrieve a List of Products by Category

GetProductBaseList returns a list of products for the specified category.

Customize a Product

For designer integration, pass the product ID and product style ID to the designer's parameters, and the designer will start with that product selected.

Video Guide: Creating a Custom Product Catalog

The following video introduces the key concepts and API calls involved in creating a custom product catalog.

Click here to download the example code.

Product, Style, and Size Relationship (Abbreviated JSON)

{
  "ID": 1000130,
  "Name": "Daytona Racing Colorblocked Moisture-Free Mesh Sport Shirt",
  "Styles": [
    {
      "ID": 1002089,
      "CanEmbroider": false,
      "CanScreenPrint": true,
      "CanDigitalPrint": false,
      "CanPrint": false,
      "IsDefault": false,
      "Sizes": [                                                           
        {
          "ID": 1013643,
          "LongName": "Small",
          "Name": "S"
        },                                                        
        {
          "ID": 1013644,
          "LongName": "Medium",
          "Name": "M"
        }
      ],
      "Name": "Red Black"
    }
  ]
}

Retrieve a List of Product Categories

$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetProductCategories?Format=JSON&GetProductIds=true',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

Retrieve a List of Products by Category

$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetProductBaseList?Format=JSON&ProductCategoryIds=[1000002]',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

Designer - External Cart Integration

The most common use of the InkSoft API is to integrate the designer with a non-InkSoft cart. This can be a custom, internally-developed cart, or one from a third party such as WooCommerce, Yahoo or OpenCart.

The typical end-user experience and API communication is as follows. In this section, User refers to the end customer and Publisher refers to the InkSoft customer. Implementation details appear to the right of each step.

Step 1

User creates a design in the designer (embedded on your website) and begins the checkout process

For details on how to embed the InkSoft Designer into your website, please visit the Designer Embed Guide for a quick code sample.

Once the designer is embedded, you may need to change some of the default parameters based on who the user is and how they navigated to the designer page.

API Calls

[none]

Designer Parameters

  • productId and productStyleId (InkSoft product identifiers) may be required if a custom product page has been implemented and the user is customizing a product from this page.
  • designId or artId is required if a custom art or design page has been implemented and the user is customizing a selected art or design from this page.

Step 2

The user is prompted to select sizes and quantities based on InkSoft product data.

Please note the designer will always use InkSoft product data for quotes, printable regions and sizes in the cart. Please ensure this data is up to date and accurate in the InkSoft admin portal.

API Calls

[none]

Designer Parameters

  • disableCart must be set to false to enable the "Buy Now" button in the designer.
  • customDesignerInterfaceText can be used to set custom text for the "Buy Now" button
function launchDesignStudio() {
  window.inksoftApi.launchEmbeddedDesignStudio({
    targetElementId: 'inksoftEmbed',
  domain: 'https://stores.inksoft.com',
  cdnDomain: 'https://stores.inksoft.com',
  storeUri: '{Your Store URI}',
  disableLeavePrompt: true,
  disableCart: false,
  customDesignerInterfaceText: {
    buyNow: 'Buy Now',
    getPrice: 'Get Price',
    saveDesign: 'Save Design'
  }
});

Step 3

After signing in, creating an account, or choosing to check out as a guest, the user's design is saved, a cart for the user is created, the selected styles and sizes are added, and the cart is assigned a session identifier (session token).

API Calls

[none]

Designer Parameters

[none]

Step 4

When the "Buy Now" button is clicked, the onCartTriggered event is triggered and the custom handler, handleCartTriggered, is executed and the user is forwarded to a non-InkSoft page specified in the handler function. The session token and product IDs are passed via query string arguments.

API Calls

[none]

Designer Parameters

function handleCartTriggered(c) {
  var productIdString = c.Items[0].ID;

  for (var i = 1; i < c.Items.length; i++) {
    productIdString += ',' + c.Items[i].ID;
  }
            
  document.location = 'https://yourdomain.com/AddToCart?SessionToken=' + c.SessionToken + '&productIds=' + productIdString;
}
            
function launchDesignStudio() {
  window.inksoftApi.launchEmbeddedDesignStudio({
    targetElementId: 'inksoftEmbed',
  domain: 'https://stores.inksoft.com',
  cdnDomain: 'https://stores.inksoft.com',
  storeUri: '{Your Store URI}',
  disableLeavePrompt: true,
  onCartTriggered: handleCartTriggered,
  customDesignerInterfaceText: {
    buyNow: 'Buy Now',
    getPrice: 'Get Price',
    saveDesign: 'Save Design'
  }
});

Step 5

The non-InkSoft page uses the information passed in via the query string to retrieve the design, product and size selections made by the user and display the contents of the cart.

Ensure the user's information is properly extracted from the query string and stored for use in subsequent calls.

API Calls

  • GetCartPackage - Retrieves the InkSoft cart along with all supporting data required to display the cart contents (products, names and numbers, personalization values, pricing, etc)
  • SaveCartItemNotes - If users are permitted to save notes to a cart item, this method is used to save the notes.

Designer Parameters

[none]

Step 6

The non-InkSoft page will use that information to collect any additional information required from the customer and complete the custom check out process. The non-InkSoft page will collect payment terms, address information (if necessary), and shipping method from User and use InkSoft API calls to submit that information to the InkSoft cart.

As user information is collected and saved in your database and/or third party cart, it should also be sent to InkSoft so all relevant order information is available in the InkSoft admin portal when the time comes to fulfill the order. There are several API calls used to save this information. Some may not be necessary for your implementation.

API Calls

  • SetCart - If manipulating cart values locally, this call is a convenient way to save all cart values.
  • SaveCartBillingAddress - Saves the billing address to the cart. No other cart properties are modified.
  • SaveCartShippingAddress - Saves the shipping address to the cart. No other cart properties are modified.
  • GetPaymentMethods - Returns the payment methods available based on the store, customer and protocol. This call can be omitted and "Arrange Later" can be sent as the payment method value, since most integrations involved collection of payment information using a third party service during checkout.
  • GetShippingMethods - Returns shipping options based on store settings. This may not be necessary if implementing independent shipping method logic.

Designer Parameters

[none]

Step 7

When all necessary information has been saved, GetCartPackage may be called again and the information used to display an order summary.

User then places the order and uses the SaveCartOrder API call to submit the order to finalize the order in the InkSoft system.

API Calls

  • GetCartPackage - Will have updated totals based on tax and shipping rules since shipping and billing information have been entered.
  • SaveCartOrder - This is the final API call made when placing an order. *Important* Include the payment method and TotalAmount from the cart for validation.

Designer Parameters

[none]

Embedding the Designer

The designer can be embedded into almost any web page, and doing so is simple with the Designer Embed Guide.

The basic elements look like this: 

<div class="embed-container">
    <div id="inksoftEmbed" style="width: 100%; height: 720px; padding: 0; margin: 0; border: 0; max-height: 100%; width: 100%;"></div>
</div>
<script type="text/html">
  (function() {
    function init() {
      var scriptElement = document.createElement('script');
      scriptElement.type = 'text/html';
      scriptElement.async = true;
      scriptElement.src = 'https://stores.inksoft.com/FrontendApps/storefront/assets/scripts/designer-embed.js';
      scriptElement.onload = function() { launchDesignStudio() };
      document.getElementsByTagName('body')[0].appendChild(scriptElement);
    }

    function launchDesignStudio() {
      window.inksoftApi.launchEmbeddedDesignStudio({
        targetElementId: 'inksoftEmbed',
        domain: 'https://stores.inksoft.com',
        cdnDomain: 'https://stores.inksoft.com',
        storeUri: '{YourStoreURI}'
      });
    }

    init();
  })();
</script>

The div tag with id="embed-container" serves as a placeholder for the designer.

The script loads the javascript that powers the designer. The script block defines a function that executes when the script is loaded.

If conflicts arise between the designer and existing page scripts, the designer may be enclosed within an iframe.

For more details on how to embed the InkSoft Designer into your website, please visit the Designer Embed Guide.

Video Guide: Embedding the Designer

The following video shows the process of embedding the designer:

Embed Options

targetElementId
  • This is the element in which the designer will be placed. The default embed code includes an element to place the designer, so normally changes are not needed.
productId
  • If specified, the Designer Embed will skip the select product screen and load the specified product with the default style and no design.
productStyleId
  • If specified and productId is also specified, the Designer Embed will load the specified product style of the product.
designId
  • If specified, the specific design will load on the specified product. This setting requires a productId to be set.
disableCart
  • This can be set to true to disable the cart and remove all associated links that allow for checkout in the Designer Embed.
sessionToken
  • Whatever the user has done up to the point of getting to the Designer will be passed through.
disableLeavePrompt
  • This will allow you to control whether the leave warning notifications display when the customer is navigating throughout the designer.

Custom Designer Interface Text

Editable text is nested under the customDesignerInterfaceText property. The following pieces of text can be changed:

buyNow
  • Buy Now button in the Price Summary dialog.
getPrice
  • Get Price button is in the bottom footer bar during product quantity entry.
nextStep
  • Next Step button in the bottom footer bar when viewing a design being edited.
saveDesign
  • Save Design button in the bottom footer bar when viewing a design being edited.

Designer Callbacks

Some InkSoft customers have a more complex custom e-commerce and order fulfillment system in which the designer is required only for art and design features, with sizes and quoting being handled externally. This kind of integration is less common, but very flexible.

The first integration point is the embed callback onDesignSaved. This callback allows a function to be executed when the user saves a design they've created in the designer embed. The function is passed a Design object that contains all data for the saved design.

In this use case, we'll use the onDesignSaved callback to navigate to a separate page that will do something based on the design ID. The embed code is as follows: 

<div class="embed-container">
  <div id="inksoftEmbed" style="width: 100%; height: 720px; padding: 0; margin: 0; border: 0; max-height: 100%; width: 100%;"></div>
</div>
<script type="text/html">

function hello(o) {
   console.log(JSON.stringify(o));
}
           
function handleDesignSaved(d) {
   document.location = 'https://www.test.com?DesignId=' + d.ID;
}
                      
function handleCartTriggered(c) {
   document.location = 'https://www.test.com?DesignId=' + d.ID;
}

(function() {
  function init() {
    var scriptElement = document.createElement('script');
    scriptElement.type = 'text/html';
    scriptElement.async = true;
    scriptElement.src = 'https://stores.inksoft.com/FrontendApps/storefront/assets/scripts/designer-embed.js';
    scriptElement.onload = function() { launchDesignStudio() };
    document.getElementsByTagName('body')[0].appendChild(scriptElement);
  }

  function launchDesignStudio() {
    window.inksoftApi.launchEmbeddedDesignStudio({
      targetElementId: 'inksoftEmbed',
      domain: 'https://stores.inksoft.com',
      cdnDomain: 'https://stores.inksoft.com',
      storeUri: 'DS247471703',
      onDesignerReady: hello,
      onDesignSaved: handleDesignSaved,
      onCartTriggered: handleCartTriggered
    });
  }

  init();
})();
</script>

The code above defines a function called handleDesignSaved, which has a single argument (d) which is the Design object that will be passed in. In launchDesignStudio, we assign the function handleDesignSaved to the callback onDesignSaved.

The next integration point is the API call GetDesignSummary API call. This call returns a DesignSummary object, which contains images and metadata for the design saved by the user.

The onDesignSaved callback is also a great way to offer an "Edit this design" feature, in which the user may be visiting a page that displays their selected products and designs. If the user would like to change something, the designer can be opened with all information required to track the user in cookies or in arguments passed to the destination URL. When the user is done and the design has been saved, a new design will be returned for your own internal processing.

Some customers who decide against using the InkSoft cart also have their own order fulfillment software and do not wish to save orders in InkSoft. In this case, high-resolution rendered art can be retrieved from one of the rendering API calls, and everything else can be handled in your own system.

Other customers may want to offer the customized checkout experience, but still use InkSoft's admin portal for downloading art and managing the order fulfillment process. These customers must implement the cart methods described in the NextURL integration method, but will also need to add each item to the cart. For more details on how to add/remove/update cart items, please refer to the documentation for the cart methods, or turn on "check out from designer" in your store and the designer will manage all cart updates.

The API 1 to API 2 Migration Guide

This guide is intended for API 1 users that need to bring their existing API 1 functionality into the API 2 world. This guide covers the functionality of API 1, describing the approach for API 2 for each API 1 method.

API 2 vs API 1

Key differences between API 1 and API 2 include:

  • API 2 is built with the front end in mind, although server-to-server calls are also supported
  • API 2 uses role-based authentication in addition to API key for flexible security options
  • API 2 provides a clean, consistent object structure instead of database-generated XML that varies from call to call
  • API 2 takes JSON inputs and returns a response using the format of your choice (JSON or XML)
  • The default format for API 2 calls is JSON (vs XML for API 1)
  • API 2 uses POST for calls that save information vs GET for calls that return information
  • API 2 uses HTTP response codes to indicate a success or failure result
  • API 2 provides a rich set of documentation, with composition and testing features

The API Response Object

All API 2 results are returned within a standard response object.

The result will be contained in the Data property.

Any messages (typically error messages) will be included in the Messages array.

OK indicates success (true) or failure (false), and StatusCode is a text representation of the HTTP status code returned with the response. 

{"Data":false,"OK":false,"Messages":[{"Content":"Unable to locate user","Title":null,"Severity":"ERROR"}],"StatusCode":"BadRequest"}

Cart and Checkout

The table on the right lists API 1 methods related to shopping cart operations along with the equivalent API 2 methods. These methods are discussed in more detail below.

GetCart and SetCart

Cart operations in API 2 revolve around two key methods: GetCart and SetCart.

GetCart retrieves a cart based on a SessionId or SessionToken.

SetCart accepts a cart in JSON format and saves it to the server. SetCart in API 2 allows cart operations to be performed far more efficiently than the piecemeal operations of API 1. For example, to add three items to the cart and update the quantity of two existing items in API 1 would require three calls to Cart/Add and two calls to Cart/UpdateQty for a total of five calls. With API 2, all of these operations can be performed simultaneously with just one call to SetCart -- just use GetCart to retrieve the current cart, make any desired modifications, and save it back to the server using SetCart.

Cart / Checkout

API 1 API 2
GetCartBillingAddresses GetAddressBook
GetCartBillingCountryList GetCountries?ShippingBilling=Billing
GetCartBillingStateList GetStates?ShippingBilling=Billing
GetCartCanCheckout GetCart
GetCartOrder GetOrder
GetCartPaymentMethods GetPaymentMethods
GetCartResidencyOptions Not Supported
GetCartShippingAddresses GetAddressBook
GetCartShippingCountryList GetCountries?ShippingBilling=Shipping
GetCartShippingMethods GetShippingMethods
GetCartShippingStateList GetStates?ShippingBilling=Shipping
LoginUser SignIn
RegisterUser Register
SaveCartBillingAddress SaveCartBillingAddress
SaveCartCouponCode AddCartCoupon
SaveCartEmail SaveCartEmail / SetCart
SaveCartFedExAccount Not Supported
SaveCartGiftCertRedeem AddCartGiftCertificate
SaveCartGiftCertRedeemUndo RemoveCartGiftCertificate
SaveCartGiftMessage SaveGiftMessage / SetCart
SaveCartOrder SaveCartOrder
SaveCartResidency Not Supported
SaveCartShippingAddress SaveCartShippingAddress
SaveCartShippingMethod SaveCartShippingMethod
SaveCartUPSAccount Not Supported
SetCoordinatorUserID Not Supported
SetExternalCustomerID Not Supported
SetExternalOrderID Not Supported
SetPurchaseOrderNumber SaveCartOrder
SetRequestedShipDate Not Supported

Cart Items

The table on the right lists API 1 methods related to shopping cart items along with the equivalent API 2 methods. These methods are discussed in more detail below.

GetCart and SetCart

Cart operations in API 2 revolve around two key methods: GetCart and SetCart.

GetCart retrieves a cart based on a SessionId or SessionToken.

SetCart accepts a cart in JSON format and saves it to the server. SetCart in API 2 allows cart operations to be performed far more efficiently than the piecemeal operations of API 1. To add three items to the cart and update the quantity of two existing items in API 1 would require three calls to Cart/Add and two calls to Cart/UpdateQty for a total of five calls. With API 2, all of these operations can be performed simultaneously with just one call to SetCart -- just use GetCart to retrieve the current cart, make any desired modifications, and save it back to the server using SetCart.

Cart / Items

API 1 API 2
AddItemsByGTIN Not Supported
AddItemsBySKUStyleSize AddItemToCart
SetCart
Cart/Add AddItemToCart
AddItemsToCart
SetCart
Cart/GetCartSubTotal GetCart
Cart/RemoveSize SetCart
Cart/UpdateQty SetCart
EmptyCart SetCart
GetCart GetCart
NewCartByGTIN Not Supported
NewCartBySKUStyleSize SetCart
SaveCartItemNameNumber Not Supported
SaveCartItemNameNumberFont Not Supported
SaveCartItemNameNumberRemove Not Supported
SaveCartItemNotes SetCart

Art

The table on the right lists API 1 methods related to art along with the equivalent API 2 methods.

Art

API 1 API 2
GetArtList GetClipArtCategories
GetStoreArt
RemoveSessionArt Not Supported

Designs

The table on the right lists API 1 methods related to designs along with the equivalent API 2 methods.

Designs

API 1 API 2
GetFontList Not Supported
GetStoreDesignCategoryList Not Supported
GetSessionDesign GetDesignSummary
GetSessionDesignList GetDesignsForUser
GetStoreDesignList Not Supported
RemoveSessionDesign Not Supported

Stores

The table on the right lists API 1 methods related to stores along with the equivalent API 2 methods.

Stores

API 1 API 2
GetFontList Not Supported
GetInkColorList Not Supported

Orders

The table on the right lists API 1 methods related to orders along with the equivalent API 2 methods.

Orders

API 1 API 2
OrderArtFiles Not Supported
OrderCreateShipment CreateOrderShipments
OrderDeleteShipment Not Supported
OrderDetails GetOrderPackage
OrderList GetOrderPackage
OrderPayments GetOrderPackage
OrderShipments GetOrderPackage
OrderStatus GetOrderPackage
OrderUpdateStatus Not Supported

Sessions

The table on the right lists API 1 methods related to sessions along with the equivalent API 2 methods.

In API 2, SessionToken is used as the primary session identifier rather than SessionId.

Sessions

API 1 API 2
Cart/GetCartSession GetOrCreateSession
GetNewSession GetOrCreateSession
LookupCartByExternalOrderID Not Supported

AbandonedCartSettings

Properties

  • EmailDays type: List of integer 


{
  "EmailDays"   : [1,2,3]
}

 

Address

A street address / location with phone, fax and tax information

Properties

  • ID type: integer

    The ID of the address in the InkSoft system

  • StateId type: (nullable) integer

    The ID of the address's State

  • CountryId type: (nullable) integer

    The ID of the address's Country

  • Business type: boolean

    Indicates whether or not the address is a business address

  • TaxExempt type: boolean

    Indicates whether or not the customer at this address is tax exempt

  • FirstName type: string

    The first name of the resident of this address

  • LastName type: string

    The last name of the resident of this address

  • Name type: string

    The full name of the resident of this address

  • CompanyName type: string

    The name of the company at this address

  • Street1 type: string

    The street component of this address

  • Street2 type: string

    The street2 component of this address

  • City type: string

    The city component of this address

  • State type: string

    The state code component of this address

  • StateName type: string

    The state name component of this address

  • Country type: string

    The country component of this address

  • CountryCode type: string

    The country code component of this address

  • Email type: string

    Used for an ACH billing address

  • Phone type: string

    The phone component of this address

  • Fax type: string

    The fax component of this address

  • PostCode type: string

    The postal code component of this address

  • POBox type: boolean

    True if this address is a PO box, false otherwise.

  • SaveToAddressBook type: boolean

    True if the address is part of an address book

  • Type type: string

    The type of this address

  • TaxId type: string

    The tax ID of this address

  • Department type: string

    The department of the Address

  • ShowPickupAtCheckout type: boolean

    Determines whether or not they want to display the address to the end customer as part of the pickup instructions in checkout

  • Validated type: boolean

    Address Valid or not

  • IsPrimaryAddress type: boolean

    True if this address should be assigned as the primary address for the user

  • SingleLine type: string

    The single line version of this address 


{
  "ID"                     : 1000014,
  "StateId"                : 4,
  "CountryId"              : 1,
  "Business"               : "true",
  "TaxExempt"              : "true",
  "FirstName"              : "John",
  "LastName"               : "Doe",
  "Name"                   : "John Doe",
  "CompanyName"            : "Doe Co",
  "Street1"                : "1234 Test St",
  "Street2"                : "Suite 500",
  "City"                   : "Albuquerque",
  "State"                  : "NM",
  "StateName"              : "New Mexico",
  "Country"                : "United States",
  "CountryCode"            : "US",
  "Email"                  : "ExampleString",
  "Phone"                  : "480-309-6332",
  "Fax"                    : "480-309-6333",
  "PostCode"               : "87111",
  "POBox"                  : "true",
  "SaveToAddressBook"      : "true",
  "Type"                   : null,
  "TaxId"                  : null,
  "Department"             : "IT, Sales, Marketing",
  "ShowPickupAtCheckout"   : "true",
  "Validated"              : "true or false",
  "IsPrimaryAddress"       : "true",
  "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
}

 

Art

Represents a single piece of vector or raster art that may be part of a design, a standalone file, or part of a product.

Properties

  • ID type: integer

    The integer ID of the art

  • ColorCount type: integer

    The number of colors in this art

  • Colors type: List of string

    A list of colors in this art

  • OriginalColorway type: Colorway

    A colorway defining the art's original (and possibly only) list of colors with their indexes and thread IDs.

  • StitchCount type: (nullable) integer

    The stitch count for this art (only applies to embroidery)

  • TrimCount type: (nullable) integer

    The trim count for this art (only applies to embroidery

  • GalleryId type: (nullable) integer

    The gallery that contains this art (if applicable)

  • CategoryIds type: List of integer

    A list of IDs for Categorys that contain this art

  • Name type: string

    The name of this

  • Type type: string

    The type of this art (vector, raster or emb)

  • Keywords type: string

    A comma-delimited list of keywords that apply to this art

  • FixedSvg type: boolean

    TODO:Describe

  • Digitized type: boolean

    True if this design can be digitized

  • CanScreenPrint type: boolean

    True if this design can be screen printed

  • FullName type: string

    The full name of this art

  • ExternalReferenceID type: string

    A reference ID of the approval email

  • Width type: (nullable) integer

    The width of this art in pixels (raster) or stitches (embroidery). Not applicable for vector art. For embroidery, each stitch is assumed to be 1/10mm so width in inches can be determined by dividing by 254

  • Height type: (nullable) integer

    The height of this art in pixels (raster) or stitches (embroidery). Not applicable for vector art. For embroidery, each stitch is assumed to be 1/10mm so height in inches can be determined by dividing by 254

  • Notes type: string

    Any notes about this art

  • FileExt type: string

    The original file extension of this art (png, eps, etc)

  • ImageUrl type: string

    The URL of the image for this art

  • ThumbUrl type: string

    The URL of the thumbnail image for this art

  • ThumbUrlAlt type: string

    An alternate URL of the thumbnail image for this art

  • OriginalUrl type: string

    The URL of the original image for this art

  • UploadedUrl type: string

    The URL of the uploaded art

  • UploadedOn type: DateTime

    The date on which this art was uploaded

  • IsActive type: boolean

    Whether or not this art is active and can be placed on new predecorated products in this store. Applies only to product art.

  • Colorways type: List of Colorway

    All colorways associated with this art. Applies only to product art.

  • UniqueId type: (nullable) guid

    The unique ID of the art

  • MatchFileColor type: boolean

    True if art should be flagged to only match colors in the art file. 


{
  "ID"                    : 1,
  "ColorCount"            : 1,
  "Colors"                : ["#FF0000","#FFFFFF","#0000FF"],
  "OriginalColorway"  : 
  {
    "ID"             : 1,
    "Colors"  : 
    [
      {
        "Index"                : 1,
        "Color"                : "ExampleString",
        "EmbroideryThreadId"   : 1,
        "InkColorId"           : 1,
        "ColorName"            : "ExampleString",
        "PMS"                  : "ExampleString"
      }
    ],
    "Name"           : "ExampleString",
    "SvgUrl"         : "ExampleString",
    "RenderedUrl"    : "ExampleString",
    "ThumbnailUrl"   : "ExampleString"
  },
  "StitchCount"           : 1,
  "TrimCount"             : 1,
  "GalleryId"             : 1,
  "CategoryIds"           : [1,2,3],
  "Name"                  : "Business_Designs",
  "Type"                  : "ExampleString",
  "Keywords"              : "pretty,big,black and white,zebra",
  "FixedSvg"              : "true",
  "Digitized"             : "true",
  "CanScreenPrint"        : "true",
  "FullName"              : "store5976/Business/Business_Designs",
  "ExternalReferenceID"   : "ExampleString",
  "Width"                 : 762,
  "Height"                : 538,
  "Notes"                 : "ExampleString",
  "FileExt"               : "png",
  "ImageUrl"              : "ExampleString",
  "ThumbUrl"              : "ExampleString",
  "ThumbUrlAlt"           : "ExampleString",
  "OriginalUrl"           : "ExampleString",
  "UploadedUrl"           : "ExampleString",
  "UploadedOn"            : "2017-10-30T07:00:00Z",
  "IsActive"              : "true",
  "Colorways"  : 
  [
    {
      "ID"             : 1,
      "Colors"  : 
      [
        {
          "Index"                : 1,
          "Color"                : "ExampleString",
          "EmbroideryThreadId"   : 1,
          "InkColorId"           : 1,
          "ColorName"            : "ExampleString",
          "PMS"                  : "ExampleString"
        }
      ],
      "Name"           : "ExampleString",
      "SvgUrl"         : "ExampleString",
      "RenderedUrl"    : "ExampleString",
      "ThumbnailUrl"   : "ExampleString"
    }
  ],
  "UniqueId"              : "",
  "MatchFileColor"        : "true"
}

 

Category

Category class, used for products, designs and art

Properties

  • ItemCount type: integer

  • IncludeSimilarCategories type: boolean

  • Children type: List of Category

  • ItemIds type: List of integer

  • CoverArtId type: (nullable) integer

  • ParentId type: (nullable) integer

  • CoverArtUrl type: string

  • ID type: integer

  • Name type: string

  • Path type: string 


{
  "ItemCount"                  : 1,
  "IncludeSimilarCategories"   : "true",
  "Children"  : [],
  "ItemIds"                    : [1,2,3],
  "CoverArtId"                 : 1,
  "ParentId"                   : 1,
  "CoverArtUrl"                : "ExampleString",
  "ID"                         : 1,
  "Name"                       : "ExampleString",
  "Path"                       : "ExampleString"
}

 

CategoryBase

Basic category properties

Properties

  • ID type: integer

    The unique integer ID of the category

  • Name type: string

    The name of the category

  • Path type: string 


{
  "ID"     : 1,
  "Name"   : "ExampleString",
  "Path"   : "ExampleString"
}

 

CheckoutSettings

Holds all settings related to checkout that are store/publisher-specific and NOT specific to the cart or user.

Properties

  • PurchaseOrderAttachmentRequired type: boolean

    If true and the user chooses to pay with a PO, then they must upload an attachment.

  • PurchaseOrderAttachmentEnabled type: boolean

    If false and the user chooses to pay with a PO, then they can upload an attachment. Otherwise they should not be able to.

  • CartPricingEnabled type: boolean

    If false, hide all cart pricing.

  • PaymentEnabled type: boolean

    If set to false, "Arrange Payment Later" should be the payment type for this order, and we should skip the payment step altogether.

  • BillingAddressRequired type: boolean

    Even if this is false, Billing Address is required if the user chooses to pay with a credit card.

  • PaypalBillingRequired type: boolean

    I'm not quite sure what this does yet but it's in use and looks important.

  • ShippingAddressEnabled type: boolean

    If this is false, we don't prompt at all for shipping address, and only save billing address.

  • GiftMessageEnabled type: boolean

    Stores can configure whether or not gift messages are allowed.

  • AddressValidationEnabled type: boolean

    If false, the client should call the address validation API to correct the shipping address.

  • CurrencyCode type: string

    Ised on the review order page before the grand total. Usually 'USD'

  • CurrencySymbol type: string

    Use this symbol to indicate currency, will usually be "$" but may be something else.

  • StoreName type: string

    Name of the store to display

  • StoreLogoUrl type: string

    Logo URL, if there is one.

  • AddThisPublisherId type: string

    Publisher ID to use in all social media calls that use AddThis

  • ContactEmail type: string

    Store e-mail address to show for help/questions

  • PhoneNumber type: string

    Store phone number to show for help/questions

  • NameNumberFonts type: List of NameNumberFont

  • AcceptPurchaseOrdersFromAnyone type: boolean

  • PaymentGatewayEnabled type: boolean

  • ArrangePaymentLaterEnabled type: boolean 


{
  "PurchaseOrderAttachmentRequired"   : "true",
  "PurchaseOrderAttachmentEnabled"    : "true",
  "CartPricingEnabled"                : "true",
  "PaymentEnabled"                    : "true",
  "BillingAddressRequired"            : "true",
  "PaypalBillingRequired"             : "true",
  "ShippingAddressEnabled"            : "true",
  "GiftMessageEnabled"                : "true",
  "AddressValidationEnabled"          : "true",
  "CurrencyCode"                      : "ExampleString",
  "CurrencySymbol"                    : "ExampleString",
  "StoreName"                         : "ExampleString",
  "StoreLogoUrl"                      : "ExampleString",
  "AddThisPublisherId"                : "ExampleString",
  "ContactEmail"                      : "ExampleString",
  "PhoneNumber"                       : "ExampleString",
  "NameNumberFonts"  : 
  [
    {
      "ID"              : 1,
      "Name"            : "ExampleString",
      "CssFamilyName"   : "ExampleString"
    }
  ],
  "AcceptPurchaseOrdersFromAnyone"    : "true",
  "PaymentGatewayEnabled"             : "true",
  "ArrangePaymentLaterEnabled"        : "true"
}

 

Colorway

Represents a variation of a set of colors for a piece of art. Used when you want one piece of art on multiple styles, but you want different colors in the art depending on the color of the product.

Properties

  • ID type: integer

    The unique ID of this colorway

  • Colors type: List of ColorwayColor

    The colors in this colorway that should replace the default ones in the art.

  • Name type: string

    The name of this colorway - currently auto-generated.

  • SvgUrl type: string

    A relative URL to the rendered SVG of this colorway.

  • RenderedUrl type: string

    A relative URL to the rendered PNG of this colorway (max width/height 500px)

  • ThumbnailUrl type: string

    A relative URL to the thumbnail of this colorway (max width/height 105px) 


{
  "ID"             : 1,
  "Colors"  : 
  [
    {
      "Index"                : 1,
      "Color"                : "ExampleString",
      "EmbroideryThreadId"   : 1,
      "InkColorId"           : 1,
      "ColorName"            : "ExampleString",
      "PMS"                  : "ExampleString"
    }
  ],
  "Name"           : "ExampleString",
  "SvgUrl"         : "ExampleString",
  "RenderedUrl"    : "ExampleString",
  "ThumbnailUrl"   : "ExampleString"
}

 

ColorwayColor

A single color that should replace a default color in an art object.

Properties

  • Index type: integer

    The index of the color in the original art that this color should replace

  • Color type: string

    The HTML code of the color in hex format ie #FFAA33

  • EmbroideryThreadId type: (nullable) integer

    The ID of the embroidery thread associated with this color. This only has a value for some embroidery art.

  • InkColorId type: (nullable) integer

    The ID of the ink color associated with this color. A value will only be present if the color was selected from a palette

  • ColorName type: string

    The name of the color, if it was selected from a palette

  • PMS type: string

    The PMS value of the color, if it was selected from a palette 


{
  "Index"                : 1,
  "Color"                : "ExampleString",
  "EmbroideryThreadId"   : 1,
  "InkColorId"           : 1,
  "ColorName"            : "ExampleString",
  "PMS"                  : "ExampleString"
}

 

Company

ProductBase contains a small number of lightweight properties used to quickly search and display contacts. Inherited by [Object:User] for full Company properties

Properties

  • ID type: integer

    A unique integer ID for this product

  • Name type: string

    The Name of the Company

  • PrimaryContact type: Contact

    Primary Contact for the Company

  • PrimaryContactId type: (nullable) integer

    Primary Address ID for the Contact

  • PrimaryAddress type: Address

    Primary Address for the Company

  • PrimaryAddressId type: (nullable) integer

    Primary Address ID for the Contact

  • Addresses type: List of Address

    List all the addresses for the company

  • WebsiteUrl type: string

    The Website URL of the Company

  • Fax type: string

    The Fax of the Contact

  • USFederalTaxId type: string

    The US Federal TaxID of the Company

  • USStateTaxId type: string

    The US State TaxID of the Company

  • CanadaBusinessNumber type: string

    The Canada Business Number of the Company

  • IsUSTaxExempt type: boolean

    The Company is US Tax Exempted or No.

  • USTaxExemptionType type: string

    The Type of Tax Exemption

  • Discount type: (nullable) decimal

    Discount Percent for the Company

  • Note type: string

    The Notes of the Company

  • Phones type: List of Phone

    Phone Records

  • Tags type: List of Tag

    Company Tags

  • Contacts type: List of Contact

    Contacts for the Companies

  • Timeline type: List of TimelineEntry 


{
  "ID"                     : 1000000,
  "Name"                   : "Inksoft",
  "PrimaryContact"  : 
  {
    "Fax"                     : "111-222-3333",
    "Note"                    : "Some details about the Contact",
    "SalesDocs"  : 
    [{"Name" : "example not found"}
    ],
    "PurchaseOrdersEnabled"   : "true",
    "PayLaterEnabled"         : "true",
    "Timeline"  : 
    [
      {
        "EventDescription"    : ,
        "ID"                  : 1,
        "ContactIds"          : [1,2,3],
        "CompanyIds"          : [1,2,3],
        "JobIds"              : [1,2,3],
        "OrderIds"            : [1,2,3],
        "ProposalIds"         : [1,2,3],
        "ProductionCardIds"   : [1,2,3],
        "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
        "Event"               : "ExampleString",
        "Comment"             : "ExampleString",
        "EventType"  : {"Name" : "example not found"},
        "Edited"              : "true",
        "EditedDate"          : "2017-10-30T07:00:00Z",
        "Deleted"             : "true",
        "DeletedDate"         : "2017-10-30T07:00:00Z",
        "Created"             : "2017-10-30T07:00:00Z",
        "CreatedByUserId"     : 1,
        "CreatedByName"       : "ExampleString",
        "Details"  : 
        [
          {
            "Property"   : "ExampleString",
            "OldValue"   : "ExampleString",
            "NewValue"   : "ExampleString",
            "Date"       : "2017-10-30T07:00:00Z"
          }
        ],
        "Associations"  : {"Name" : "example not found"}
      }
    ],
    "TierId"                  : 1,
    "Tiers"  : 
    [
      {
        "ID"         : 1000000,
        "Name"       : "Reseller",
        "UniqueId"   : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
        "Active"     : "true"
      }
    ],
    "IsTaxable"               : "true",
    "ID"                      : 1,
    "FirstName"               : "ExampleString",
    "LastName"                : "ExampleString",
    "JobTitle"                : "ExampleString",
    "Email"                   : "ExampleString",
    "Phones"  : 
    [
      {
        "ID"            : 1000000,
        "Number"        : "888-222-3333",
        "Extension"     : "1234",
        "PhoneType"     : "Mobile",
        "IsSMSOptOut"   : "false"
      }
    ],
    "ProfilePicture"          : "ExampleString",
    "Newsletter"              : "true",
    "Tags"  : 
    [
      {
        "ID"      : 1000000,
        "Name"    : "Walter",
        "Count"   : 12
      }
    ],
    "Store"  : 
    {
      "ID"                    : 1000000,
      "Uri"                   : "ExampleString",
      "Name"                  : "Walter",
      "Logo"                  : "logo.png",
      "AcceptPurchaseOrder"   : "true or false",
      "AllowPaymentLater"     : "true or false"
    },
    "Origin"  : 
    {
      "ID"      : 1000000,
      "Name"    : "Walter",
      "Image"   : "Walter",
      "Count"   : Walter
    },
    "Company"  : null,
    "PrimaryAddressId"        : 1,
    "Addresses"  : 
    [
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      }
    ],
    "Discount"                : 3.14,
    "BirthDate"               : "2017-10-30T07:00:00Z",
    "DateCreated"             : "2017-10-30T07:00:00Z",
    "LastModified"            : "2017-10-30T07:00:00Z",
    "ExternalReferenceId"     : "ExampleString",
    "StoreAnalyticsEnabled"   : "true"
  },
  "PrimaryContactId"       : 1,
  "PrimaryAddress"  : 
  {
    "ID"                     : 1000014,
    "StateId"                : 4,
    "CountryId"              : 1,
    "Business"               : "true",
    "TaxExempt"              : "true",
    "FirstName"              : "John",
    "LastName"               : "Doe",
    "Name"                   : "John Doe",
    "CompanyName"            : "Doe Co",
    "Street1"                : "1234 Test St",
    "Street2"                : "Suite 500",
    "City"                   : "Albuquerque",
    "State"                  : "NM",
    "StateName"              : "New Mexico",
    "Country"                : "United States",
    "CountryCode"            : "US",
    "Email"                  : "ExampleString",
    "Phone"                  : "480-309-6332",
    "Fax"                    : "480-309-6333",
    "PostCode"               : "87111",
    "POBox"                  : "true",
    "SaveToAddressBook"      : "true",
    "Type"                   : null,
    "TaxId"                  : null,
    "Department"             : "IT, Sales, Marketing",
    "ShowPickupAtCheckout"   : "true",
    "Validated"              : "true or false",
    "IsPrimaryAddress"       : "true",
    "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
  },
  "PrimaryAddressId"       : 1,
  "Addresses"  : 
  [
    {
      "ID"                     : 1000014,
      "StateId"                : 4,
      "CountryId"              : 1,
      "Business"               : "true",
      "TaxExempt"              : "true",
      "FirstName"              : "John",
      "LastName"               : "Doe",
      "Name"                   : "John Doe",
      "CompanyName"            : "Doe Co",
      "Street1"                : "1234 Test St",
      "Street2"                : "Suite 500",
      "City"                   : "Albuquerque",
      "State"                  : "NM",
      "StateName"              : "New Mexico",
      "Country"                : "United States",
      "CountryCode"            : "US",
      "Email"                  : "ExampleString",
      "Phone"                  : "480-309-6332",
      "Fax"                    : "480-309-6333",
      "PostCode"               : "87111",
      "POBox"                  : "true",
      "SaveToAddressBook"      : "true",
      "Type"                   : null,
      "TaxId"                  : null,
      "Department"             : "IT, Sales, Marketing",
      "ShowPickupAtCheckout"   : "true",
      "Validated"              : "true or false",
      "IsPrimaryAddress"       : "true",
      "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
    }
  ],
  "WebsiteUrl"             : "http://www.inksoft.com",
  "Fax"                    : "111-222-3333",
  "USFederalTaxId"         : "22-3333333",
  "USStateTaxId"           : "22-3333333",
  "CanadaBusinessNumber"   : "22-3333333",
  "IsUSTaxExempt"          : "true or false",
  "USTaxExemptionType"     : "NGO",
  "Discount"               : 22-3333333,
  "Note"                   : "Something about the company",
  "Phones"  : 
  [
    {
      "ID"            : 1000000,
      "Number"        : "888-222-3333",
      "Extension"     : "1234",
      "PhoneType"     : "Mobile",
      "IsSMSOptOut"   : "false"
    }
  ],
  "Tags"  : 
  [
    {
      "ID"      : 1000000,
      "Name"    : "Walter",
      "Count"   : 12
    }
  ],
  "Contacts"  : 
  [
    {
      "Fax"                     : "111-222-3333",
      "Note"                    : "Some details about the Contact",
      "SalesDocs"  : 
      [{"Name" : "example not found"}
      ],
      "PurchaseOrdersEnabled"   : "true",
      "PayLaterEnabled"         : "true",
      "Timeline"  : 
      [
        {
          "EventDescription"    : ,
          "ID"                  : 1,
          "ContactIds"          : [1,2,3],
          "CompanyIds"          : [1,2,3],
          "JobIds"              : [1,2,3],
          "OrderIds"            : [1,2,3],
          "ProposalIds"         : [1,2,3],
          "ProductionCardIds"   : [1,2,3],
          "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
          "Event"               : "ExampleString",
          "Comment"             : "ExampleString",
          "EventType"  : {"Name" : "example not found"},
          "Edited"              : "true",
          "EditedDate"          : "2017-10-30T07:00:00Z",
          "Deleted"             : "true",
          "DeletedDate"         : "2017-10-30T07:00:00Z",
          "Created"             : "2017-10-30T07:00:00Z",
          "CreatedByUserId"     : 1,
          "CreatedByName"       : "ExampleString",
          "Details"  : 
          [
            {
              "Property"   : "ExampleString",
              "OldValue"   : "ExampleString",
              "NewValue"   : "ExampleString",
              "Date"       : "2017-10-30T07:00:00Z"
            }
          ],
          "Associations"  : {"Name" : "example not found 2"}
        }
      ],
      "TierId"                  : 1,
      "Tiers"  : 
      [
        {
          "ID"         : 1000000,
          "Name"       : "Reseller",
          "UniqueId"   : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
          "Active"     : "true"
        }
      ],
      "IsTaxable"               : "true",
      "ID"                      : 1,
      "FirstName"               : "ExampleString",
      "LastName"                : "ExampleString",
      "JobTitle"                : "ExampleString",
      "Email"                   : "ExampleString",
      "Phones"  : 
      [
        {
          "ID"            : 1000000,
          "Number"        : "888-222-3333",
          "Extension"     : "1234",
          "PhoneType"     : "Mobile",
          "IsSMSOptOut"   : "false"
        }
      ],
      "ProfilePicture"          : "ExampleString",
      "Newsletter"              : "true",
      "Tags"  : 
      [
        {
          "ID"      : 1000000,
          "Name"    : "Walter",
          "Count"   : 12
        }
      ],
      "Store"  : 
      {
        "ID"                    : 1000000,
        "Uri"                   : "ExampleString",
        "Name"                  : "Walter",
        "Logo"                  : "logo.png",
        "AcceptPurchaseOrder"   : "true or false",
        "AllowPaymentLater"     : "true or false"
      },
      "Origin"  : 
      {
        "ID"      : 1000000,
        "Name"    : "Walter",
        "Image"   : "Walter",
        "Count"   : Walter
      },
      "Company"  : null,
      "PrimaryAddressId"        : 1,
      "Addresses"  : 
      [
        {
          "ID"                     : 1000014,
          "StateId"                : 4,
          "CountryId"              : 1,
          "Business"               : "true",
          "TaxExempt"              : "true",
          "FirstName"              : "John",
          "LastName"               : "Doe",
          "Name"                   : "John Doe",
          "CompanyName"            : "Doe Co",
          "Street1"                : "1234 Test St",
          "Street2"                : "Suite 500",
          "City"                   : "Albuquerque",
          "State"                  : "NM",
          "StateName"              : "New Mexico",
          "Country"                : "United States",
          "CountryCode"            : "US",
          "Email"                  : "ExampleString",
          "Phone"                  : "480-309-6332",
          "Fax"                    : "480-309-6333",
          "PostCode"               : "87111",
          "POBox"                  : "true",
          "SaveToAddressBook"      : "true",
          "Type"                   : null,
          "TaxId"                  : null,
          "Department"             : "IT, Sales, Marketing",
          "ShowPickupAtCheckout"   : "true",
          "Validated"              : "true or false",
          "IsPrimaryAddress"       : "true",
          "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
        }
      ],
      "Discount"                : 3.14,
      "BirthDate"               : "2017-10-30T07:00:00Z",
      "DateCreated"             : "2017-10-30T07:00:00Z",
      "LastModified"            : "2017-10-30T07:00:00Z",
      "ExternalReferenceId"     : "ExampleString",
      "StoreAnalyticsEnabled"   : "true"
    }
  ],
  "Timeline"  : 
  [
    {
      "EventDescription"    : ,
      "ID"                  : 1,
      "ContactIds"          : [1,2,3],
      "CompanyIds"          : [1,2,3],
      "JobIds"              : [1,2,3],
      "OrderIds"            : [1,2,3],
      "ProposalIds"         : [1,2,3],
      "ProductionCardIds"   : [1,2,3],
      "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
      "Event"               : "ExampleString",
      "Comment"             : "ExampleString",
      "EventType"  : {"Name" : "example not found 2"},
      "Edited"              : "true",
      "EditedDate"          : "2017-10-30T07:00:00Z",
      "Deleted"             : "true",
      "DeletedDate"         : "2017-10-30T07:00:00Z",
      "Created"             : "2017-10-30T07:00:00Z",
      "CreatedByUserId"     : 1,
      "CreatedByName"       : "ExampleString",
      "Details"  : 
      [
        {
          "Property"   : "ExampleString",
          "OldValue"   : "ExampleString",
          "NewValue"   : "ExampleString",
          "Date"       : "2017-10-30T07:00:00Z"
        }
      ],
      "Associations"  : {"Name" : "example not found 2"}
    }
  ]
}

 

Contact

ProductBase contains a small number of lightweight properties used to quickly search and display contacts. Inherited by [Object:User] for full Contact properties

Properties

  • Fax type: string

    Fax of the Contact

  • Note type: string

    Notes for the Contact

  • SalesDocs type: List of SalesDocSummary

    All the orders and proposals for the Contact

  • PurchaseOrdersEnabled type: boolean

    True when contact is able to use purchase orders

  • PayLaterEnabled type: boolean

    True when contact is able to pay later

  • Timeline type: List of TimelineEntry

  • TierId type: (nullable) integer

    TierId for the Contact

  • Tiers type: List of Tier

    List of all active Tiers

  • IsTaxable type: boolean

    True if the contact is taxable

  • ID type: integer

  • FirstName type: string

  • LastName type: string

  • JobTitle type: string

  • Email type: string

  • Phones type: List of Phone

  • ProfilePicture type: string

  • Newsletter type: boolean

  • Tags type: List of Tag

  • Store type: ContactStoreSummary

  • Origin type: Origin

  • Company type: Company

  • PrimaryAddressId type: (nullable) integer

  • Addresses type: List of Address

  • Discount type: (nullable) decimal

  • BirthDate type: (nullable) DateTime

  • DateCreated type: DateTime

  • LastModified type: DateTime

  • ExternalReferenceId type: string

  • StoreAnalyticsEnabled type: boolean 


{
  "Fax"                     : "111-222-3333",
  "Note"                    : "Some details about the Contact",
  "SalesDocs"  : 
  [{"Name" : "example not found 2"}
  ],
  "PurchaseOrdersEnabled"   : "true",
  "PayLaterEnabled"         : "true",
  "Timeline"  : 
  [
    {
      "EventDescription"    : ,
      "ID"                  : 1,
      "ContactIds"          : [1,2,3],
      "CompanyIds"          : [1,2,3],
      "JobIds"              : [1,2,3],
      "OrderIds"            : [1,2,3],
      "ProposalIds"         : [1,2,3],
      "ProductionCardIds"   : [1,2,3],
      "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
      "Event"               : "ExampleString",
      "Comment"             : "ExampleString",
      "EventType"  : {"Name" : "example not found 2"},
      "Edited"              : "true",
      "EditedDate"          : "2017-10-30T07:00:00Z",
      "Deleted"             : "true",
      "DeletedDate"         : "2017-10-30T07:00:00Z",
      "Created"             : "2017-10-30T07:00:00Z",
      "CreatedByUserId"     : 1,
      "CreatedByName"       : "ExampleString",
      "Details"  : 
      [
        {
          "Property"   : "ExampleString",
          "OldValue"   : "ExampleString",
          "NewValue"   : "ExampleString",
          "Date"       : "2017-10-30T07:00:00Z"
        }
      ],
      "Associations"  : {"Name" : "example not found 2"}
    }
  ],
  "TierId"                  : 1,
  "Tiers"  : 
  [
    {
      "ID"         : 1000000,
      "Name"       : "Reseller",
      "UniqueId"   : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
      "Active"     : "true"
    }
  ],
  "IsTaxable"               : "true",
  "ID"                      : 1,
  "FirstName"               : "ExampleString",
  "LastName"                : "ExampleString",
  "JobTitle"                : "ExampleString",
  "Email"                   : "ExampleString",
  "Phones"  : 
  [
    {
      "ID"            : 1000000,
      "Number"        : "888-222-3333",
      "Extension"     : "1234",
      "PhoneType"     : "Mobile",
      "IsSMSOptOut"   : "false"
    }
  ],
  "ProfilePicture"          : "ExampleString",
  "Newsletter"              : "true",
  "Tags"  : 
  [
    {
      "ID"      : 1000000,
      "Name"    : "Walter",
      "Count"   : 12
    }
  ],
  "Store"  : 
  {
    "ID"                    : 1000000,
    "Uri"                   : "ExampleString",
    "Name"                  : "Walter",
    "Logo"                  : "logo.png",
    "AcceptPurchaseOrder"   : "true or false",
    "AllowPaymentLater"     : "true or false"
  },
  "Origin"  : 
  {
    "ID"      : 1000000,
    "Name"    : "Walter",
    "Image"   : "Walter",
    "Count"   : Walter
  },
  "Company"  : 
  {
    "ID"                     : 1000000,
    "Name"                   : "Inksoft",
    "PrimaryContact"  : null,
    "PrimaryContactId"       : 1,
    "PrimaryAddress"  : 
    {
      "ID"                     : 1000014,
      "StateId"                : 4,
      "CountryId"              : 1,
      "Business"               : "true",
      "TaxExempt"              : "true",
      "FirstName"              : "John",
      "LastName"               : "Doe",
      "Name"                   : "John Doe",
      "CompanyName"            : "Doe Co",
      "Street1"                : "1234 Test St",
      "Street2"                : "Suite 500",
      "City"                   : "Albuquerque",
      "State"                  : "NM",
      "StateName"              : "New Mexico",
      "Country"                : "United States",
      "CountryCode"            : "US",
      "Email"                  : "ExampleString",
      "Phone"                  : "480-309-6332",
      "Fax"                    : "480-309-6333",
      "PostCode"               : "87111",
      "POBox"                  : "true",
      "SaveToAddressBook"      : "true",
      "Type"                   : null,
      "TaxId"                  : null,
      "Department"             : "IT, Sales, Marketing",
      "ShowPickupAtCheckout"   : "true",
      "Validated"              : "true or false",
      "IsPrimaryAddress"       : "true",
      "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
    },
    "PrimaryAddressId"       : 1,
    "Addresses"  : 
    [
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      }
    ],
    "WebsiteUrl"             : "http://www.inksoft.com",
    "Fax"                    : "111-222-3333",
    "USFederalTaxId"         : "22-3333333",
    "USStateTaxId"           : "22-3333333",
    "CanadaBusinessNumber"   : "22-3333333",
    "IsUSTaxExempt"          : "true or false",
    "USTaxExemptionType"     : "NGO",
    "Discount"               : 22-3333333,
    "Note"                   : "Something about the company",
    "Phones"  : 
    [
      {
        "ID"            : 1000000,
        "Number"        : "888-222-3333",
        "Extension"     : "1234",
        "PhoneType"     : "Mobile",
        "IsSMSOptOut"   : "false"
      }
    ],
    "Tags"  : 
    [
      {
        "ID"      : 1000000,
        "Name"    : "Walter",
        "Count"   : 12
      }
    ],
    "Contacts"  : 
    [null
    ],
    "Timeline"  : 
    [
      {
        "EventDescription"    : ,
        "ID"                  : 1,
        "ContactIds"          : [1,2,3],
        "CompanyIds"          : [1,2,3],
        "JobIds"              : [1,2,3],
        "OrderIds"            : [1,2,3],
        "ProposalIds"         : [1,2,3],
        "ProductionCardIds"   : [1,2,3],
        "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
        "Event"               : "ExampleString",
        "Comment"             : "ExampleString",
        "EventType"  : {"Name" : "example not found 2"},
        "Edited"              : "true",
        "EditedDate"          : "2017-10-30T07:00:00Z",
        "Deleted"             : "true",
        "DeletedDate"         : "2017-10-30T07:00:00Z",
        "Created"             : "2017-10-30T07:00:00Z",
        "CreatedByUserId"     : 1,
        "CreatedByName"       : "ExampleString",
        "Details"  : 
        [
          {
            "Property"   : "ExampleString",
            "OldValue"   : "ExampleString",
            "NewValue"   : "ExampleString",
            "Date"       : "2017-10-30T07:00:00Z"
          }
        ],
        "Associations"  : {"Name" : "example not found 2"}
      }
    ]
  },
  "PrimaryAddressId"        : 1,
  "Addresses"  : 
  [
    {
      "ID"                     : 1000014,
      "StateId"                : 4,
      "CountryId"              : 1,
      "Business"               : "true",
      "TaxExempt"              : "true",
      "FirstName"              : "John",
      "LastName"               : "Doe",
      "Name"                   : "John Doe",
      "CompanyName"            : "Doe Co",
      "Street1"                : "1234 Test St",
      "Street2"                : "Suite 500",
      "City"                   : "Albuquerque",
      "State"                  : "NM",
      "StateName"              : "New Mexico",
      "Country"                : "United States",
      "CountryCode"            : "US",
      "Email"                  : "ExampleString",
      "Phone"                  : "480-309-6332",
      "Fax"                    : "480-309-6333",
      "PostCode"               : "87111",
      "POBox"                  : "true",
      "SaveToAddressBook"      : "true",
      "Type"                   : null,
      "TaxId"                  : null,
      "Department"             : "IT, Sales, Marketing",
      "ShowPickupAtCheckout"   : "true",
      "Validated"              : "true or false",
      "IsPrimaryAddress"       : "true",
      "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
    }
  ],
  "Discount"                : 3.14,
  "BirthDate"               : "2017-10-30T07:00:00Z",
  "DateCreated"             : "2017-10-30T07:00:00Z",
  "LastModified"            : "2017-10-30T07:00:00Z",
  "ExternalReferenceId"     : "ExampleString",
  "StoreAnalyticsEnabled"   : "true"
}

 

ContactBase

ContactBase contains a small number of lightweight properties used to quickly search and display contacts. Inherited by [Object:User] for full Contact properties

Properties

  • Phones type: List of Phone

    The Phone of the Contact

  • Tags type: List of Tag

    Tags for the Contacts

  • Addresses type: List of Address

    Primary Address or First Address for the contact

  • ID type: integer

    A unique integer ID for this contact

  • FirstName type: string

    The first name of the Contact

  • LastName type: string

    The last name of the Contact

  • JobTitle type: string

    The Job Title of the Contact

  • Email type: string

    The email of the Contact

  • ProfilePicture type: string

    The ProfilePicture of the Contact

  • Newsletter type: boolean

    True if the contact has elected to receive our newsletter

  • Store type: ContactStoreSummary

    Store Id and Name associated with the contact

  • Origin type: Origin

    Origin Id and Name

  • Company type: Company

    Company Object

  • PrimaryAddressId type: (nullable) integer

    Primary Address ID for the Contact

  • Discount type: (nullable) decimal

    VIP Discount for the Contact

  • BirthDate type: (nullable) DateTime

    Birth Date of the Contact

  • DateCreated type: DateTime

    DateCreated Date for the Contact

  • LastModified type: DateTime

    LastModified Date for the Contact

  • ExternalReferenceId type: string

    External Reference Id to associate the Contact in another system Stored as a 32 character limit string

  • StoreAnalyticsEnabled type: boolean

    True when the contact has access to the store analytics feature This property isn't mapped directly to the contact (user), it depends on the `store_user_roles` table and it is handled at the controller level for APIs `Api2/GetContact` and `Api2/SaveContact` 


{
  "Phones"  : 
  [
    {
      "ID"            : 1000000,
      "Number"        : "888-222-3333",
      "Extension"     : "1234",
      "PhoneType"     : "Mobile",
      "IsSMSOptOut"   : "false"
    }
  ],
  "Tags"  : 
  [
    {
      "ID"      : 1000000,
      "Name"    : "Walter",
      "Count"   : 12
    }
  ],
  "Addresses"  : 
  [
    {
      "ID"                     : 1000014,
      "StateId"                : 4,
      "CountryId"              : 1,
      "Business"               : "true",
      "TaxExempt"              : "true",
      "FirstName"              : "John",
      "LastName"               : "Doe",
      "Name"                   : "John Doe",
      "CompanyName"            : "Doe Co",
      "Street1"                : "1234 Test St",
      "Street2"                : "Suite 500",
      "City"                   : "Albuquerque",
      "State"                  : "NM",
      "StateName"              : "New Mexico",
      "Country"                : "United States",
      "CountryCode"            : "US",
      "Email"                  : "ExampleString",
      "Phone"                  : "480-309-6332",
      "Fax"                    : "480-309-6333",
      "PostCode"               : "87111",
      "POBox"                  : "true",
      "SaveToAddressBook"      : "true",
      "Type"                   : null,
      "TaxId"                  : null,
      "Department"             : "IT, Sales, Marketing",
      "ShowPickupAtCheckout"   : "true",
      "Validated"              : "true or false",
      "IsPrimaryAddress"       : "true",
      "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
    }
  ],
  "ID"                      : 1000000,
  "FirstName"               : "Walter",
  "LastName"                : "White",
  "JobTitle"                : "Owner",
  "Email"                   : "email@walterwhite.com",
  "ProfilePicture"          : "email@walterwhite.com",
  "Newsletter"              : "true",
  "Store"  : 
  {
    "ID"                    : 1000000,
    "Uri"                   : "ExampleString",
    "Name"                  : "Walter",
    "Logo"                  : "logo.png",
    "AcceptPurchaseOrder"   : "true or false",
    "AllowPaymentLater"     : "true or false"
  },
  "Origin"  : 
  {
    "ID"      : 1000000,
    "Name"    : "Walter",
    "Image"   : "Walter",
    "Count"   : Walter
  },
  "Company"  : 
  {
    "ID"                     : 1000000,
    "Name"                   : "Inksoft",
    "PrimaryContact"  : 
    {
      "Fax"                     : "111-222-3333",
      "Note"                    : "Some details about the Contact",
      "SalesDocs"  : 
      [{"Name" : "example not found 2"}
      ],
      "PurchaseOrdersEnabled"   : "true",
      "PayLaterEnabled"         : "true",
      "Timeline"  : 
      [
        {
          "EventDescription"    : ,
          "ID"                  : 1,
          "ContactIds"          : [1,2,3],
          "CompanyIds"          : [1,2,3],
          "JobIds"              : [1,2,3],
          "OrderIds"            : [1,2,3],
          "ProposalIds"         : [1,2,3],
          "ProductionCardIds"   : [1,2,3],
          "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
          "Event"               : "ExampleString",
          "Comment"             : "ExampleString",
          "EventType"  : {"Name" : "example not found 2"},
          "Edited"              : "true",
          "EditedDate"          : "2017-10-30T07:00:00Z",
          "Deleted"             : "true",
          "DeletedDate"         : "2017-10-30T07:00:00Z",
          "Created"             : "2017-10-30T07:00:00Z",
          "CreatedByUserId"     : 1,
          "CreatedByName"       : "ExampleString",
          "Details"  : 
          [
            {
              "Property"   : "ExampleString",
              "OldValue"   : "ExampleString",
              "NewValue"   : "ExampleString",
              "Date"       : "2017-10-30T07:00:00Z"
            }
          ],
          "Associations"  : {"Name" : "example not found 2"}
        }
      ],
      "TierId"                  : 1,
      "Tiers"  : 
      [
        {
          "ID"         : 1000000,
          "Name"       : "Reseller",
          "UniqueId"   : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
          "Active"     : "true"
        }
      ],
      "IsTaxable"               : "true",
      "ID"                      : 1,
      "FirstName"               : "ExampleString",
      "LastName"                : "ExampleString",
      "JobTitle"                : "ExampleString",
      "Email"                   : "ExampleString",
      "Phones"  : 
      [
        {
          "ID"            : 1000000,
          "Number"        : "888-222-3333",
          "Extension"     : "1234",
          "PhoneType"     : "Mobile",
          "IsSMSOptOut"   : "false"
        }
      ],
      "ProfilePicture"          : "ExampleString",
      "Newsletter"              : "true",
      "Tags"  : 
      [
        {
          "ID"      : 1000000,
          "Name"    : "Walter",
          "Count"   : 12
        }
      ],
      "Store"  : 
      {
        "ID"                    : 1000000,
        "Uri"                   : "ExampleString",
        "Name"                  : "Walter",
        "Logo"                  : "logo.png",
        "AcceptPurchaseOrder"   : "true or false",
        "AllowPaymentLater"     : "true or false"
      },
      "Origin"  : 
      {
        "ID"      : 1000000,
        "Name"    : "Walter",
        "Image"   : "Walter",
        "Count"   : Walter
      },
      "Company"  : null,
      "PrimaryAddressId"        : 1,
      "Addresses"  : 
      [
        {
          "ID"                     : 1000014,
          "StateId"                : 4,
          "CountryId"              : 1,
          "Business"               : "true",
          "TaxExempt"              : "true",
          "FirstName"              : "John",
          "LastName"               : "Doe",
          "Name"                   : "John Doe",
          "CompanyName"            : "Doe Co",
          "Street1"                : "1234 Test St",
          "Street2"                : "Suite 500",
          "City"                   : "Albuquerque",
          "State"                  : "NM",
          "StateName"              : "New Mexico",
          "Country"                : "United States",
          "CountryCode"            : "US",
          "Email"                  : "ExampleString",
          "Phone"                  : "480-309-6332",
          "Fax"                    : "480-309-6333",
          "PostCode"               : "87111",
          "POBox"                  : "true",
          "SaveToAddressBook"      : "true",
          "Type"                   : null,
          "TaxId"                  : null,
          "Department"             : "IT, Sales, Marketing",
          "ShowPickupAtCheckout"   : "true",
          "Validated"              : "true or false",
          "IsPrimaryAddress"       : "true",
          "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
        }
      ],
      "Discount"                : 3.14,
      "BirthDate"               : "2017-10-30T07:00:00Z",
      "DateCreated"             : "2017-10-30T07:00:00Z",
      "LastModified"            : "2017-10-30T07:00:00Z",
      "ExternalReferenceId"     : "ExampleString",
      "StoreAnalyticsEnabled"   : "true"
    },
    "PrimaryContactId"       : 1,
    "PrimaryAddress"  : 
    {
      "ID"                     : 1000014,
      "StateId"                : 4,
      "CountryId"              : 1,
      "Business"               : "true",
      "TaxExempt"              : "true",
      "FirstName"              : "John",
      "LastName"               : "Doe",
      "Name"                   : "John Doe",
      "CompanyName"            : "Doe Co",
      "Street1"                : "1234 Test St",
      "Street2"                : "Suite 500",
      "City"                   : "Albuquerque",
      "State"                  : "NM",
      "StateName"              : "New Mexico",
      "Country"                : "United States",
      "CountryCode"            : "US",
      "Email"                  : "ExampleString",
      "Phone"                  : "480-309-6332",
      "Fax"                    : "480-309-6333",
      "PostCode"               : "87111",
      "POBox"                  : "true",
      "SaveToAddressBook"      : "true",
      "Type"                   : null,
      "TaxId"                  : null,
      "Department"             : "IT, Sales, Marketing",
      "ShowPickupAtCheckout"   : "true",
      "Validated"              : "true or false",
      "IsPrimaryAddress"       : "true",
      "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
    },
    "PrimaryAddressId"       : 1,
    "Addresses"  : 
    [
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      }
    ],
    "WebsiteUrl"             : "http://www.inksoft.com",
    "Fax"                    : "111-222-3333",
    "USFederalTaxId"         : "22-3333333",
    "USStateTaxId"           : "22-3333333",
    "CanadaBusinessNumber"   : "22-3333333",
    "IsUSTaxExempt"          : "true or false",
    "USTaxExemptionType"     : "NGO",
    "Discount"               : 22-3333333,
    "Note"                   : "Something about the company",
    "Phones"  : 
    [
      {
        "ID"            : 1000000,
        "Number"        : "888-222-3333",
        "Extension"     : "1234",
        "PhoneType"     : "Mobile",
        "IsSMSOptOut"   : "false"
      }
    ],
    "Tags"  : 
    [
      {
        "ID"      : 1000000,
        "Name"    : "Walter",
        "Count"   : 12
      }
    ],
    "Contacts"  : 
    [
      {
        "Fax"                     : "111-222-3333",
        "Note"                    : "Some details about the Contact",
        "SalesDocs"  : 
        [{"Name" : "example not found 2"}
        ],
        "PurchaseOrdersEnabled"   : "true",
        "PayLaterEnabled"         : "true",
        "Timeline"  : 
        [
          {
            "EventDescription"    : ,
            "ID"                  : 1,
            "ContactIds"          : [1,2,3],
            "CompanyIds"          : [1,2,3],
            "JobIds"              : [1,2,3],
            "OrderIds"            : [1,2,3],
            "ProposalIds"         : [1,2,3],
            "ProductionCardIds"   : [1,2,3],
            "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
            "Event"               : "ExampleString",
            "Comment"             : "ExampleString",
            "EventType"  : {"Name" : "example not found 2"},
            "Edited"              : "true",
            "EditedDate"          : "2017-10-30T07:00:00Z",
            "Deleted"             : "true",
            "DeletedDate"         : "2017-10-30T07:00:00Z",
            "Created"             : "2017-10-30T07:00:00Z",
            "CreatedByUserId"     : 1,
            "CreatedByName"       : "ExampleString",
            "Details"  : 
            [
              {
                "Property"   : "ExampleString",
                "OldValue"   : "ExampleString",
                "NewValue"   : "ExampleString",
                "Date"       : "2017-10-30T07:00:00Z"
              }
            ],
            "Associations"  : {"Name" : "example not found 2"}
          }
        ],
        "TierId"                  : 1,
        "Tiers"  : 
        [
          {
            "ID"         : 1000000,
            "Name"       : "Reseller",
            "UniqueId"   : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
            "Active"     : "true"
          }
        ],
        "IsTaxable"               : "true",
        "ID"                      : 1,
        "FirstName"               : "ExampleString",
        "LastName"                : "ExampleString",
        "JobTitle"                : "ExampleString",
        "Email"                   : "ExampleString",
        "Phones"  : 
        [
          {
            "ID"            : 1000000,
            "Number"        : "888-222-3333",
            "Extension"     : "1234",
            "PhoneType"     : "Mobile",
            "IsSMSOptOut"   : "false"
          }
        ],
        "ProfilePicture"          : "ExampleString",
        "Newsletter"              : "true",
        "Tags"  : 
        [
          {
            "ID"      : 1000000,
            "Name"    : "Walter",
            "Count"   : 12
          }
        ],
        "Store"  : 
        {
          "ID"                    : 1000000,
          "Uri"                   : "ExampleString",
          "Name"                  : "Walter",
          "Logo"                  : "logo.png",
          "AcceptPurchaseOrder"   : "true or false",
          "AllowPaymentLater"     : "true or false"
        },
        "Origin"  : 
        {
          "ID"      : 1000000,
          "Name"    : "Walter",
          "Image"   : "Walter",
          "Count"   : Walter
        },
        "Company"  : null,
        "PrimaryAddressId"        : 1,
        "Addresses"  : 
        [
          {
            "ID"                     : 1000014,
            "StateId"                : 4,
            "CountryId"              : 1,
            "Business"               : "true",
            "TaxExempt"              : "true",
            "FirstName"              : "John",
            "LastName"               : "Doe",
            "Name"                   : "John Doe",
            "CompanyName"            : "Doe Co",
            "Street1"                : "1234 Test St",
            "Street2"                : "Suite 500",
            "City"                   : "Albuquerque",
            "State"                  : "NM",
            "StateName"              : "New Mexico",
            "Country"                : "United States",
            "CountryCode"            : "US",
            "Email"                  : "ExampleString",
            "Phone"                  : "480-309-6332",
            "Fax"                    : "480-309-6333",
            "PostCode"               : "87111",
            "POBox"                  : "true",
            "SaveToAddressBook"      : "true",
            "Type"                   : null,
            "TaxId"                  : null,
            "Department"             : "IT, Sales, Marketing",
            "ShowPickupAtCheckout"   : "true",
            "Validated"              : "true or false",
            "IsPrimaryAddress"       : "true",
            "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
          }
        ],
        "Discount"                : 3.14,
        "BirthDate"               : "2017-10-30T07:00:00Z",
        "DateCreated"             : "2017-10-30T07:00:00Z",
        "LastModified"            : "2017-10-30T07:00:00Z",
        "ExternalReferenceId"     : "ExampleString",
        "StoreAnalyticsEnabled"   : "true"
      }
    ],
    "Timeline"  : 
    [
      {
        "EventDescription"    : ,
        "ID"                  : 1,
        "ContactIds"          : [1,2,3],
        "CompanyIds"          : [1,2,3],
        "JobIds"              : [1,2,3],
        "OrderIds"            : [1,2,3],
        "ProposalIds"         : [1,2,3],
        "ProductionCardIds"   : [1,2,3],
        "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
        "Event"               : "ExampleString",
        "Comment"             : "ExampleString",
        "EventType"  : {"Name" : "example not found 2"},
        "Edited"              : "true",
        "EditedDate"          : "2017-10-30T07:00:00Z",
        "Deleted"             : "true",
        "DeletedDate"         : "2017-10-30T07:00:00Z",
        "Created"             : "2017-10-30T07:00:00Z",
        "CreatedByUserId"     : 1,
        "CreatedByName"       : "ExampleString",
        "Details"  : 
        [
          {
            "Property"   : "ExampleString",
            "OldValue"   : "ExampleString",
            "NewValue"   : "ExampleString",
            "Date"       : "2017-10-30T07:00:00Z"
          }
        ],
        "Associations"  : {"Name" : "example not found 2"}
      }
    ]
  },
  "PrimaryAddressId"        : 1,
  "Discount"                : VIP Discount for the Contact,
  "BirthDate"               : "2017-10-30T07:00:00Z",
  "DateCreated"             : "2017-01-01",
  "LastModified"            : "2017-01-01",
  "ExternalReferenceId"     : "H32504E04F8911D39AAC0305E82C4201",
  "StoreAnalyticsEnabled"   : "true"
}

 

ContactStoreSummary

ContactStoreSummary contains a small number of lightweight properties used to quickly search and display Store for the Contact.

Properties

  • ID type: integer

    A unique integer ID for the Store

  • Uri type: string

    The Uri of the store

  • Name type: string

    The Name of the Store

  • Logo type: string

    The Logo of the Store

  • AcceptPurchaseOrder type: boolean

    Accept Purchase Order or not

  • AllowPaymentLater type: boolean

    Allow Payment later or not 


{
  "ID"                    : 1000000,
  "Uri"                   : "ExampleString",
  "Name"                  : "Walter",
  "Logo"                  : "logo.png",
  "AcceptPurchaseOrder"   : "true or false",
  "AllowPaymentLater"     : "true or false"
}

 

Countdown

Properties

  • ID type: integer

  • GoalType type: CountdownGoalType

  • EndDate type: (nullable) DateTime

  • EndTime type: string

  • OffsetGmt type: integer

  • TimeZoneId type: integer

  • DisableOnEndDate type: boolean

  • NotificationContacts type: List of string

  • NotificationEnabled type: (nullable) boolean

  • Active type: boolean

  • Published type: boolean 


{
  "ID"                     : 1,
  "GoalType"  : {"Name" : "example not found 2"},
  "EndDate"                : "2017-10-30T07:00:00Z",
  "EndTime"                : "ExampleString",
  "OffsetGmt"              : 1,
  "TimeZoneId"             : 1,
  "DisableOnEndDate"       : "true",
  "NotificationContacts"   : [ExampleString,ExampleString,ExampleString],
  "NotificationEnabled"    : "true",
  "Active"                 : "true",
  "Published"              : "true"
}

 

Country

A country/nation

Properties

  • ID type: integer

    A unique integer ID for this country

  • Code type: string

    The two-digit code for this country(US, FR, DE, etc)

  • Name type: string

    The name of this country

  • PostCodeSupported type: boolean

    True if postal code is supported for this country

  • PostCodeRequired type: boolean

    True if postal code is required for this country 


{
  "ID"                  : 100001,
  "Code"                : "US",
  "Name"                : "United States",
  "PostCodeSupported"   : "true",
  "PostCodeRequired"    : "true"
}

 

CreditCard

Properties

  • Number type: string

  • ExpirationMonth type: integer

  • ExpirationYear type: integer

  • CVV type: string

  • Last4Digits type: string 


{
  "Number"            : "ExampleString",
  "ExpirationMonth"   : 1,
  "ExpirationYear"    : 1,
  "CVV"               : "ExampleString",
  "Last4Digits"       : "ExampleString"
}

 

CustomLineItem

A service / fee associated with a proposal or order If reusable, it will not be associated with a service or order

Properties

  • ID type: integer

    The unique integer ID of the custom line item

  • ParentId type: (nullable) integer

    The ID of the reusable line item from which this item was created

  • UniqueId type: (nullable) guid

    The unique ID of the custom line item

  • Name type: string

    The name of the item

  • Description type: string

    A description of the item

  • ImageUrl type: string

    The URL of the image for this item (if any)

  • Taxable type: boolean

    True if the item is taxable

  • TaxRate type: (nullable) decimal

    The custom tax rate for this item, if any

  • TaxRateOverride type: (nullable) decimal

    The custom tax rate override for this item, if any

  • UnitCost type: (nullable) decimal

    The cost per unit

  • UnitPrice type: decimal

    The price per unit

  • UnitWeight type: (nullable) decimal

    The weight per unit in ounces, divide by 16 for pounds

  • Quantity type: (nullable) integer

    The quantity of units

  • UnitType type: ServiceUnitType

    The type of the unit (PerHour, PerItem)

  • Active type: boolean

    True if the item is active

  • Size type: string

    The size for the each style in the custom line item

  • Style type: string

    The style of the custom line item

  • CustomLineItemImages type: List of CustomLineItemImage 


{
  "ID"                     : 1,
  "ParentId"               : 1,
  "UniqueId"               : "",
  "Name"                   : "ExampleString",
  "Description"            : "ExampleString",
  "ImageUrl"               : "ExampleString",
  "Taxable"                : "true",
  "TaxRate"                : 3.14,
  "TaxRateOverride"        : 3.14,
  "UnitCost"               : 3.14,
  "UnitPrice"              : 3.14,
  "UnitWeight"             : 3.14,
  "Quantity"               : 1,
  "UnitType"  : {"Name" : "example not found 2"},
  "Active"                 : "true",
  "Size"                   : "ExampleString",
  "Style"                  : "ExampleString",
  "CustomLineItemImages"  : 
  [
    {
      "ID"         : 1,
      "UniqueId"   : "",
      "ImageUrl"   : "ExampleString",
      "Deleted"    : "true"
    }
  ]
}

 

CustomLineItemImage

Properties

  • ID type: integer

    The unique integer ID of the custom line item images

  • UniqueId type: (nullable) guid

    The uniqueId for each style from the custom line item

  • ImageUrl type: string

    The URL of the image for this item (if any)

  • Deleted type: boolean

    True if the image is deleted 


{
  "ID"         : 1,
  "UniqueId"   : "",
  "ImageUrl"   : "ExampleString",
  "Deleted"    : "true"
}

 

DateTimeRange

Properties

  • UtcOffsetHours type: (nullable) decimal

  • Begin type: (nullable) DateTime

  • End type: (nullable) DateTime 


{
  "UtcOffsetHours"   : 3.14,
  "Begin"            : "2017-10-30T07:00:00Z",
  "End"              : "2017-10-30T07:00:00Z"
}

 

DecoratedProductRegion

Properties

  • ImageFilename type: string

  • Region type: Rectangle

  • RegionString type: string 


{
  "ImageFilename"   : "ExampleString",
  "Region"  : 
  {
    "X"          : 3.14,
    "Y"          : 3.14,
    "Width"      : 3.14,
    "Height"     : 3.14,
    "Rotation"   : 3.14
  },
  "RegionString"    : "ExampleString"
}

 

DecoratedProductSide

Properties

  • ProductFilename type: string

  • ProductWidth type: (nullable) integer

  • ProductHeight type: (nullable) integer

  • Side type: string

  • Images type: List of DecoratedProductRegion 


{
  "ProductFilename"   : "ExampleString",
  "ProductWidth"      : 1,
  "ProductHeight"     : 1,
  "Side"              : "ExampleString",
  "Images"  : 
  [
    {
      "ImageFilename"   : "ExampleString",
      "Region"  : 
      {
        "X"          : 3.14,
        "Y"          : 3.14,
        "Width"      : 3.14,
        "Height"     : 3.14,
        "Rotation"   : 3.14
      },
      "RegionString"    : "ExampleString"
    }
  ]
}

 

DesignArtRegion

A representation of art that should be placed on the style

Properties

  • RegionName type: string

    The name of the product region this art was placed in.

  • SideId type: string

    The side that this SideDecorationSummary corresponds to - "front", "back", "sleeveleft", or "sleeveright"

  • ColorCount type: (nullable) integer

    The number of colors in the art on this side (applicable only if DecorationMethod = ScreenPrint)

  • ArtId type: (nullable) integer

    The ID of the art that should be placed on this product style's side.

  • DistressId type: (nullable) integer

    The ID of the distress pattern, if any

  • ArtRegion type: ProductRegion

    The placement of the art on this side of the product. Coordinates are based from the top left of the 500.png product style image.

  • DecorationMethod type: DecorationMethod

    Decoration Method to be used for side in this design

  • MatchFileColor type: boolean

    True if any art in the art region is flagged to match file color. When true the saved canvas will be marked in production and order details to match the color of art files. 


{
  "RegionName"         : "ExampleString",
  "SideId"             : "ExampleString",
  "ColorCount"         : 1,
  "ArtId"              : 1,
  "DistressId"         : 1,
  "ArtRegion"  : 
  {
    "ID"                          : 1000001,
    "Name"                        : "Full",
    "X"                           : 10,
    "Y"                           : 10,
    "Width"                       : 100,
    "Height"                      : 200,
    "Rotation"                    : null,
    "Shape"                       : null,
    "Side"                        : "front",
    "IsDefault"                   : "true",
    "ProductRegionRenderSizeId"   : 1,
    "RenderWidthInches"           : null,
    "RenderHeightInches"          : null
  },
  "DecorationMethod"  : {"Name" : "example not found 2"},
  "MatchFileColor"     : "true"
}

 

DesignStudioPrepareParameters

Properties

  • UserEmail type: string

  • NewUserPassword type: string

  • NewUserFirstName type: string

  • NewUserLastName type: string

  • ProductSku type: string

  • ProductStyleName type: string 


{
  "UserEmail"          : "ExampleString",
  "NewUserPassword"    : "ExampleString",
  "NewUserFirstName"   : "ExampleString",
  "NewUserLastName"    : "ExampleString",
  "ProductSku"         : "ExampleString",
  "ProductStyleName"   : "ExampleString"
}

 

DesignStudioPrepareValues

Properties

  • UserId type: (nullable) integer

  • ProductId type: (nullable) integer

  • ProductStyleId type: (nullable) integer 


{
  "UserId"           : 1,
  "ProductId"        : 1,
  "ProductStyleId"   : 1
}

 

DesignSummary

Properties

  • DesignID type: integer

  • UserID type: (nullable) integer

  • UserEmail type: string

  • Uri type: string

  • DesignedOnSku type: string

  • DesignedOnStyleName type: string

  • DesignedOnProductId type: (nullable) integer

  • DesignedOnProductStyleId type: (nullable) integer

  • Canvases type: List of CanvasSummary

  • LastModified type: DateTime

  • Name type: string

  • Notes type: string 


{
  "DesignID"                   : 1,
  "UserID"                     : 1,
  "UserEmail"                  : "ExampleString",
  "Uri"                        : "ExampleString",
  "DesignedOnSku"              : "ExampleString",
  "DesignedOnStyleName"        : "ExampleString",
  "DesignedOnProductId"        : 1,
  "DesignedOnProductStyleId"   : 1,
  "Canvases"  : 
  [{"Name" : "example not found 2"}
  ],
  "LastModified"               : "2017-10-30T07:00:00Z",
  "Name"                       : "ExampleString",
  "Notes"                      : "ExampleString"
}

 

Discount

A discount

Properties

  • ID type: integer

    A unique integer ID for this discount

  • CouponCode type: string

    The code to be entered by the customer to apply this discount

  • Description type: string

    A description of this discount

  • DiscountCode type: string

    A code describing this discount

  • ExcludeDesigns type: string

    True if designs are excluded from this discount. If true, OnlyDesigns must be false

  • ExcludeProducts type: string

    True if products are excluded from this discount. If true, OnlyProducts must be false

  • ExcludeProductStyles type: string

    True if product styles are excluded from this discount. If true, OnlyProductStyles must be false

  • ExcludeShippingMethods type: string

    True if shipping methods are excluded from this discount

  • ExcludeStores type: string

    True if stores are excluded from this discount. If true, OnlyStores must be false

  • Name type: string

    The name of this discount

  • OnlyDesigns type: string

    A comma-delimited list of IDs of designs for which this discount is valid. The discount is not valid on any designs not in the list

  • OnlyProducts type: string

    A comma-delimited list of IDs of products for which this discount is valid. The discount is not valid on any products not in the list

  • OnlyProductStyles type: string

    A comma-delimited list of IDs of product styles for which this discount is valid. The discount is not valid on any product styles not in the list

  • OnlyStores type: string

    A comma-delimited list of IDs of stores for which this discount is valid. The discount is not valid on any stores not in the list

  • DiscountItems type: boolean

    True if this discount applies to items in the cart

  • DiscountShipping type: boolean

    True if shipping should be discounted

  • DiscountPickup type: boolean

    True if pickup should be discounted

  • RequiresCoupon type: boolean

    True if this discount requires a coupon

  • DiscountAmount type: (nullable) decimal

    The amount of the discount, if amount based. If DiscountAmount is specified, DiscountPercent will be null

  • DiscountPercent type: (nullable) decimal

    The amount of the discount, if percent based. If DiscountPercent is specified, DiscountAmount will be null

  • MinItemTotal type: (nullable) decimal

    The minimum item total required for this discount to be applied, if any

  • MinItemCount type: (nullable) byte

    The minimum item count required for this discount to be applied, if any

  • EffectiveDate type: DateTime

    The beginning date for which this discount if valid

  • ExpirationDate type: DateTime

    The date this discount expires

  • AutomaticDiscount type: boolean

    Determine if it is an automatically applied discount 


{
  "ID"                       : 100000,
  "CouponCode"               : "sale",
  "Description"              : null,
  "DiscountCode"             : "ExampleString",
  "ExcludeDesigns"           : "ExampleString",
  "ExcludeProducts"          : "ExampleString",
  "ExcludeProductStyles"     : "ExampleString",
  "ExcludeShippingMethods"   : "ExampleString",
  "ExcludeStores"            : "ExampleString",
  "Name"                     : "Promotion",
  "OnlyDesigns"              : "ExampleString",
  "OnlyProducts"             : "ExampleString",
  "OnlyProductStyles"        : "ExampleString",
  "OnlyStores"               : "ExampleString",
  "DiscountItems"            : "true",
  "DiscountShipping"         : "true",
  "DiscountPickup"           : "true",
  "RequiresCoupon"           : "true",
  "DiscountAmount"           : 30.00,
  "DiscountPercent"          : null,
  "MinItemTotal"             : null,
  "MinItemCount"             : "3",
  "EffectiveDate"            : "2017-10-30T07:00:00Z",
  "ExpirationDate"           : "2018-10-30T07:00:00Z",
  "AutomaticDiscount"        : "true"
}

 

Fundraiser

Properties

  • PublisherId type: (nullable) integer

  • StoreId type: (nullable) integer

  • StoreName type: string

  • CurrencySymbol type: string

  • GoalValue type: (nullable) integer

  • PayoutAmount type: (nullable) decimal

  • StartDate type: DateTime

  • PayoutMetricType type: (nullable) FundraiserPayoutMetricType

  • PayoutMetricValue type: (nullable) decimal

  • DisableWhenGoalMet type: boolean

  • GoalDescription type: string

  • ID type: integer

  • GoalType type: CountdownGoalType

  • EndDate type: (nullable) DateTime

  • EndTime type: string

  • OffsetGmt type: integer

  • TimeZoneId type: integer

  • DisableOnEndDate type: boolean

  • NotificationContacts type: List of string

  • NotificationEnabled type: (nullable) boolean

  • Active type: boolean

  • Published type: boolean 


{
  "PublisherId"            : 1,
  "StoreId"                : 1,
  "StoreName"              : "ExampleString",
  "CurrencySymbol"         : "ExampleString",
  "GoalValue"              : 1,
  "PayoutAmount"           : 3.14,
  "StartDate"              : "2017-10-30T07:00:00Z",
  "PayoutMetricType"       : "",
  "PayoutMetricValue"      : 3.14,
  "DisableWhenGoalMet"     : "true",
  "GoalDescription"        : "ExampleString",
  "ID"                     : 1,
  "GoalType"  : {"Name" : "example not found 2"},
  "EndDate"                : "2017-10-30T07:00:00Z",
  "EndTime"                : "ExampleString",
  "OffsetGmt"              : 1,
  "TimeZoneId"             : 1,
  "DisableOnEndDate"       : "true",
  "NotificationContacts"   : [ExampleString,ExampleString,ExampleString],
  "NotificationEnabled"    : "true",
  "Active"                 : "true",
  "Published"              : "true"
}

 

GiftCertificate

A gift certificate

Properties

  • Amount type: decimal

    The amount for which this gift certificate can be redeemed

  • AppliedAmount type: (nullable) decimal

    The amount on this gift certificate that is being applied to the current cart. Only has a value if this gift certificate is returned as part of a cart.

  • InitialPurchaseAmount type: decimal

    The initial amount the gift certificate was for

  • Created type: DateTime

    The date the gift certificate was created

  • DateSent type: (nullable) DateTime

    The date the gift certificate was issued

  • HasOrders type: boolean

    True if this gift certificate has ever been used to pay for an order.

  • Number type: string

    The number that must be enetered by the user to apply this gift certificate during checkout

  • ToName type: string

    The name for whom gift certificate was sent

  • ToEmail type: string

    The email for whom gift certificate was sent 


{
  "Amount"                  : 34.00,
  "AppliedAmount"           : 34.00,
  "InitialPurchaseAmount"   : 3.14,
  "Created"                 : "2017-10-30T07:00:00Z",
  "DateSent"                : "2017-10-30T07:00:00Z",
  "HasOrders"               : "true",
  "Number"                  : "CA77-EE66-GD6C-4E44",
  "ToName"                  : "John Doe",
  "ToEmail"                 : "John Doe"
}

 

HarmonizedCode

Harmonized codes

Properties

  • Code type: string

    Harmonized code used

  • Description type: string

    Brief description of the harmonized code

  • OverrideLocale type: List of TaxOverrideLocale 


{
  "Code"             : "5103.10.93",
  "Description"      : "Garments",
  "OverrideLocale"  : 
  [
    {
      "TaxRateOverrideId"   : 1000000,
      "County"              : "Maricopa",
      "State"  : 
      {
        "ID"          : 4,
        "CountryId"   : 1,
        "Code"        : "AZ",
        "Name"        : "Arizona",
        "Tax"         : 0.056000
      },
      "Country"  : 
      {
        "ID"                  : 100001,
        "Code"                : "US",
        "Name"                : "United States",
        "PostCodeSupported"   : "true",
        "PostCodeRequired"    : "true"
      },
      "City"                : "Tempe",
      "PostCode"            : "85281",
      "TaxRate"             : 0.08,
      "ShippingTaxable"     : "true or false",
      "HarmonizedCode"      : "ExampleString"
    }
  ]
}

 

LineItemNote

Represents a note added by an admin on an item in a proposal or an order.

Properties

  • ID type: integer

    The unique integer ID of this Item Note

  • OrderId type: (nullable) integer

    The ID of the order to which this note was applied

  • ProposalId type: (nullable) integer

    The ID of the proposal to which this note was applied

  • ArtId type: (nullable) integer

    The ID of the art to which this note was applied

  • DesignId type: (nullable) integer

    The ID of the design to which this note was applied

  • CustomLineItemId type: (nullable) integer

    The ID of the custom line item to which this note was applied

  • ProductStyleId type: (nullable) integer

    The ID of the product style to which this note was applied

  • PersonalizationValues type: string

    The personalization values of the product style to which this note was applied

  • Content type: string

    The content of the note itself

  • DateCreated type: DateTime

    The date this note was added

  • DateModified type: DateTime

    The date this note was last modified

  • UniqueId type: (nullable) guid

    Unique Id attatched to an object assigned with this note.

  • ItemGuid type: (nullable) guid

    Added for SalesDoc --> Legacy Order Conversion 


{
  "ID"                      : 1000001,
  "OrderId"                 : 1,
  "ProposalId"              : 1,
  "ArtId"                   : 1,
  "DesignId"                : 1,
  "CustomLineItemId"        : 1,
  "ProductStyleId"          : 1,
  "PersonalizationValues"   : "ExampleString",
  "Content"                 : "ExampleString",
  "DateCreated"             : "2017-10-30T07:00:00Z",
  "DateModified"            : "2017-10-30T07:00:00Z",
  "UniqueId"                : "",
  "ItemGuid"                : ""
}

 

Manufacturer

A product manufacturer

Properties

  • ID type: integer

    A unique integer ID for this manufacturer

  • Name type: string

    The name of this manufacturer

  • HasBrandImage type: boolean

    True if this manufacturer has an image

  • HasSizeChart type: boolean

    True if this manufacturer has a size chart

  • SizeChartUrl type: string

    The URL of the size chart for this manufacturer

  • BrandImageUrl type: string

    The URL of the brand image for this manufacturer

  • ProductCount type: integer

    The number of products associated with this manufacturer

  • SizeCharts type: List of char 


{
  "ID"              : 1000001,
  "Name"            : "Gildan",
  "HasBrandImage"   : "true",
  "HasSizeChart"    : "true",
  "SizeChartUrl"    : "ExampleString",
  "BrandImageUrl"   : "ExampleString",
  "ProductCount"    : 1,
  "SizeCharts"      : [A,A,A]
}

 

NameNumberFont

Represents a font that can be used in a name/number for a checkout item. For a live preview of these fonts, apply the CssFamilyName to the element's font-family and ensure that you include /designer/html5/common/css/nameNumbersFonts.css

Properties

  • ID type: integer

    The ID of the referenced font

  • Name type: string

    The Name of this font

  • CssFamilyName type: string

    The CSS family name of this font 


{
  "ID"              : 1,
  "Name"            : "ExampleString",
  "CssFamilyName"   : "ExampleString"
}

 

NameNumberFontSetting

A font setting used for printing a name or number value in product names and numbers

Properties

  • FontId type: integer

    The ID of the font

  • Size type: byte

    The size of the font

  • Color type: string

    The hex color of the font

  • ColorName type: string

    Friendly name of the color, if one is set up in the store palette. 


{
  "FontId"      : 1,
  "Size"        : "12",
  "Color"       : "FF0000",
  "ColorName"   : "Red"
}

 

NameNumberSettingGroup

A collection of font settings that applies to a specified ProductStyleId + ArtId in the cart

Properties

  • Name type: NameNumberFontSetting

    The font setting to be used when printing the name

  • Number type: NameNumberFontSetting

    The font setting to be used when printing the number

  • ProductStyleId type: integer

    The ID of the ProductStyleId to which this value group applies

  • ArtId type: (nullable) integer

    The ID of the art to which this value group applies. Together with ProductStyleId, it can be used to identify all cart items to which this setting group applies

  • DesignId type: (nullable) integer

    The ID of the art to which this value group applies. Together with ProductStyleId, it can be used to identify all cart items to which this setting group applies

  • CartRetailItemId type: (nullable) integer

    The cart retail item id to which this value group applies. This value may be blank when transmitted from the client side

  • PrintCost type: (nullable) decimal

    The total print cost for this setting group 


{
  "Name"  : 
  {
    "FontId"      : 1,
    "Size"        : "12",
    "Color"       : "FF0000",
    "ColorName"   : "Red"
  },
  "Number"  : 
  {
    "FontId"      : 1,
    "Size"        : "12",
    "Color"       : "FF0000",
    "ColorName"   : "Red"
  },
  "ProductStyleId"     : 1000001,
  "ArtId"              : null,
  "DesignId"           : null,
  "CartRetailItemId"   : 1000013,
  "PrintCost"          : null
}

 

NameNumberValue

Represents a single name and number assigned to a single size in a shopping cart or order.

Properties

  • RetailItemSizeId type: integer

    Cart or Order Retail Item Size Id

  • Name type: string

    The name component of this name-number value pair

  • Number type: string

    The number component of this name-number value pair

  • Quantity type: integer

    Quantity of the Name and Number

  • Price type: (nullable) decimal

    Price charged for Name and Numbers 


{
  "RetailItemSizeId"   : 1000000,
  "Name"               : "Bob",
  "Number"             : "32",
  "Quantity"           : 1,
  "Price"              : 32
}

 

Order

An order placed by a customer

Properties

  • ID type: integer

    The unique integer ID of this order

  • UniqueId type: (nullable) guid

    The unique ID of the order

  • ProposalId type: (nullable) integer

    The ID of the proposal from which this order was created (if any) This is deprecated in SalesDoc world, use the ProposalGuid instead

  • ProposalGuid type: (nullable) guid

    The GUID of the proposal from which this order was created (if any)

  • ProposalNumber type: string

    The number of the proposal from which this order was created (if any)

  • PurchaseOrderNumber type: string

    The purchase order number for the order (if any)

  • Status type: OrderStatus

    The status of the order (Canceled, Processing, Fulfilled, Shipped)

  • ProductionStatus type: OrderProductionStatus

    The production status of the order ("Open", "Scheduled", "In Production", "Ready to Ship", "Ready for Pickup", "Complete")

  • CurrencyCode type: string

    A three-character descriptor of the currency used for this order

  • CurrencySymbol type: string

    The symbol that should preced the currency amount

  • DiscountId type: (nullable) integer

    The discount Id used when placing this order

  • DiscountCode type: string

    The discount code used when placing this order

  • CouponCode type: string

    The coupon code of the discount used when placing this order

  • Email type: string

    The email adddress saved with this order

  • User type: Contact

    The contact who placed this order

  • AssigneeId type: (nullable) integer

    The ID of the user assigned to this order

  • GiftMessage type: string

    The gift message saved with thi sorder

  • IpAddress type: string

    The IP address of the customer who placed this order

  • InHandsDate type: (nullable) DateTime

    Order in hands date

  • PaymentMethod type: string

    The name of the payment method used to complete this order

  • PaymentMethodNote type: string

    A note for the most current payment, for example, passing the reason a Credit Card was declined.

  • PaymentStatus type: OrderPaymentStatus

    A description of the payment status of this order

  • CardType type: string

    The credit card type used to pay for this order (if PaymentMethod == "CREDITCARD")

  • PurchaseOrderAttachmentUrl type: string

    If the PaymentMethod is PURCHASEORDER and a PO attachment was uploaded, this is a relative URL to it.

  • BillingAddress type: Address

    The billing Address associated with this order

  • ShippingAddress type: Address

    The shipping Address associated with this order

  • ShippingMethod type: ShippingMethod

    The ShippingMethod associated with this order

  • RetailAmount type: decimal

    The total price of all items included in this order, including print costs (not including taxes, shipping, or discounts)

  • ShippingAmount type: decimal

    The shipping cost for this order

  • ShippingTax type: decimal

    The shipping tax for this order

  • ShippingTaxRate type: (nullable) decimal

    The shipping tax rate for this order

  • DiscountTax type: decimal

    The tax that was not charged due to a discount.

  • DiscountShipping type: decimal

    The shipping that was not charged due to a discount.

  • TaxRate type: decimal

    The tax rate associated with this order

  • TaxAmount type: decimal

    The amount of tax for this order

  • TaxName type: string

    The name of the tax on the order

  • TaxAreaId type: (nullable) integer

    Destination TaxAreaId from Vertex

  • TotalAmount type: decimal

    The total amount of this order, including shipping and taxes, but before discounts.

  • GiftCertificateAmount type: decimal

    The amount of payment made via gift certifiate(s)

  • AmountDue type: decimal

    The amount due after discounts and gift certificates have been subtracted

  • RetailDiscount type: decimal

    The total discount applied to the RetailAmount

  • TotalDiscount type: decimal

    The total discount applied to this order, including coupons and discount codes as well as quantity discounts.

  • QuantityDiscountAmount type: decimal

    The amount-based quantity discount applied to this order

  • QuantityDiscountPercent type: decimal

    The percent-based quantity discount applied to this order

  • ProcessAmount type: decimal

    The payment amount processed for this order

  • ProcessMarkupAmount type: decimal

    The amount of markup applied to ProcessAmount

  • DateCreated type: (nullable) DateTime

    The date this order was created

  • DueDate type: (nullable) DateTime

    The date this order is due

  • EstimatedShipDate type: (nullable) DateTime

    The date this order is expected to ship

  • ConfirmedShipDate type: (nullable) DateTime

    The actual date this order shipped

  • EstimatedDeliveryDate_Min type: (nullable) DateTime

    The earliest date this order is expected to arrive

  • EstimatedDeliveryDate_Max type: (nullable) DateTime

    The latest date this order is expected to arrive

  • PaymentRequestSentDate type: (nullable) DateTime

    The date this order was sent as an invoice

  • DisplayPricing type: boolean

    True if pricing should be displayed on this order

  • Authorized type: boolean

    True if payment has been authorized

  • Paid type: boolean

    True if full payment for amount due has been received

  • Confirmed type: boolean

    True if payment has been confirmed

  • Ordered type: boolean

    True if this order has been placed

  • Received type: boolean

    True if this order has been received by the customer

  • Prepared type: boolean

    True if this order has been prepared for shipment

  • Shipped type: boolean

    True if this order has been shipped

  • Cancelled type: boolean

    True if this order has been cancelled

  • StoreName type: string

    The name of the store on which this order was placed

  • StoreId type: integer

    The ID of the store on which this order was placed

  • Notes type: string

    The notes associated with this order

  • Payments type: List of OrderPayment

    A list of OrderPayments representing payments applied to this order

  • ProductStyleSizePrices type: List of ProductStyleSizePrice

    Returns Prices for each and every size which are part of that style/color

  • Items type: List of OrderItem

    A list of OrderItems representing the items of this order

  • Shipments type: List of OrderShipment

    A list of OrderShipments representing all the shipments or pickups for this order.

  • GiftCertificates type: List of GiftCertificate

    A list of GiftCertificates applied to this order

  • PurchasedGiftCertificates type: List of GiftCertificate

    A list of GiftCertificates purchased in this order

  • NameNumberSettings type: List of NameNumberSettingGroup

    A list of NameNumberSettingGroups associated with this order

  • CheckoutFieldValues type: SerializableDictionary

    The checkout fields optionally defined by the store and entered by the customer at checkout

  • ProductStyleSizeInventoryStatuses type: SerializableDictionary

    A serializable dictionary of Size Order Statuses by ProductStyleSizeId

  • ShortCodes type: SerializableDictionary

    A list of Short Codes / replacements used for the thank you message

  • Timeline type: List of TimelineEntry

    The timeline history for this order

  • ExportedToQuickBooks type: boolean

    True if order information has been exported to QuickBooks.

  • DateExportedToQuickBooks type: (nullable) DateTime

    Set only when the order info has been exported to QuickBooks.

  • ContactEmailAddresses type: List of string

    Additional contact email addresses

  • TotalAdjustments type: List of OrderTotalAdjustment

    Order Total Adjustments for this order

  • ProductionCards type: List of ProductionCard

    ProductionCards for this order

  • CustomLineItems type: List of CustomLineItem

    Custom line items associated with this order

  • ReadyForPickupNotificationSentDate type: (nullable) DateTime

    The date the customer was notified that the order is ready to be picked up

  • ApprovalRequired type: boolean

    True if order requires approval.

  • ApprovalDate type: (nullable) DateTime

    The date the order has been approved

  • LineItemNotes type: List of LineItemNote

    The list of line item notes for this order 


{
  "ID"                                   : 1000001,
  "UniqueId"                             : "",
  "ProposalId"                           : 1,
  "ProposalGuid"                         : "",
  "ProposalNumber"                       : "ExampleString",
  "PurchaseOrderNumber"                  : "ExampleString",
  "Status"  : {"Name" : "example not found 2"},
  "ProductionStatus"  : {"Name" : "example not found 2"},
  "CurrencyCode"                         : "USD",
  "CurrencySymbol"                       : "$",
  "DiscountId"                           : 1002709,
  "DiscountCode"                         : "SAVE20",
  "CouponCode"                           : "SAVE20",
  "Email"                                : "test@inksoft.com",
  "User"  : 
  {
    "Fax"                     : "111-222-3333",
    "Note"                    : "Some details about the Contact",
    "SalesDocs"  : 
    [{"Name" : "example not found 2"}
    ],
    "PurchaseOrdersEnabled"   : "true",
    "PayLaterEnabled"         : "true",
    "Timeline"  : 
    [
      {
        "EventDescription"    : ,
        "ID"                  : 1,
        "ContactIds"          : [1,2,3],
        "CompanyIds"          : [1,2,3],
        "JobIds"              : [1,2,3],
        "OrderIds"            : [1,2,3],
        "ProposalIds"         : [1,2,3],
        "ProductionCardIds"   : [1,2,3],
        "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
        "Event"               : "ExampleString",
        "Comment"             : "ExampleString",
        "EventType"  : {"Name" : "example not found 2"},
        "Edited"              : "true",
        "EditedDate"          : "2017-10-30T07:00:00Z",
        "Deleted"             : "true",
        "DeletedDate"         : "2017-10-30T07:00:00Z",
        "Created"             : "2017-10-30T07:00:00Z",
        "CreatedByUserId"     : 1,
        "CreatedByName"       : "ExampleString",
        "Details"  : 
        [
          {
            "Property"   : "ExampleString",
            "OldValue"   : "ExampleString",
            "NewValue"   : "ExampleString",
            "Date"       : "2017-10-30T07:00:00Z"
          }
        ],
        "Associations"  : {"Name" : "example not found 2"}
      }
    ],
    "TierId"                  : 1,
    "Tiers"  : 
    [
      {
        "ID"         : 1000000,
        "Name"       : "Reseller",
        "UniqueId"   : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
        "Active"     : "true"
      }
    ],
    "IsTaxable"               : "true",
    "ID"                      : 1,
    "FirstName"               : "ExampleString",
    "LastName"                : "ExampleString",
    "JobTitle"                : "ExampleString",
    "Email"                   : "ExampleString",
    "Phones"  : 
    [
      {
        "ID"            : 1000000,
        "Number"        : "888-222-3333",
        "Extension"     : "1234",
        "PhoneType"     : "Mobile",
        "IsSMSOptOut"   : "false"
      }
    ],
    "ProfilePicture"          : "ExampleString",
    "Newsletter"              : "true",
    "Tags"  : 
    [
      {
        "ID"      : 1000000,
        "Name"    : "Walter",
        "Count"   : 12
      }
    ],
    "Store"  : 
    {
      "ID"                    : 1000000,
      "Uri"                   : "ExampleString",
      "Name"                  : "Walter",
      "Logo"                  : "logo.png",
      "AcceptPurchaseOrder"   : "true or false",
      "AllowPaymentLater"     : "true or false"
    },
    "Origin"  : 
    {
      "ID"      : 1000000,
      "Name"    : "Walter",
      "Image"   : "Walter",
      "Count"   : Walter
    },
    "Company"  : 
    {
      "ID"                     : 1000000,
      "Name"                   : "Inksoft",
      "PrimaryContact"  : null,
      "PrimaryContactId"       : 1,
      "PrimaryAddress"  : 
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      },
      "PrimaryAddressId"       : 1,
      "Addresses"  : 
      [
        {
          "ID"                     : 1000014,
          "StateId"                : 4,
          "CountryId"              : 1,
          "Business"               : "true",
          "TaxExempt"              : "true",
          "FirstName"              : "John",
          "LastName"               : "Doe",
          "Name"                   : "John Doe",
          "CompanyName"            : "Doe Co",
          "Street1"                : "1234 Test St",
          "Street2"                : "Suite 500",
          "City"                   : "Albuquerque",
          "State"                  : "NM",
          "StateName"              : "New Mexico",
          "Country"                : "United States",
          "CountryCode"            : "US",
          "Email"                  : "ExampleString",
          "Phone"                  : "480-309-6332",
          "Fax"                    : "480-309-6333",
          "PostCode"               : "87111",
          "POBox"                  : "true",
          "SaveToAddressBook"      : "true",
          "Type"                   : null,
          "TaxId"                  : null,
          "Department"             : "IT, Sales, Marketing",
          "ShowPickupAtCheckout"   : "true",
          "Validated"              : "true or false",
          "IsPrimaryAddress"       : "true",
          "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
        }
      ],
      "WebsiteUrl"             : "http://www.inksoft.com",
      "Fax"                    : "111-222-3333",
      "USFederalTaxId"         : "22-3333333",
      "USStateTaxId"           : "22-3333333",
      "CanadaBusinessNumber"   : "22-3333333",
      "IsUSTaxExempt"          : "true or false",
      "USTaxExemptionType"     : "NGO",
      "Discount"               : 22-3333333,
      "Note"                   : "Something about the company",
      "Phones"  : 
      [
        {
          "ID"            : 1000000,
          "Number"        : "888-222-3333",
          "Extension"     : "1234",
          "PhoneType"     : "Mobile",
          "IsSMSOptOut"   : "false"
        }
      ],
      "Tags"  : 
      [
        {
          "ID"      : 1000000,
          "Name"    : "Walter",
          "Count"   : 12
        }
      ],
      "Contacts"  : 
      [null
      ],
      "Timeline"  : 
      [
        {
          "EventDescription"    : ,
          "ID"                  : 1,
          "ContactIds"          : [1,2,3],
          "CompanyIds"          : [1,2,3],
          "JobIds"              : [1,2,3],
          "OrderIds"            : [1,2,3],
          "ProposalIds"         : [1,2,3],
          "ProductionCardIds"   : [1,2,3],
          "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
          "Event"               : "ExampleString",
          "Comment"             : "ExampleString",
          "EventType"  : {"Name" : "example not found 2"},
          "Edited"              : "true",
          "EditedDate"          : "2017-10-30T07:00:00Z",
          "Deleted"             : "true",
          "DeletedDate"         : "2017-10-30T07:00:00Z",
          "Created"             : "2017-10-30T07:00:00Z",
          "CreatedByUserId"     : 1,
          "CreatedByName"       : "ExampleString",
          "Details"  : 
          [
            {
              "Property"   : "ExampleString",
              "OldValue"   : "ExampleString",
              "NewValue"   : "ExampleString",
              "Date"       : "2017-10-30T07:00:00Z"
            }
          ],
          "Associations"  : {"Name" : "example not found 2"}
        }
      ]
    },
    "PrimaryAddressId"        : 1,
    "Addresses"  : 
    [
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      }
    ],
    "Discount"                : 3.14,
    "BirthDate"               : "2017-10-30T07:00:00Z",
    "DateCreated"             : "2017-10-30T07:00:00Z",
    "LastModified"            : "2017-10-30T07:00:00Z",
    "ExternalReferenceId"     : "ExampleString",
    "StoreAnalyticsEnabled"   : "true"
  },
  "AssigneeId"                           : 1,
  "GiftMessage"                          : "Enjoy!",
  "IpAddress"                            : "23.231.20.11",
  "InHandsDate"                          : "2017-10-30T07:00:00Z",
  "PaymentMethod"                        : "CREDITCARD",
  "PaymentMethodNote"                    : "Error Processing Credit Card Payment: Your card has insufficient funds. (99)",
  "PaymentStatus"  : {"Name" : "example not found 2"},
  "CardType"                             : "Visa",
  "PurchaseOrderAttachmentUrl"           : "ExampleString",
  "BillingAddress"  : 
  {
    "ID"                     : 1000014,
    "StateId"                : 4,
    "CountryId"              : 1,
    "Business"               : "true",
    "TaxExempt"              : "true",
    "FirstName"              : "John",
    "LastName"               : "Doe",
    "Name"                   : "John Doe",
    "CompanyName"            : "Doe Co",
    "Street1"                : "1234 Test St",
    "Street2"                : "Suite 500",
    "City"                   : "Albuquerque",
    "State"                  : "NM",
    "StateName"              : "New Mexico",
    "Country"                : "United States",
    "CountryCode"            : "US",
    "Email"                  : "ExampleString",
    "Phone"                  : "480-309-6332",
    "Fax"                    : "480-309-6333",
    "PostCode"               : "87111",
    "POBox"                  : "true",
    "SaveToAddressBook"      : "true",
    "Type"                   : null,
    "TaxId"                  : null,
    "Department"             : "IT, Sales, Marketing",
    "ShowPickupAtCheckout"   : "true",
    "Validated"              : "true or false",
    "IsPrimaryAddress"       : "true",
    "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
  },
  "ShippingAddress"  : 
  {
    "ID"                     : 1000014,
    "StateId"                : 4,
    "CountryId"              : 1,
    "Business"               : "true",
    "TaxExempt"              : "true",
    "FirstName"              : "John",
    "LastName"               : "Doe",
    "Name"                   : "John Doe",
    "CompanyName"            : "Doe Co",
    "Street1"                : "1234 Test St",
    "Street2"                : "Suite 500",
    "City"                   : "Albuquerque",
    "State"                  : "NM",
    "StateName"              : "New Mexico",
    "Country"                : "United States",
    "CountryCode"            : "US",
    "Email"                  : "ExampleString",
    "Phone"                  : "480-309-6332",
    "Fax"                    : "480-309-6333",
    "PostCode"               : "87111",
    "POBox"                  : "true",
    "SaveToAddressBook"      : "true",
    "Type"                   : null,
    "TaxId"                  : null,
    "Department"             : "IT, Sales, Marketing",
    "ShowPickupAtCheckout"   : "true",
    "Validated"              : "true or false",
    "IsPrimaryAddress"       : "true",
    "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
  },
  "ShippingMethod"  : 
  {
    "CarrierId"                      : "ExampleString",
    "CarrierEstimatedDeliveryDate"   : "2017-10-30T07:00:00Z",
    "Description"                    : "UPS Ground",
    "ID"                             : 1000019,
    "Name"                           : "Ground",
    "PackageType"                    : "ExampleString",
    "PackageCode"                    : "ExampleString",
    "RateId"                         : "ExampleString",
    "ServiceCode"                    : "ExampleString",
    "ServiceType"                    : "ExampleString",
    "VendorId"                       : 1000001,
    "VendorName"                     : "UPS",
    "VendorType"                     : "UPS",
    "Price"                          : 5.00,
    "AllowBeforeAddressKnown"        : "true",
    "AllowResidential"               : "true",
    "AllowPoBox"                     : "true",
    "AllowCommercial"                : "true",
    "DiscountingEnabled"             : "true",
    "ProcessDays"                    : 2,
    "PromptForCartShipperAccount"    : "true",
    "RequireCartShipperAccount"      : "true",
    "AllowShippingAddress"           : "true",
    "ProcessMarkup"                  : null,
    "PickupSetAtStoreId"             : null,
    "TransitDays_Min"                : 3,
    "TransitDays_Max"                : 5,
    "RtMarkupDollar"                 : null,
    "RtMarkupPercent"                : null,
    "Address"  : 
    {
      "ID"                     : 1000014,
      "StateId"                : 4,
      "CountryId"              : 1,
      "Business"               : "true",
      "TaxExempt"              : "true",
      "FirstName"              : "John",
      "LastName"               : "Doe",
      "Name"                   : "John Doe",
      "CompanyName"            : "Doe Co",
      "Street1"                : "1234 Test St",
      "Street2"                : "Suite 500",
      "City"                   : "Albuquerque",
      "State"                  : "NM",
      "StateName"              : "New Mexico",
      "Country"                : "United States",
      "CountryCode"            : "US",
      "Email"                  : "ExampleString",
      "Phone"                  : "480-309-6332",
      "Fax"                    : "480-309-6333",
      "PostCode"               : "87111",
      "POBox"                  : "true",
      "SaveToAddressBook"      : "true",
      "Type"                   : null,
      "TaxId"                  : null,
      "Department"             : "IT, Sales, Marketing",
      "ShowPickupAtCheckout"   : "true",
      "Validated"              : "true or false",
      "IsPrimaryAddress"       : "true",
      "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
    },
    "PickupNotes"                    : null,
    "PickupDateStart"                : "2017-10-30T07:00:00Z",
    "PickupDateEnd"                  : "2017-10-30T07:00:00Z",
    "OffsetGmt"                      : 7,
    "PickupType"  : {"Name" : "example not found 2"},
    "CalculationType"                : "Weight",
    "ShippingSchedules"  : 
    [{"Name" : "example not found 2"}
    ],
    "IsTaxExempt"                    : "true",
    "SortOrder"                      : 1,
    "ShipToStateIds"                 : [1,2,3],
    "IsDeleted"                      : "true",
    "IsProposalPickup"               : "true"
  },
  "RetailAmount"                         : 2998.04,
  "ShippingAmount"                       : 0.00,
  "ShippingTax"                          : 0.00,
  "ShippingTaxRate"                      : 0.060000,
  "DiscountTax"                          : 0.00,
  "DiscountShipping"                     : 0.00,
  "TaxRate"                              : 0.060000,
  "TaxAmount"                            : 179.88,
  "TaxName"                              : "Tax",
  "TaxAreaId"                            : 1,
  "TotalAmount"                          : 3177.92,
  "GiftCertificateAmount"                : 0.00,
  "AmountDue"                            : 31.78,
  "RetailDiscount"                       : 2968.06,
  "TotalDiscount"                        : 3146.14,
  "QuantityDiscountAmount"               : 0.00,
  "QuantityDiscountPercent"              : 0.00,
  "ProcessAmount"                        : 31.78,
  "ProcessMarkupAmount"                  : 0.00,
  "DateCreated"                          : "2013-01-05T13:02:05Z",
  "DueDate"                              : "2013-01-05T13:02:05Z",
  "EstimatedShipDate"                    : "2013-01-18T00:00:00Z",
  "ConfirmedShipDate"                    : "2013-01-18T00:00:00Z",
  "EstimatedDeliveryDate_Min"            : "2013-01-20T00:00:00Z",
  "EstimatedDeliveryDate_Max"            : "2013-01-20T00:00:00Z",
  "PaymentRequestSentDate"               : "2017-10-30T07:00:00Z",
  "DisplayPricing"                       : "true",
  "Authorized"                           : "true",
  "Paid"                                 : "true",
  "Confirmed"                            : "true",
  "Ordered"                              : "true",
  "Received"                             : "true",
  "Prepared"                             : "true",
  "Shipped"                              : "true",
  "Cancelled"                            : "true",
  "StoreName"                            : "Awesome T-shirts",
  "StoreId"                              : 10000000,
  "Notes"                                : "Awesome T-shirts",
  "Payments"  : 
  [
    {
      "ID"                      : 1000001,
      "OrderId"                 : 1,
      "ProposalId"              : 1,
      "EventType"               : "ExampleString",
      "CardLast4"               : "ExampleString",
      "CardType"                : "ExampleString",
      "ResponseCode"            : "ExampleString",
      "TransactionId"           : "ExampleString",
      "OriginalTransactionId"   : "ExampleString",
      "ApprovalCode"            : "ExampleString",
      "AvsCode"                 : "ExampleString",
      "DateCreated"             : "2017-10-30T07:00:00Z",
      "DateVoided"              : "2017-10-30T07:00:00Z",
      "TestMode"                : "true",
      "GatewayAccount"          : "ExampleString",
      "GiftCertificateId"       : 1,
      "Amount"                  : 3.14,
      "ProcessingFee"           : 3.14,
      "InkSoftFee"              : 3.14,
      "GatewayName"             : "ExampleString",
      "AttachmentFileName"      : "ExampleString",
      "Notes"                   : "ExampleString",
      "BillingAddress"  : 
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      }
    }
  ],
  "ProductStyleSizePrices"  : 
  [
    {
      "ProductStyleSizeId"   : 1,
      "PriceEach"            : 3.14,
      "CostEach"             : 3.14
    }
  ],
  "Items"  : 
  [
    {
      "OrderRetailItemId"                    : 1,
      "OrderRetailItemSizeId"                : 1,
      "InProduction"                         : "true",
      "OriginalOrderRetailItemId"            : 1,
      "KeepExistingPrintMethod"              : "true",
      "AddOns"  : 
      [
        {
          "ID"            : 1,
          "Quantity"      : 1,
          "Name"          : "ExampleString",
          "Description"   : "ExampleString",
          "Price"         : 3.14
        }
      ],
      "ArtId"                                : 1,
      "DesignId"                             : 1,
      "EstimatedProductionDays"              : 1,
      "FullName"                             : "ExampleString",
      "ItemTotal"                            : 3.14,
      "NameNumberValues"  : 
      [
        {
          "RetailItemSizeId"   : 1000000,
          "Name"               : "Bob",
          "Number"             : "32",
          "Quantity"           : 1,
          "Price"              : 32
        }
      ],
      "Notes"                                : "ExampleString",
      "PersonalizationValues"  : 
      [
        {
          "Name"                       : "ExampleString",
          "Value"                      : "ExampleString",
          "Price"                      : 3.14,
          "ProductPersonalizationId"   : 1
        }
      ],
      "PrintCost"                            : 3.14,
      "PrintCostOverride"                    : 3.14,
      "PrintOverridePriceBack"               : 3.14,
      "PrintOverridePriceFront"              : 3.14,
      "PrintOverridePriceSleeveLeft"         : 3.14,
      "PrintOverridePriceSleeveRight"        : 3.14,
      "PrintPriceBack"                       : 3.14,
      "PrintPriceFront"                      : 3.14,
      "PrintPriceSleeveLeft"                 : 3.14,
      "PrintPriceSleeveRight"                : 3.14,
      "PrintSetupCharge"                     : 3.14,
      "PrintSetupOverridePriceBack"          : 3.14,
      "PrintSetupOverridePriceFront"         : 3.14,
      "PrintSetupOverridePriceSleeveLeft"    : 3.14,
      "PrintSetupOverridePriceSleeveRight"   : 3.14,
      "PrintSetupPriceBack"                  : 3.14,
      "PrintSetupPriceFront"                 : 3.14,
      "PrintSetupPriceSleeveLeft"            : 3.14,
      "PrintSetupPriceSleeveRight"           : 3.14,
      "ProductId"                            : 1,
      "ProductPriceEach"                     : 3.14,
      "ProductPriceEachOverride"             : 3.14,
      "ProductStyleId"                       : 1,
      "ProductStyleSizeId"                   : 1,
      "Quantity"                             : 1,
      "QuantityDiscountAmount"               : 3.14,
      "QuantityDiscountPercent"              : 3.14,
      "RetailItemId"                         : 1,
      "RetailItemSizeId"                     : 1,
      "SideColorways"  : 
      [
        {
          "SideId"       : "ExampleString",
          "ColorwayId"   : 1
        }
      ],
      "SidePreviews"  : 
      [
        {
          "SideName"             : "ExampleString",
          "ProductOnlyUrl"       : "ExampleString",
          "DesignOnlyUrl"        : "ExampleString",
          "DesignOnProductUrl"   : "ExampleString",
          "SideArtId"            : 1
        }
      ],
      "TaxRate"                              : 3.14,
      "TaxRateOverride"                      : 3.14,
      "UnitPrice"                            : 3.14,
      "UniqueId"                             : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7"
    }
  ],
  "Shipments"  : 
  [
    {
      "ID"             : 1,
      "OrderId"        : 1,
      "PackageCount"   : 1,
      "DateCreated"    : "2017-10-30T07:00:00Z",
      "LastModified"   : "2017-10-30T07:00:00Z",
      "Notes"          : "ExampleString",
      "PickedUpBy"     : "ExampleString",
      "Pickup"         : "true",
      "ToAddress"  : 
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      },
      "FromAddress"  : 
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      },
      "Packages"  : 
      [
        {
          "ID"                      : 1,
          "ShippedDate"             : "2017-10-30T07:00:00Z",
          "TrackingNumber"          : "ExampleString",
          "TrackingUrl"             : "ExampleString",
          "ShippingServiceType"     : "ExampleString",
          "Status"                  : "ExampleString",
          "CarrierName"             : "ExampleString",
          "ShippingLabelFileName"   : "ExampleString",
          "LabelCost"               : 3.14,
          "Items"  : 
          [
            {
              "Guid"       : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
              "ItemGuid"   : "",
              "Quantity"   : 1
            }
          ]
        }
      ]
    }
  ],
  "GiftCertificates"  : 
  [
    {
      "Amount"                  : 34.00,
      "AppliedAmount"           : 34.00,
      "InitialPurchaseAmount"   : 3.14,
      "Created"                 : "2017-10-30T07:00:00Z",
      "DateSent"                : "2017-10-30T07:00:00Z",
      "HasOrders"               : "true",
      "Number"                  : "CA77-EE66-GD6C-4E44",
      "ToName"                  : "John Doe",
      "ToEmail"                 : "John Doe"
    }
  ],
  "PurchasedGiftCertificates"  : 
  [
    {
      "Amount"                  : 34.00,
      "AppliedAmount"           : 34.00,
      "InitialPurchaseAmount"   : 3.14,
      "Created"                 : "2017-10-30T07:00:00Z",
      "DateSent"                : "2017-10-30T07:00:00Z",
      "HasOrders"               : "true",
      "Number"                  : "CA77-EE66-GD6C-4E44",
      "ToName"                  : "John Doe",
      "ToEmail"                 : "John Doe"
    }
  ],
  "NameNumberSettings"  : 
  [
    {
      "Name"  : 
      {
        "FontId"      : 1,
        "Size"        : "12",
        "Color"       : "FF0000",
        "ColorName"   : "Red"
      },
      "Number"  : 
      {
        "FontId"      : 1,
        "Size"        : "12",
        "Color"       : "FF0000",
        "ColorName"   : "Red"
      },
      "ProductStyleId"     : 1000001,
      "ArtId"              : null,
      "DesignId"           : null,
      "CartRetailItemId"   : 1000013,
      "PrintCost"          : null
    }
  ],
  "CheckoutFieldValues"  : 
  {
    "Item"  : {"Name" : "example not found 2"}
  },
  "ProductStyleSizeInventoryStatuses"  : 
  {
    "Item"  : {"Name" : "example not found 2"}
  },
  "ShortCodes"  : 
  {
    "Item"  : {"Name" : "example not found 2"}
  },
  "Timeline"  : 
  [
    {
      "EventDescription"    : ,
      "ID"                  : 1,
      "ContactIds"          : [1,2,3],
      "CompanyIds"          : [1,2,3],
      "JobIds"              : [1,2,3],
      "OrderIds"            : [1,2,3],
      "ProposalIds"         : [1,2,3],
      "ProductionCardIds"   : [1,2,3],
      "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
      "Event"               : "ExampleString",
      "Comment"             : "ExampleString",
      "EventType"  : {"Name" : "example not found 2"},
      "Edited"              : "true",
      "EditedDate"          : "2017-10-30T07:00:00Z",
      "Deleted"             : "true",
      "DeletedDate"         : "2017-10-30T07:00:00Z",
      "Created"             : "2017-10-30T07:00:00Z",
      "CreatedByUserId"     : 1,
      "CreatedByName"       : "ExampleString",
      "Details"  : 
      [
        {
          "Property"   : "ExampleString",
          "OldValue"   : "ExampleString",
          "NewValue"   : "ExampleString",
          "Date"       : "2017-10-30T07:00:00Z"
        }
      ],
      "Associations"  : {"Name" : "example not found 2"}
    }
  ],
  "ExportedToQuickBooks"                 : "true",
  "DateExportedToQuickBooks"             : "2017-10-30T07:00:00Z",
  "ContactEmailAddresses"                : [ExampleString,ExampleString,ExampleString],
  "TotalAdjustments"  : 
  [
    {
      "ID"               : 1,
      "Type"             : "",
      "Description"      : "ExampleString",
      "Percentage"       : 3.14,
      "Amount"           : 3.14,
      "CreatedByName"    : "ExampleString",
      "Created"          : "2017-10-30T07:00:00Z",
      "ModifiedByName"   : "ExampleString",
      "LastModified"     : "2017-10-30T07:00:00Z"
    }
  ],
  "ProductionCards"  : 
  [
    {
      "ID"                        : 1000001,
      "JobId"                     : 1,
      "JobName"                   : "ExampleString",
      "JobStatusName"             : "ExampleString",
      "JobStatusId"               : 1,
      "JobNumber"                 : "ExampleString",
      "OrderId"                   : 1,
      "PrintavoOrderId"           : "ExampleString",
      "PrintavoOrderLink"         : "ExampleString",
      "SalesDocGuid"              : "",
      "DecorationGuid"            : "",
      "OrderFirstName"            : "ExampleString",
      "OrderLastName"             : "ExampleString",
      "OrderEmail"                : "ExampleString",
      "OrderStoreName"            : "ExampleString",
      "OrderDate"                 : "2017-10-30T07:00:00Z",
      "OrderRetailItemId"         : 1,
      "OrderPaymentStatus"        : "",
      "Number"                    : "ExampleString",
      "DesignGroupKey"            : "ExampleString",
      "ShipDate"                  : "2017-10-30T07:00:00Z",
      "OrderIsPickup"             : "true",
      "ProductId"                 : 1,
      "ProductName"               : "ExampleString",
      "ProductSku"                : "ExampleString",
      "ProductManufacturer"       : "ExampleString",
      "ProductSupplier"           : "ExampleString",
      "ProductStyleName"          : "ExampleString",
      "ProductStyleId"            : 1,
      "DesignName"                : "ExampleString",
      "DesignType"                : "",
      "Art"  : 
      {
        "ID"                    : 1,
        "ColorCount"            : 1,
        "Colors"                : ["#FF0000","#FFFFFF","#0000FF"],
        "OriginalColorway"  : 
        {
          "ID"             : 1,
          "Colors"  : 
          [
            {
              "Index"                : 1,
              "Color"                : "ExampleString",
              "EmbroideryThreadId"   : 1,
              "InkColorId"           : 1,
              "ColorName"            : "ExampleString",
              "PMS"                  : "ExampleString"
            }
          ],
          "Name"           : "ExampleString",
          "SvgUrl"         : "ExampleString",
          "RenderedUrl"    : "ExampleString",
          "ThumbnailUrl"   : "ExampleString"
        },
        "StitchCount"           : 1,
        "TrimCount"             : 1,
        "GalleryId"             : 1,
        "CategoryIds"           : [1,2,3],
        "Name"                  : "Business_Designs",
        "Type"                  : "ExampleString",
        "Keywords"              : "pretty,big,black and white,zebra",
        "FixedSvg"              : "true",
        "Digitized"             : "true",
        "CanScreenPrint"        : "true",
        "FullName"              : "store5976/Business/Business_Designs",
        "ExternalReferenceID"   : "ExampleString",
        "Width"                 : 762,
        "Height"                : 538,
        "Notes"                 : "ExampleString",
        "FileExt"               : "png",
        "ImageUrl"              : "ExampleString",
        "ThumbUrl"              : "ExampleString",
        "ThumbUrlAlt"           : "ExampleString",
        "OriginalUrl"           : "ExampleString",
        "UploadedUrl"           : "ExampleString",
        "UploadedOn"            : "2017-10-30T07:00:00Z",
        "IsActive"              : "true",
        "Colorways"  : 
        [
          {
            "ID"             : 1,
            "Colors"  : 
            [
              {
                "Index"                : 1,
                "Color"                : "ExampleString",
                "EmbroideryThreadId"   : 1,
                "InkColorId"           : 1,
                "ColorName"            : "ExampleString",
                "PMS"                  : "ExampleString"
              }
            ],
            "Name"           : "ExampleString",
            "SvgUrl"         : "ExampleString",
            "RenderedUrl"    : "ExampleString",
            "ThumbnailUrl"   : "ExampleString"
          }
        ],
        "UniqueId"              : "",
        "MatchFileColor"        : "true"
      },
      "ArtId"                     : 1,
      "DesignId"                  : 1,
      "ColorwayId"                : 1,
      "CanvasId"                  : 1,
      "Side"                      : "ExampleString",
      "SideInternalName"          : "ExampleString",
      "RegionName"                : "ExampleString",
      "Region"  : 
      {
        "ID"                          : 1000001,
        "Name"                        : "Full",
        "X"                           : 10,
        "Y"                           : 10,
        "Width"                       : 100,
        "Height"                      : 200,
        "Rotation"                    : null,
        "Shape"                       : null,
        "Side"                        : "front",
        "IsDefault"                   : "true",
        "ProductRegionRenderSizeId"   : 1,
        "RenderWidthInches"           : null,
        "RenderHeightInches"          : null
      },
      "ProductType"  : {"Name" : "example not found 2"},
      "SizeUnit"                  : "ExampleString",
      "ProductUrl"                : "ExampleString",
      "PreviewUrl"                : "ExampleString",
      "DesignUrl"                 : "ExampleString",
      "ArtUrl"                    : "ExampleString",
      "PrintMethod"               : "ExampleString",
      "Quantity"                  : 1,
      "ColorCount"                : 1,
      "ProductionNotes"           : "ExampleString",
      "OrderNotes"                : "ExampleString",
      "OrderItemNotes"            : "ExampleString",
      "DateCompleted"             : "2017-10-30T07:00:00Z",
      "Timeline"  : 
      [
        {
          "EventDescription"    : ,
          "ID"                  : 1,
          "ContactIds"          : [1,2,3],
          "CompanyIds"          : [1,2,3],
          "JobIds"              : [1,2,3],
          "OrderIds"            : [1,2,3],
          "ProposalIds"         : [1,2,3],
          "ProductionCardIds"   : [1,2,3],
          "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
          "Event"               : "ExampleString",
          "Comment"             : "ExampleString",
          "EventType"  : {"Name" : "example not found 2"},
          "Edited"              : "true",
          "EditedDate"          : "2017-10-30T07:00:00Z",
          "Deleted"             : "true",
          "DeletedDate"         : "2017-10-30T07:00:00Z",
          "Created"             : "2017-10-30T07:00:00Z",
          "CreatedByUserId"     : 1,
          "CreatedByName"       : "ExampleString",
          "Details"  : 
          [
            {
              "Property"   : "ExampleString",
              "OldValue"   : "ExampleString",
              "NewValue"   : "ExampleString",
              "Date"       : "2017-10-30T07:00:00Z"
            }
          ],
          "Associations"  : {"Name" : "example not found 2"}
        }
      ],
      "Attachments"  : 
      [
        {
          "ID"                 : 1000001,
          "Type"  : {"Name" : "example not found 2"},
          "ProductionCardId"   : 1,
          "OriginalName"       : "ExampleString",
          "Name"               : "ExampleString",
          "Description"        : "ExampleString",
          "MimeType"           : "ExampleString",
          "Url"                : "ExampleString",
          "UrlThumbnail"       : "ExampleString",
          "UrlPreview"         : "ExampleString"
        }
      ],
      "Colors"  : 
      [
        {
          "ID"                  : 1000001,
          "ProductionCardId"    : 1,
          "Index"               : 1,
          "Name"                : "ExampleString",
          "PMS"                 : "ExampleString",
          "HtmlColor"           : "ExampleString",
          "ThreadLibraryName"   : "ExampleString",
          "ThreadChartName"     : "ExampleString",
          "ThreadColorName"     : "ExampleString",
          "ThreadColorCode"     : "ExampleString"
        }
      ],
      "Items"  : 
      [
        {
          "ID"                      : 1000001,
          "ProductionCardId"        : 1,
          "SalesDocItemGuid"        : "",
          "Size"                    : "ExampleString",
          "Quantity"                : 1,
          "Status"                  : "ExampleString",
          "PurchasingStatus"        : "ExampleString",
          "IsComplete"              : "true",
          "PersonalizationValues"  : 
          [
            {
              "Name"                       : "ExampleString",
              "Value"                      : "ExampleString",
              "Price"                      : 3.14,
              "ProductPersonalizationId"   : 1
            }
          ],
          "NameNumberValue"  : 
          {
            "RetailItemSizeId"   : 1000000,
            "Name"               : "Bob",
            "Number"             : "32",
            "Quantity"           : 1,
            "Price"              : 32
          },
          "SortOrder"               : 1
        }
      ],
      "ColorwayName"              : "ExampleString",
      "ProductHtmlColor"          : "ExampleString",
      "ProductShape"              : "ExampleString",
      "EstimatedProductionDays"   : 1
    }
  ],
  "CustomLineItems"  : 
  [
    {
      "ID"                     : 1,
      "ParentId"               : 1,
      "UniqueId"               : "",
      "Name"                   : "ExampleString",
      "Description"            : "ExampleString",
      "ImageUrl"               : "ExampleString",
      "Taxable"                : "true",
      "TaxRate"                : 3.14,
      "TaxRateOverride"        : 3.14,
      "UnitCost"               : 3.14,
      "UnitPrice"              : 3.14,
      "UnitWeight"             : 3.14,
      "Quantity"               : 1,
      "UnitType"  : {"Name" : "example not found 2"},
      "Active"                 : "true",
      "Size"                   : "ExampleString",
      "Style"                  : "ExampleString",
      "CustomLineItemImages"  : 
      [
        {
          "ID"         : 1,
          "UniqueId"   : "",
          "ImageUrl"   : "ExampleString",
          "Deleted"    : "true"
        }
      ]
    }
  ],
  "ReadyForPickupNotificationSentDate"   : "2017-10-30T07:00:00Z",
  "ApprovalRequired"                     : "true",
  "ApprovalDate"                         : "2013-01-20T00:00:00Z",
  "LineItemNotes"  : 
  [
    {
      "ID"                      : 1000001,
      "OrderId"                 : 1,
      "ProposalId"              : 1,
      "ArtId"                   : 1,
      "DesignId"                : 1,
      "CustomLineItemId"        : 1,
      "ProductStyleId"          : 1,
      "PersonalizationValues"   : "ExampleString",
      "Content"                 : "ExampleString",
      "DateCreated"             : "2017-10-30T07:00:00Z",
      "DateModified"            : "2017-10-30T07:00:00Z",
      "UniqueId"                : "",
      "ItemGuid"                : ""
    }
  ]
}

 

OrderApprovalSettings

Properties

  • AllOrders type: boolean

  • DesignOrUpload type: boolean

  • NotCapturedPayment type: boolean

  • Amount type: decimal 


{
  "AllOrders"            : "true",
  "DesignOrUpload"       : "true",
  "NotCapturedPayment"   : "true",
  "Amount"               : 3.14
}

 

OrderItem

A list of items included in a [Object:ShoppingCart] Each item contains a unique combination of [ProductStyleSizeId] + [PersonalizationValues]

Properties

  • OrderRetailItemId type: integer

    The ID of the server-side order_retail_item to which this item corresponds (not a one-to-one relationship)

  • OrderRetailItemSizeId type: integer

    The ID of the server-side order_retail_item_size to which this item corresponds (there may be multiple items in the Order that share this value, each with different PersonalizationValues or NameNumberValues)

  • InProduction type: boolean

    True if the order item is in production (associated with a production card that is associated with a job or marked as completed)

  • OriginalOrderRetailItemId type: (nullable) integer

    The ID of the original OrderRetailItem that this OrderItem was created from. This is used in the case that additional colors or sizes are added in Order Manager and we need to copy things like the print region from the original OrderRetailItem

  • KeepExistingPrintMethod type: boolean

    This is used in the case the design was updated and user selected Keep Existing Price and we want to use the same print method.

  • AddOns type: List of ShoppingCartItemAddOn

  • ArtId type: (nullable) integer

  • DesignId type: (nullable) integer

  • EstimatedProductionDays type: (nullable) integer

  • FullName type: string

  • ItemTotal type: decimal

  • NameNumberValues type: List of NameNumberValue

  • Notes type: string

  • PersonalizationValues type: List of PersonalizationValue

  • PrintCost type: (nullable) decimal

  • PrintCostOverride type: (nullable) decimal

  • PrintOverridePriceBack type: (nullable) decimal

  • PrintOverridePriceFront type: (nullable) decimal

  • PrintOverridePriceSleeveLeft type: (nullable) decimal

  • PrintOverridePriceSleeveRight type: (nullable) decimal

  • PrintPriceBack type: (nullable) decimal

  • PrintPriceFront type: (nullable) decimal

  • PrintPriceSleeveLeft type: (nullable) decimal

  • PrintPriceSleeveRight type: (nullable) decimal

  • PrintSetupCharge type: (nullable) decimal

  • PrintSetupOverridePriceBack type: (nullable) decimal

  • PrintSetupOverridePriceFront type: (nullable) decimal

  • PrintSetupOverridePriceSleeveLeft type: (nullable) decimal

  • PrintSetupOverridePriceSleeveRight type: (nullable) decimal

  • PrintSetupPriceBack type: (nullable) decimal

  • PrintSetupPriceFront type: (nullable) decimal

  • PrintSetupPriceSleeveLeft type: (nullable) decimal

  • PrintSetupPriceSleeveRight type: (nullable) decimal

  • ProductId type: integer

  • ProductPriceEach type: (nullable) decimal

  • ProductPriceEachOverride type: (nullable) decimal

  • ProductStyleId type: integer

  • ProductStyleSizeId type: integer

  • Quantity type: integer

  • QuantityDiscountAmount type: (nullable) decimal

  • QuantityDiscountPercent type: (nullable) decimal

  • RetailItemId type: integer

  • RetailItemSizeId type: integer

  • SideColorways type: List of SideColorway

  • SidePreviews type: List of ShoppingCartItemPreview

  • TaxRate type: (nullable) decimal

  • TaxRateOverride type: (nullable) decimal

  • UnitPrice type: decimal

  • UniqueId type: guid 


{
  "OrderRetailItemId"                    : 1,
  "OrderRetailItemSizeId"                : 1,
  "InProduction"                         : "true",
  "OriginalOrderRetailItemId"            : 1,
  "KeepExistingPrintMethod"              : "true",
  "AddOns"  : 
  [
    {
      "ID"            : 1,
      "Quantity"      : 1,
      "Name"          : "ExampleString",
      "Description"   : "ExampleString",
      "Price"         : 3.14
    }
  ],
  "ArtId"                                : 1,
  "DesignId"                             : 1,
  "EstimatedProductionDays"              : 1,
  "FullName"                             : "ExampleString",
  "ItemTotal"                            : 3.14,
  "NameNumberValues"  : 
  [
    {
      "RetailItemSizeId"   : 1000000,
      "Name"               : "Bob",
      "Number"             : "32",
      "Quantity"           : 1,
      "Price"              : 32
    }
  ],
  "Notes"                                : "ExampleString",
  "PersonalizationValues"  : 
  [
    {
      "Name"                       : "ExampleString",
      "Value"                      : "ExampleString",
      "Price"                      : 3.14,
      "ProductPersonalizationId"   : 1
    }
  ],
  "PrintCost"                            : 3.14,
  "PrintCostOverride"                    : 3.14,
  "PrintOverridePriceBack"               : 3.14,
  "PrintOverridePriceFront"              : 3.14,
  "PrintOverridePriceSleeveLeft"         : 3.14,
  "PrintOverridePriceSleeveRight"        : 3.14,
  "PrintPriceBack"                       : 3.14,
  "PrintPriceFront"                      : 3.14,
  "PrintPriceSleeveLeft"                 : 3.14,
  "PrintPriceSleeveRight"                : 3.14,
  "PrintSetupCharge"                     : 3.14,
  "PrintSetupOverridePriceBack"          : 3.14,
  "PrintSetupOverridePriceFront"         : 3.14,
  "PrintSetupOverridePriceSleeveLeft"    : 3.14,
  "PrintSetupOverridePriceSleeveRight"   : 3.14,
  "PrintSetupPriceBack"                  : 3.14,
  "PrintSetupPriceFront"                 : 3.14,
  "PrintSetupPriceSleeveLeft"            : 3.14,
  "PrintSetupPriceSleeveRight"           : 3.14,
  "ProductId"                            : 1,
  "ProductPriceEach"                     : 3.14,
  "ProductPriceEachOverride"             : 3.14,
  "ProductStyleId"                       : 1,
  "ProductStyleSizeId"                   : 1,
  "Quantity"                             : 1,
  "QuantityDiscountAmount"               : 3.14,
  "QuantityDiscountPercent"              : 3.14,
  "RetailItemId"                         : 1,
  "RetailItemSizeId"                     : 1,
  "SideColorways"  : 
  [
    {
      "SideId"       : "ExampleString",
      "ColorwayId"   : 1
    }
  ],
  "SidePreviews"  : 
  [
    {
      "SideName"             : "ExampleString",
      "ProductOnlyUrl"       : "ExampleString",
      "DesignOnlyUrl"        : "ExampleString",
      "DesignOnProductUrl"   : "ExampleString",
      "SideArtId"            : 1
    }
  ],
  "TaxRate"                              : 3.14,
  "TaxRateOverride"                      : 3.14,
  "UnitPrice"                            : 3.14,
  "UniqueId"                             : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7"
}

 

OrderPackage

An Order with supporting data. Inherits from [Object:RetailPackage]

Properties

  • Orders type: List of Order

    Represents a list of customer orders

  • SalesDocs type: List of SalesDoc

    The SalesDocs that this order package was generated from

  • Proposals type: List of Proposal

    Represents a list of proposals from which orders were created

  • Stores type: List of OrderStore

    A list of summary store information containing only stores with orders in the package

  • Shipments type: List of OrderShipment

    A list of order shipments associated with the order package

  • Publisher type: OrderPublisher

    Summary publisher information

  • CheckoutNotes type: string

    Used to show additional information on the checkout confirmation page

  • Products type: List of ProductBase

  • Manufacturers type: List of Manufacturer

  • Art type: List of Art

  • DesignSummaries type: List of DesignSummary

  • Contacts type: List of ContactBase

  • SimpleDesigns type: List of SimpleDesign 


{
  "Orders"  : 
  [
    {
      "ID"                                   : 1000001,
      "UniqueId"                             : "",
      "ProposalId"                           : 1,
      "ProposalGuid"                         : "",
      "ProposalNumber"                       : "ExampleString",
      "PurchaseOrderNumber"                  : "ExampleString",
      "Status"  : {"Name" : "example not found 2"},
      "ProductionStatus"  : {"Name" : "example not found 2"},
      "CurrencyCode"                         : "USD",
      "CurrencySymbol"                       : "$",
      "DiscountId"                           : 1002709,
      "DiscountCode"                         : "SAVE20",
      "CouponCode"                           : "SAVE20",
      "Email"                                : "test@inksoft.com",
      "User"  : 
      {
        "Fax"                     : "111-222-3333",
        "Note"                    : "Some details about the Contact",
        "SalesDocs"  : 
        [{"Name" : "example not found 2"}
        ],
        "PurchaseOrdersEnabled"   : "true",
        "PayLaterEnabled"         : "true",
        "Timeline"  : 
        [
          {
            "EventDescription"    : ,
            "ID"                  : 1,
            "ContactIds"          : [1,2,3],
            "CompanyIds"          : [1,2,3],
            "JobIds"              : [1,2,3],
            "OrderIds"            : [1,2,3],
            "ProposalIds"         : [1,2,3],
            "ProductionCardIds"   : [1,2,3],
            "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
            "Event"               : "ExampleString",
            "Comment"             : "ExampleString",
            "EventType"  : {"Name" : "example not found 2"},
            "Edited"              : "true",
            "EditedDate"          : "2017-10-30T07:00:00Z",
            "Deleted"             : "true",
            "DeletedDate"         : "2017-10-30T07:00:00Z",
            "Created"             : "2017-10-30T07:00:00Z",
            "CreatedByUserId"     : 1,
            "CreatedByName"       : "ExampleString",
            "Details"  : 
            [
              {
                "Property"   : "ExampleString",
                "OldValue"   : "ExampleString",
                "NewValue"   : "ExampleString",
                "Date"       : "2017-10-30T07:00:00Z"
              }
            ],
            "Associations"  : {"Name" : "example not found 2"}
          }
        ],
        "TierId"                  : 1,
        "Tiers"  : 
        [
          {
            "ID"         : 1000000,
            "Name"       : "Reseller",
            "UniqueId"   : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
            "Active"     : "true"
          }
        ],
        "IsTaxable"               : "true",
        "ID"                      : 1,
        "FirstName"               : "ExampleString",
        "LastName"                : "ExampleString",
        "JobTitle"                : "ExampleString",
        "Email"                   : "ExampleString",
        "Phones"  : 
        [
          {
            "ID"            : 1000000,
            "Number"        : "888-222-3333",
            "Extension"     : "1234",
            "PhoneType"     : "Mobile",
            "IsSMSOptOut"   : "false"
          }
        ],
        "ProfilePicture"          : "ExampleString",
        "Newsletter"              : "true",
        "Tags"  : 
        [
          {
            "ID"      : 1000000,
            "Name"    : "Walter",
            "Count"   : 12
          }
        ],
        "Store"  : 
        {
          "ID"                    : 1000000,
          "Uri"                   : "ExampleString",
          "Name"                  : "Walter",
          "Logo"                  : "logo.png",
          "AcceptPurchaseOrder"   : "true or false",
          "AllowPaymentLater"     : "true or false"
        },
        "Origin"  : 
        {
          "ID"      : 1000000,
          "Name"    : "Walter",
          "Image"   : "Walter",
          "Count"   : Walter
        },
        "Company"  : 
        {
          "ID"                     : 1000000,
          "Name"                   : "Inksoft",
          "PrimaryContact"  : null,
          "PrimaryContactId"       : 1,
          "PrimaryAddress"  : 
          {
            "ID"                     : 1000014,
            "StateId"                : 4,
            "CountryId"              : 1,
            "Business"               : "true",
            "TaxExempt"              : "true",
            "FirstName"              : "John",
            "LastName"               : "Doe",
            "Name"                   : "John Doe",
            "CompanyName"            : "Doe Co",
            "Street1"                : "1234 Test St",
            "Street2"                : "Suite 500",
            "City"                   : "Albuquerque",
            "State"                  : "NM",
            "StateName"              : "New Mexico",
            "Country"                : "United States",
            "CountryCode"            : "US",
            "Email"                  : "ExampleString",
            "Phone"                  : "480-309-6332",
            "Fax"                    : "480-309-6333",
            "PostCode"               : "87111",
            "POBox"                  : "true",
            "SaveToAddressBook"      : "true",
            "Type"                   : null,
            "TaxId"                  : null,
            "Department"             : "IT, Sales, Marketing",
            "ShowPickupAtCheckout"   : "true",
            "Validated"              : "true or false",
            "IsPrimaryAddress"       : "true",
            "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
          },
          "PrimaryAddressId"       : 1,
          "Addresses"  : 
          [
            {
              "ID"                     : 1000014,
              "StateId"                : 4,
              "CountryId"              : 1,
              "Business"               : "true",
              "TaxExempt"              : "true",
              "FirstName"              : "John",
              "LastName"               : "Doe",
              "Name"                   : "John Doe",
              "CompanyName"            : "Doe Co",
              "Street1"                : "1234 Test St",
              "Street2"                : "Suite 500",
              "City"                   : "Albuquerque",
              "State"                  : "NM",
              "StateName"              : "New Mexico",
              "Country"                : "United States",
              "CountryCode"            : "US",
              "Email"                  : "ExampleString",
              "Phone"                  : "480-309-6332",
              "Fax"                    : "480-309-6333",
              "PostCode"               : "87111",
              "POBox"                  : "true",
              "SaveToAddressBook"      : "true",
              "Type"                   : null,
              "TaxId"                  : null,
              "Department"             : "IT, Sales, Marketing",
              "ShowPickupAtCheckout"   : "true",
              "Validated"              : "true or false",
              "IsPrimaryAddress"       : "true",
              "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
            }
          ],
          "WebsiteUrl"             : "http://www.inksoft.com",
          "Fax"                    : "111-222-3333",
          "USFederalTaxId"         : "22-3333333",
          "USStateTaxId"           : "22-3333333",
          "CanadaBusinessNumber"   : "22-3333333",
          "IsUSTaxExempt"          : "true or false",
          "USTaxExemptionType"     : "NGO",
          "Discount"               : 22-3333333,
          "Note"                   : "Something about the company",
          "Phones"  : 
          [
            {
              "ID"            : 1000000,
              "Number"        : "888-222-3333",
              "Extension"     : "1234",
              "PhoneType"     : "Mobile",
              "IsSMSOptOut"   : "false"
            }
          ],
          "Tags"  : 
          [
            {
              "ID"      : 1000000,
              "Name"    : "Walter",
              "Count"   : 12
            }
          ],
          "Contacts"  : 
          [null
          ],
          "Timeline"  : 
          [
            {
              "EventDescription"    : ,
              "ID"                  : 1,
              "ContactIds"          : [1,2,3],
              "CompanyIds"          : [1,2,3],
              "JobIds"              : [1,2,3],
              "OrderIds"            : [1,2,3],
              "ProposalIds"         : [1,2,3],
              "ProductionCardIds"   : [1,2,3],
              "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
              "Event"               : "ExampleString",
              "Comment"             : "ExampleString",
              "EventType"  : {"Name" : "example not found 2"},
              "Edited"              : "true",
              "EditedDate"          : "2017-10-30T07:00:00Z",
              "Deleted"             : "true",
              "DeletedDate"         : "2017-10-30T07:00:00Z",
              "Created"             : "2017-10-30T07:00:00Z",
              "CreatedByUserId"     : 1,
              "CreatedByName"       : "ExampleString",
              "Details"  : 
              [
                {
                  "Property"   : "ExampleString",
                  "OldValue"   : "ExampleString",
                  "NewValue"   : "ExampleString",
                  "Date"       : "2017-10-30T07:00:00Z"
                }
              ],
              "Associations"  : {"Name" : "example not found 2"}
            }
          ]
        },
        "PrimaryAddressId"        : 1,
        "Addresses"  : 
        [
          {
            "ID"                     : 1000014,
            "StateId"                : 4,
            "CountryId"              : 1,
            "Business"               : "true",
            "TaxExempt"              : "true",
            "FirstName"              : "John",
            "LastName"               : "Doe",
            "Name"                   : "John Doe",
            "CompanyName"            : "Doe Co",
            "Street1"                : "1234 Test St",
            "Street2"                : "Suite 500",
            "City"                   : "Albuquerque",
            "State"                  : "NM",
            "StateName"              : "New Mexico",
            "Country"                : "United States",
            "CountryCode"            : "US",
            "Email"                  : "ExampleString",
            "Phone"                  : "480-309-6332",
            "Fax"                    : "480-309-6333",
            "PostCode"               : "87111",
            "POBox"                  : "true",
            "SaveToAddressBook"      : "true",
            "Type"                   : null,
            "TaxId"                  : null,
            "Department"             : "IT, Sales, Marketing",
            "ShowPickupAtCheckout"   : "true",
            "Validated"              : "true or false",
            "IsPrimaryAddress"       : "true",
            "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
          }
        ],
        "Discount"                : 3.14,
        "BirthDate"               : "2017-10-30T07:00:00Z",
        "DateCreated"             : "2017-10-30T07:00:00Z",
        "LastModified"            : "2017-10-30T07:00:00Z",
        "ExternalReferenceId"     : "ExampleString",
        "StoreAnalyticsEnabled"   : "true"
      },
      "AssigneeId"                           : 1,
      "GiftMessage"                          : "Enjoy!",
      "IpAddress"                            : "23.231.20.11",
      "InHandsDate"                          : "2017-10-30T07:00:00Z",
      "PaymentMethod"                        : "CREDITCARD",
      "PaymentMethodNote"                    : "Error Processing Credit Card Payment: Your card has insufficient funds. (99)",
      "PaymentStatus"  : {"Name" : "example not found 2"},
      "CardType"                             : "Visa",
      "PurchaseOrderAttachmentUrl"           : "ExampleString",
      "BillingAddress"  : 
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      },
      "ShippingAddress"  : 
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      },
      "ShippingMethod"  : 
      {
        "CarrierId"                      : "ExampleString",
        "CarrierEstimatedDeliveryDate"   : "2017-10-30T07:00:00Z",
        "Description"                    : "UPS Ground",
        "ID"                             : 1000019,
        "Name"                           : "Ground",
        "PackageType"                    : "ExampleString",
        "PackageCode"                    : "ExampleString",
        "RateId"                         : "ExampleString",
        "ServiceCode"                    : "ExampleString",
        "ServiceType"                    : "ExampleString",
        "VendorId"                       : 1000001,
        "VendorName"                     : "UPS",
        "VendorType"                     : "UPS",
        "Price"                          : 5.00,
        "AllowBeforeAddressKnown"        : "true",
        "AllowResidential"               : "true",
        "AllowPoBox"                     : "true",
        "AllowCommercial"                : "true",
        "DiscountingEnabled"             : "true",
        "ProcessDays"                    : 2,
        "PromptForCartShipperAccount"    : "true",
        "RequireCartShipperAccount"      : "true",
        "AllowShippingAddress"           : "true",
        "ProcessMarkup"                  : null,
        "PickupSetAtStoreId"             : null,
        "TransitDays_Min"                : 3,
        "TransitDays_Max"                : 5,
        "RtMarkupDollar"                 : null,
        "RtMarkupPercent"                : null,
        "Address"  : 
        {
          "ID"                     : 1000014,
          "StateId"                : 4,
          "CountryId"              : 1,
          "Business"               : "true",
          "TaxExempt"              : "true",
          "FirstName"              : "John",
          "LastName"               : "Doe",
          "Name"                   : "John Doe",
          "CompanyName"            : "Doe Co",
          "Street1"                : "1234 Test St",
          "Street2"                : "Suite 500",
          "City"                   : "Albuquerque",
          "State"                  : "NM",
          "StateName"              : "New Mexico",
          "Country"                : "United States",
          "CountryCode"            : "US",
          "Email"                  : "ExampleString",
          "Phone"                  : "480-309-6332",
          "Fax"                    : "480-309-6333",
          "PostCode"               : "87111",
          "POBox"                  : "true",
          "SaveToAddressBook"      : "true",
          "Type"                   : null,
          "TaxId"                  : null,
          "Department"             : "IT, Sales, Marketing",
          "ShowPickupAtCheckout"   : "true",
          "Validated"              : "true or false",
          "IsPrimaryAddress"       : "true",
          "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
        },
        "PickupNotes"                    : null,
        "PickupDateStart"                : "2017-10-30T07:00:00Z",
        "PickupDateEnd"                  : "2017-10-30T07:00:00Z",
        "OffsetGmt"                      : 7,
        "PickupType"  : {"Name" : "example not found 2"},
        "CalculationType"                : "Weight",
        "ShippingSchedules"  : 
        [{"Name" : "example not found 2"}
        ],
        "IsTaxExempt"                    : "true",
        "SortOrder"                      : 1,
        "ShipToStateIds"                 : [1,2,3],
        "IsDeleted"                      : "true",
        "IsProposalPickup"               : "true"
      },
      "RetailAmount"                         : 2998.04,
      "ShippingAmount"                       : 0.00,
      "ShippingTax"                          : 0.00,
      "ShippingTaxRate"                      : 0.060000,
      "DiscountTax"                          : 0.00,
      "DiscountShipping"                     : 0.00,
      "TaxRate"                              : 0.060000,
      "TaxAmount"                            : 179.88,
      "TaxName"                              : "Tax",
      "TaxAreaId"                            : 1,
      "TotalAmount"                          : 3177.92,
      "GiftCertificateAmount"                : 0.00,
      "AmountDue"                            : 31.78,
      "RetailDiscount"                       : 2968.06,
      "TotalDiscount"                        : 3146.14,
      "QuantityDiscountAmount"               : 0.00,
      "QuantityDiscountPercent"              : 0.00,
      "ProcessAmount"                        : 31.78,
      "ProcessMarkupAmount"                  : 0.00,
      "DateCreated"                          : "2013-01-05T13:02:05Z",
      "DueDate"                              : "2013-01-05T13:02:05Z",
      "EstimatedShipDate"                    : "2013-01-18T00:00:00Z",
      "ConfirmedShipDate"                    : "2013-01-18T00:00:00Z",
      "EstimatedDeliveryDate_Min"            : "2013-01-20T00:00:00Z",
      "EstimatedDeliveryDate_Max"            : "2013-01-20T00:00:00Z",
      "PaymentRequestSentDate"               : "2017-10-30T07:00:00Z",
      "DisplayPricing"                       : "true",
      "Authorized"                           : "true",
      "Paid"                                 : "true",
      "Confirmed"                            : "true",
      "Ordered"                              : "true",
      "Received"                             : "true",
      "Prepared"                             : "true",
      "Shipped"                              : "true",
      "Cancelled"                            : "true",
      "StoreName"                            : "Awesome T-shirts",
      "StoreId"                              : 10000000,
      "Notes"                                : "Awesome T-shirts",
      "Payments"  : 
      [
        {
          "ID"                      : 1000001,
          "OrderId"                 : 1,
          "ProposalId"              : 1,
          "EventType"               : "ExampleString",
          "CardLast4"               : "ExampleString",
          "CardType"                : "ExampleString",
          "ResponseCode"            : "ExampleString",
          "TransactionId"           : "ExampleString",
          "OriginalTransactionId"   : "ExampleString",
          "ApprovalCode"            : "ExampleString",
          "AvsCode"                 : "ExampleString",
          "DateCreated"             : "2017-10-30T07:00:00Z",
          "DateVoided"              : "2017-10-30T07:00:00Z",
          "TestMode"                : "true",
          "GatewayAccount"          : "ExampleString",
          "GiftCertificateId"       : 1,
          "Amount"                  : 3.14,
          "ProcessingFee"           : 3.14,
          "InkSoftFee"              : 3.14,
          "GatewayName"             : "ExampleString",
          "AttachmentFileName"      : "ExampleString",
          "Notes"                   : "ExampleString",
          "BillingAddress"  : 
          {
            "ID"                     : 1000014,
            "StateId"                : 4,
            "CountryId"              : 1,
            "Business"               : "true",
            "TaxExempt"              : "true",
            "FirstName"              : "John",
            "LastName"               : "Doe",
            "Name"                   : "John Doe",
            "CompanyName"            : "Doe Co",
            "Street1"                : "1234 Test St",
            "Street2"                : "Suite 500",
            "City"                   : "Albuquerque",
            "State"                  : "NM",
            "StateName"              : "New Mexico",
            "Country"                : "United States",
            "CountryCode"            : "US",
            "Email"                  : "ExampleString",
            "Phone"                  : "480-309-6332",
            "Fax"                    : "480-309-6333",
            "PostCode"               : "87111",
            "POBox"                  : "true",
            "SaveToAddressBook"      : "true",
            "Type"                   : null,
            "TaxId"                  : null,
            "Department"             : "IT, Sales, Marketing",
            "ShowPickupAtCheckout"   : "true",
            "Validated"              : "true or false",
            "IsPrimaryAddress"       : "true",
            "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
          }
        }
      ],
      "ProductStyleSizePrices"  : 
      [
        {
          "ProductStyleSizeId"   : 1,
          "PriceEach"            : 3.14,
          "CostEach"             : 3.14
        }
      ],
      "Items"  : 
      [
        {
          "OrderRetailItemId"                    : 1,
          "OrderRetailItemSizeId"                : 1,
          "InProduction"                         : "true",
          "OriginalOrderRetailItemId"            : 1,
          "KeepExistingPrintMethod"              : "true",
          "AddOns"  : 
          [
            {
              "ID"            : 1,
              "Quantity"      : 1,
              "Name"          : "ExampleString",
              "Description"   : "ExampleString",
              "Price"         : 3.14
            }
          ],
          "ArtId"                                : 1,
          "DesignId"                             : 1,
          "EstimatedProductionDays"              : 1,
          "FullName"                             : "ExampleString",
          "ItemTotal"                            : 3.14,
          "NameNumberValues"  : 
          [
            {
              "RetailItemSizeId"   : 1000000,
              "Name"               : "Bob",
              "Number"             : "32",
              "Quantity"           : 1,
              "Price"              : 32
            }
          ],
          "Notes"                                : "ExampleString",
          "PersonalizationValues"  : 
          [
            {
              "Name"                       : "ExampleString",
              "Value"                      : "ExampleString",
              "Price"                      : 3.14,
              "ProductPersonalizationId"   : 1
            }
          ],
          "PrintCost"                            : 3.14,
          "PrintCostOverride"                    : 3.14,
          "PrintOverridePriceBack"               : 3.14,
          "PrintOverridePriceFront"              : 3.14,
          "PrintOverridePriceSleeveLeft"         : 3.14,
          "PrintOverridePriceSleeveRight"        : 3.14,
          "PrintPriceBack"                       : 3.14,
          "PrintPriceFront"                      : 3.14,
          "PrintPriceSleeveLeft"                 : 3.14,
          "PrintPriceSleeveRight"                : 3.14,
          "PrintSetupCharge"                     : 3.14,
          "PrintSetupOverridePriceBack"          : 3.14,
          "PrintSetupOverridePriceFront"         : 3.14,
          "PrintSetupOverridePriceSleeveLeft"    : 3.14,
          "PrintSetupOverridePriceSleeveRight"   : 3.14,
          "PrintSetupPriceBack"                  : 3.14,
          "PrintSetupPriceFront"                 : 3.14,
          "PrintSetupPriceSleeveLeft"            : 3.14,
          "PrintSetupPriceSleeveRight"           : 3.14,
          "ProductId"                            : 1,
          "ProductPriceEach"                     : 3.14,
          "ProductPriceEachOverride"             : 3.14,
          "ProductStyleId"                       : 1,
          "ProductStyleSizeId"                   : 1,
          "Quantity"                             : 1,
          "QuantityDiscountAmount"               : 3.14,
          "QuantityDiscountPercent"              : 3.14,
          "RetailItemId"                         : 1,
          "RetailItemSizeId"                     : 1,
          "SideColorways"  : 
          [
            {
              "SideId"       : "ExampleString",
              "ColorwayId"   : 1
            }
          ],
          "SidePreviews"  : 
          [
            {
              "SideName"             : "ExampleString",
              "ProductOnlyUrl"       : "ExampleString",
              "DesignOnlyUrl"        : "ExampleString",
              "DesignOnProductUrl"   : "ExampleString",
              "SideArtId"            : 1
            }
          ],
          "TaxRate"                              : 3.14,
          "TaxRateOverride"                      : 3.14,
          "UnitPrice"                            : 3.14,
          "UniqueId"                             : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7"
        }
      ],
      "Shipments"  : 
      [
        {
          "ID"             : 1,
          "OrderId"        : 1,
          "PackageCount"   : 1,
          "DateCreated"    : "2017-10-30T07:00:00Z",
          "LastModified"   : "2017-10-30T07:00:00Z",
          "Notes"          : "ExampleString",
          "PickedUpBy"     : "ExampleString",
          "Pickup"         : "true",
          "ToAddress"  : 
          {
            "ID"                     : 1000014,
            "StateId"                : 4,
            "CountryId"              : 1,
            "Business"               : "true",
            "TaxExempt"              : "true",
            "FirstName"              : "John",
            "LastName"               : "Doe",
            "Name"                   : "John Doe",
            "CompanyName"            : "Doe Co",
            "Street1"                : "1234 Test St",
            "Street2"                : "Suite 500",
            "City"                   : "Albuquerque",
            "State"                  : "NM",
            "StateName"              : "New Mexico",
            "Country"                : "United States",
            "CountryCode"            : "US",
            "Email"                  : "ExampleString",
            "Phone"                  : "480-309-6332",
            "Fax"                    : "480-309-6333",
            "PostCode"               : "87111",
            "POBox"                  : "true",
            "SaveToAddressBook"      : "true",
            "Type"                   : null,
            "TaxId"                  : null,
            "Department"             : "IT, Sales, Marketing",
            "ShowPickupAtCheckout"   : "true",
            "Validated"              : "true or false",
            "IsPrimaryAddress"       : "true",
            "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
          },
          "FromAddress"  : 
          {
            "ID"                     : 1000014,
            "StateId"                : 4,
            "CountryId"              : 1,
            "Business"               : "true",
            "TaxExempt"              : "true",
            "FirstName"              : "John",
            "LastName"               : "Doe",
            "Name"                   : "John Doe",
            "CompanyName"            : "Doe Co",
            "Street1"                : "1234 Test St",
            "Street2"                : "Suite 500",
            "City"                   : "Albuquerque",
            "State"                  : "NM",
            "StateName"              : "New Mexico",
            "Country"                : "United States",
            "CountryCode"            : "US",
            "Email"                  : "ExampleString",
            "Phone"                  : "480-309-6332",
            "Fax"                    : "480-309-6333",
            "PostCode"               : "87111",
            "POBox"                  : "true",
            "SaveToAddressBook"      : "true",
            "Type"                   : null,
            "TaxId"                  : null,
            "Department"             : "IT, Sales, Marketing",
            "ShowPickupAtCheckout"   : "true",
            "Validated"              : "true or false",
            "IsPrimaryAddress"       : "true",
            "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
          },
          "Packages"  : 
          [
            {
              "ID"                      : 1,
              "ShippedDate"             : "2017-10-30T07:00:00Z",
              "TrackingNumber"          : "ExampleString",
              "TrackingUrl"             : "ExampleString",
              "ShippingServiceType"     : "ExampleString",
              "Status"                  : "ExampleString",
              "CarrierName"             : "ExampleString",
              "ShippingLabelFileName"   : "ExampleString",
              "LabelCost"               : 3.14,
              "Items"  : 
              [
                {
                  "Guid"       : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
                  "ItemGuid"   : "",
                  "Quantity"   : 1
                }
              ]
            }
          ]
        }
      ],
      "GiftCertificates"  : 
      [
        {
          "Amount"                  : 34.00,
          "AppliedAmount"           : 34.00,
          "InitialPurchaseAmount"   : 3.14,
          "Created"                 : "2017-10-30T07:00:00Z",
          "DateSent"                : "2017-10-30T07:00:00Z",
          "HasOrders"               : "true",
          "Number"                  : "CA77-EE66-GD6C-4E44",
          "ToName"                  : "John Doe",
          "ToEmail"                 : "John Doe"
        }
      ],
      "PurchasedGiftCertificates"  : 
      [
        {
          "Amount"                  : 34.00,
          "AppliedAmount"           : 34.00,
          "InitialPurchaseAmount"   : 3.14,
          "Created"                 : "2017-10-30T07:00:00Z",
          "DateSent"                : "2017-10-30T07:00:00Z",
          "HasOrders"               : "true",
          "Number"                  : "CA77-EE66-GD6C-4E44",
          "ToName"                  : "John Doe",
          "ToEmail"                 : "John Doe"
        }
      ],
      "NameNumberSettings"  : 
      [
        {
          "Name"  : 
          {
            "FontId"      : 1,
            "Size"        : "12",
            "Color"       : "FF0000",
            "ColorName"   : "Red"
          },
          "Number"  : 
          {
            "FontId"      : 1,
            "Size"        : "12",
            "Color"       : "FF0000",
            "ColorName"   : "Red"
          },
          "ProductStyleId"     : 1000001,
          "ArtId"              : null,
          "DesignId"           : null,
          "CartRetailItemId"   : 1000013,
          "PrintCost"          : null
        }
      ],
      "CheckoutFieldValues"  : 
      {
        "Item"  : {"Name" : "example not found 2"}
      },
      "ProductStyleSizeInventoryStatuses"  : 
      {
        "Item"  : {"Name" : "example not found 2"}
      },
      "ShortCodes"  : 
      {
        "Item"  : {"Name" : "example not found 2"}
      },
      "Timeline"  : 
      [
        {
          "EventDescription"    : ,
          "ID"                  : 1,
          "ContactIds"          : [1,2,3],
          "CompanyIds"          : [1,2,3],
          "JobIds"              : [1,2,3],
          "OrderIds"            : [1,2,3],
          "ProposalIds"         : [1,2,3],
          "ProductionCardIds"   : [1,2,3],
          "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
          "Event"               : "ExampleString",
          "Comment"             : "ExampleString",
          "EventType"  : {"Name" : "example not found 2"},
          "Edited"              : "true",
          "EditedDate"          : "2017-10-30T07:00:00Z",
          "Deleted"             : "true",
          "DeletedDate"         : "2017-10-30T07:00:00Z",
          "Created"             : "2017-10-30T07:00:00Z",
          "CreatedByUserId"     : 1,
          "CreatedByName"       : "ExampleString",
          "Details"  : 
          [
            {
              "Property"   : "ExampleString",
              "OldValue"   : "ExampleString",
              "NewValue"   : "ExampleString",
              "Date"       : "2017-10-30T07:00:00Z"
            }
          ],
          "Associations"  : {"Name" : "example not found 2"}
        }
      ],
      "ExportedToQuickBooks"                 : "true",
      "DateExportedToQuickBooks"             : "2017-10-30T07:00:00Z",
      "ContactEmailAddresses"                : [ExampleString,ExampleString,ExampleString],
      "TotalAdjustments"  : 
      [
        {
          "ID"               : 1,
          "Type"             : "",
          "Description"      : "ExampleString",
          "Percentage"       : 3.14,
          "Amount"           : 3.14,
          "CreatedByName"    : "ExampleString",
          "Created"          : "2017-10-30T07:00:00Z",
          "ModifiedByName"   : "ExampleString",
          "LastModified"     : "2017-10-30T07:00:00Z"
        }
      ],
      "ProductionCards"  : 
      [
        {
          "ID"                        : 1000001,
          "JobId"                     : 1,
          "JobName"                   : "ExampleString",
          "JobStatusName"             : "ExampleString",
          "JobStatusId"               : 1,
          "JobNumber"                 : "ExampleString",
          "OrderId"                   : 1,
          "PrintavoOrderId"           : "ExampleString",
          "PrintavoOrderLink"         : "ExampleString",
          "SalesDocGuid"              : "",
          "DecorationGuid"            : "",
          "OrderFirstName"            : "ExampleString",
          "OrderLastName"             : "ExampleString",
          "OrderEmail"                : "ExampleString",
          "OrderStoreName"            : "ExampleString",
          "OrderDate"                 : "2017-10-30T07:00:00Z",
          "OrderRetailItemId"         : 1,
          "OrderPaymentStatus"        : "",
          "Number"                    : "ExampleString",
          "DesignGroupKey"            : "ExampleString",
          "ShipDate"                  : "2017-10-30T07:00:00Z",
          "OrderIsPickup"             : "true",
          "ProductId"                 : 1,
          "ProductName"               : "ExampleString",
          "ProductSku"                : "ExampleString",
          "ProductManufacturer"       : "ExampleString",
          "ProductSupplier"           : "ExampleString",
          "ProductStyleName"          : "ExampleString",
          "ProductStyleId"            : 1,
          "DesignName"                : "ExampleString",
          "DesignType"                : "",
          "Art"  : 
          {
            "ID"                    : 1,
            "ColorCount"            : 1,
            "Colors"                : ["#FF0000","#FFFFFF","#0000FF"],
            "OriginalColorway"  : 
            {
              "ID"             : 1,
              "Colors"  : 
              [
                {
                  "Index"                : 1,
                  "Color"                : "ExampleString",
                  "EmbroideryThreadId"   : 1,
                  "InkColorId"           : 1,
                  "ColorName"            : "ExampleString",
                  "PMS"                  : "ExampleString"
                }
              ],
              "Name"           : "ExampleString",
              "SvgUrl"         : "ExampleString",
              "RenderedUrl"    : "ExampleString",
              "ThumbnailUrl"   : "ExampleString"
            },
            "StitchCount"           : 1,
            "TrimCount"             : 1,
            "GalleryId"             : 1,
            "CategoryIds"           : [1,2,3],
            "Name"                  : "Business_Designs",
            "Type"                  : "ExampleString",
            "Keywords"              : "pretty,big,black and white,zebra",
            "FixedSvg"              : "true",
            "Digitized"             : "true",
            "CanScreenPrint"        : "true",
            "FullName"              : "store5976/Business/Business_Designs",
            "ExternalReferenceID"   : "ExampleString",
            "Width"                 : 762,
            "Height"                : 538,
            "Notes"                 : "ExampleString",
            "FileExt"               : "png",
            "ImageUrl"              : "ExampleString",
            "ThumbUrl"              : "ExampleString",
            "ThumbUrlAlt"           : "ExampleString",
            "OriginalUrl"           : "ExampleString",
            "UploadedUrl"           : "ExampleString",
            "UploadedOn"            : "2017-10-30T07:00:00Z",
            "IsActive"              : "true",
            "Colorways"  : 
            [
              {
                "ID"             : 1,
                "Colors"  : 
                [
                  {
                    "Index"                : 1,
                    "Color"                : "ExampleString",
                    "EmbroideryThreadId"   : 1,
                    "InkColorId"           : 1,
                    "ColorName"            : "ExampleString",
                    "PMS"                  : "ExampleString"
                  }
                ],
                "Name"           : "ExampleString",
                "SvgUrl"         : "ExampleString",
                "RenderedUrl"    : "ExampleString",
                "ThumbnailUrl"   : "ExampleString"
              }
            ],
            "UniqueId"              : "",
            "MatchFileColor"        : "true"
          },
          "ArtId"                     : 1,
          "DesignId"                  : 1,
          "ColorwayId"                : 1,
          "CanvasId"                  : 1,
          "Side"                      : "ExampleString",
          "SideInternalName"          : "ExampleString",
          "RegionName"                : "ExampleString",
          "Region"  : 
          {
            "ID"                          : 1000001,
            "Name"                        : "Full",
            "X"                           : 10,
            "Y"                           : 10,
            "Width"                       : 100,
            "Height"                      : 200,
            "Rotation"                    : null,
            "Shape"                       : null,
            "Side"                        : "front",
            "IsDefault"                   : "true",
            "ProductRegionRenderSizeId"   : 1,
            "RenderWidthInches"           : null,
            "RenderHeightInches"          : null
          },
          "ProductType"  : {"Name" : "example not found 2"},
          "SizeUnit"                  : "ExampleString",
          "ProductUrl"                : "ExampleString",
          "PreviewUrl"                : "ExampleString",
          "DesignUrl"                 : "ExampleString",
          "ArtUrl"                    : "ExampleString",
          "PrintMethod"               : "ExampleString",
          "Quantity"                  : 1,
          "ColorCount"                : 1,
          "ProductionNotes"           : "ExampleString",
          "OrderNotes"                : "ExampleString",
          "OrderItemNotes"            : "ExampleString",
          "DateCompleted"             : "2017-10-30T07:00:00Z",
          "Timeline"  : 
          [
            {
              "EventDescription"    : ,
              "ID"                  : 1,
              "ContactIds"          : [1,2,3],
              "CompanyIds"          : [1,2,3],
              "JobIds"              : [1,2,3],
              "OrderIds"            : [1,2,3],
              "ProposalIds"         : [1,2,3],
              "ProductionCardIds"   : [1,2,3],
              "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
              "Event"               : "ExampleString",
              "Comment"             : "ExampleString",
              "EventType"  : {"Name" : "example not found 2"},
              "Edited"              : "true",
              "EditedDate"          : "2017-10-30T07:00:00Z",
              "Deleted"             : "true",
              "DeletedDate"         : "2017-10-30T07:00:00Z",
              "Created"             : "2017-10-30T07:00:00Z",
              "CreatedByUserId"     : 1,
              "CreatedByName"       : "ExampleString",
              "Details"  : 
              [
                {
                  "Property"   : "ExampleString",
                  "OldValue"   : "ExampleString",
                  "NewValue"   : "ExampleString",
                  "Date"       : "2017-10-30T07:00:00Z"
                }
              ],
              "Associations"  : {"Name" : "example not found 2"}
            }
          ],
          "Attachments"  : 
          [
            {
              "ID"                 : 1000001,
              "Type"  : {"Name" : "example not found 2"},
              "ProductionCardId"   : 1,
              "OriginalName"       : "ExampleString",
              "Name"               : "ExampleString",
              "Description"        : "ExampleString",
              "MimeType"           : "ExampleString",
              "Url"                : "ExampleString",
              "UrlThumbnail"       : "ExampleString",
              "UrlPreview"         : "ExampleString"
            }
          ],
          "Colors"  : 
          [
            {
              "ID"                  : 1000001,
              "ProductionCardId"    : 1,
              "Index"               : 1,
              "Name"                : "ExampleString",
              "PMS"                 : "ExampleString",
              "HtmlColor"           : "ExampleString",
              "ThreadLibraryName"   : "ExampleString",
              "ThreadChartName"     : "ExampleString",
              "ThreadColorName"     : "ExampleString",
              "ThreadColorCode"     : "ExampleString"
            }
          ],
          "Items"  : 
          [
            {
              "ID"                      : 1000001,
              "ProductionCardId"        : 1,
              "SalesDocItemGuid"        : "",
              "Size"                    : "ExampleString",
              "Quantity"                : 1,
              "Status"                  : "ExampleString",
              "PurchasingStatus"        : "ExampleString",
              "IsComplete"              : "true",
              "PersonalizationValues"  : 
              [
                {
                  "Name"                       : "ExampleString",
                  "Value"                      : "ExampleString",
                  "Price"                      : 3.14,
                  "ProductPersonalizationId"   : 1
                }
              ],
              "NameNumberValue"  : 
              {
                "RetailItemSizeId"   : 1000000,
                "Name"               : "Bob",
                "Number"             : "32",
                "Quantity"           : 1,
                "Price"              : 32
              },
              "SortOrder"               : 1
            }
          ],
          "ColorwayName"              : "ExampleString",
          "ProductHtmlColor"          : "ExampleString",
          "ProductShape"              : "ExampleString",
          "EstimatedProductionDays"   : 1
        }
      ],
      "CustomLineItems"  : 
      [
        {
          "ID"                     : 1,
          "ParentId"               : 1,
          "UniqueId"               : "",
          "Name"                   : "ExampleString",
          "Description"            : "ExampleString",
          "ImageUrl"               : "ExampleString",
          "Taxable"                : "true",
          "TaxRate"                : 3.14,
          "TaxRateOverride"        : 3.14,
          "UnitCost"               : 3.14,
          "UnitPrice"              : 3.14,
          "UnitWeight"             : 3.14,
          "Quantity"               : 1,
          "UnitType"  : {"Name" : "example not found 2"},
          "Active"                 : "true",
          "Size"                   : "ExampleString",
          "Style"                  : "ExampleString",
          "CustomLineItemImages"  : 
          [
            {
              "ID"         : 1,
              "UniqueId"   : "",
              "ImageUrl"   : "ExampleString",
              "Deleted"    : "true"
            }
          ]
        }
      ],
      "ReadyForPickupNotificationSentDate"   : "2017-10-30T07:00:00Z",
      "ApprovalRequired"                     : "true",
      "ApprovalDate"                         : "2013-01-20T00:00:00Z",
      "LineItemNotes"  : 
      [
        {
          "ID"                      : 1000001,
          "OrderId"                 : 1,
          "ProposalId"              : 1,
          "ArtId"                   : 1,
          "DesignId"                : 1,
          "CustomLineItemId"        : 1,
          "ProductStyleId"          : 1,
          "PersonalizationValues"   : "ExampleString",
          "Content"                 : "ExampleString",
          "DateCreated"             : "2017-10-30T07:00:00Z",
          "DateModified"            : "2017-10-30T07:00:00Z",
          "UniqueId"                : "",
          "ItemGuid"                : ""
        }
      ]
    }
  ],
  "SalesDocs"  : 
  [{"Name" : "example not found 2"}
  ],
  "Proposals"  : 
  [
    {
      "ID"                        : 1,
      "CartId"                    : 1,
      "Number"                    : "ExampleString",
      "UniqueId"                  : "",
      "Name"                      : "ExampleString",
      "PurchaseOrderNumber"       : "ExampleString",
      "AssigneeId"                : 1,
      "AssigneeName"              : "ExampleString",
      "AssigneeEmail"             : "ExampleString",
      "StoreEmail"                : "ExampleString",
      "StorePhone"                : "ExampleString",
      "PrimaryContactId"          : 1,
      "PrimaryContactName"        : "ExampleString",
      "PrimaryContactEmail"       : "ExampleString",
      "Deleted"                   : "true",
      "DepositAmount"             : 3.14,
      "DepositPercent"            : 3.14,
      "PartialPaymentAllowed"     : "true",
      "Arts"  : 
      [
        {
          "ID"                    : 1,
          "ColorCount"            : 1,
          "Colors"                : ["#FF0000","#FFFFFF","#0000FF"],
          "OriginalColorway"  : 
          {
            "ID"             : 1,
            "Colors"  : 
            [
              {
                "Index"                : 1,
                "Color"                : "ExampleString",
                "EmbroideryThreadId"   : 1,
                "InkColorId"           : 1,
                "ColorName"            : "ExampleString",
                "PMS"                  : "ExampleString"
              }
            ],
            "Name"           : "ExampleString",
            "SvgUrl"         : "ExampleString",
            "RenderedUrl"    : "ExampleString",
            "ThumbnailUrl"   : "ExampleString"
          },
          "StitchCount"           : 1,
          "TrimCount"             : 1,
          "GalleryId"             : 1,
          "CategoryIds"           : [1,2,3],
          "Name"                  : "Business_Designs",
          "Type"                  : "ExampleString",
          "Keywords"              : "pretty,big,black and white,zebra",
          "FixedSvg"              : "true",
          "Digitized"             : "true",
          "CanScreenPrint"        : "true",
          "FullName"              : "store5976/Business/Business_Designs",
          "ExternalReferenceID"   : "ExampleString",
          "Width"                 : 762,
          "Height"                : 538,
          "Notes"                 : "ExampleString",
          "FileExt"               : "png",
          "ImageUrl"              : "ExampleString",
          "ThumbUrl"              : "ExampleString",
          "ThumbUrlAlt"           : "ExampleString",
          "OriginalUrl"           : "ExampleString",
          "UploadedUrl"           : "ExampleString",
          "UploadedOn"            : "2017-10-30T07:00:00Z",
          "IsActive"              : "true",
          "Colorways"  : 
          [
            {
              "ID"             : 1,
              "Colors"  : 
              [
                {
                  "Index"                : 1,
                  "Color"                : "ExampleString",
                  "EmbroideryThreadId"   : 1,
                  "InkColorId"           : 1,
                  "ColorName"            : "ExampleString",
                  "PMS"                  : "ExampleString"
                }
              ],
              "Name"           : "ExampleString",
              "SvgUrl"         : "ExampleString",
              "RenderedUrl"    : "ExampleString",
              "ThumbnailUrl"   : "ExampleString"
            }
          ],
          "UniqueId"              : "",
          "MatchFileColor"        : "true"
        }
      ],
      "Payments"  : 
      [
        {
          "ID"                      : 1000001,
          "OrderId"                 : 1,
          "ProposalId"              : 1,
          "EventType"               : "ExampleString",
          "CardLast4"               : "ExampleString",
          "CardType"                : "ExampleString",
          "ResponseCode"            : "ExampleString",
          "TransactionId"           : "ExampleString",
          "OriginalTransactionId"   : "ExampleString",
          "ApprovalCode"            : "ExampleString",
          "AvsCode"                 : "ExampleString",
          "DateCreated"             : "2017-10-30T07:00:00Z",
          "DateVoided"              : "2017-10-30T07:00:00Z",
          "TestMode"                : "true",
          "GatewayAccount"          : "ExampleString",
          "GiftCertificateId"       : 1,
          "Amount"                  : 3.14,
          "ProcessingFee"           : 3.14,
          "InkSoftFee"              : 3.14,
          "GatewayName"             : "ExampleString",
          "AttachmentFileName"      : "ExampleString",
          "Notes"                   : "ExampleString",
          "BillingAddress"  : 
          {
            "ID"                     : 1000014,
            "StateId"                : 4,
            "CountryId"              : 1,
            "Business"               : "true",
            "TaxExempt"              : "true",
            "FirstName"              : "John",
            "LastName"               : "Doe",
            "Name"                   : "John Doe",
            "CompanyName"            : "Doe Co",
            "Street1"                : "1234 Test St",
            "Street2"                : "Suite 500",
            "City"                   : "Albuquerque",
            "State"                  : "NM",
            "StateName"              : "New Mexico",
            "Country"                : "United States",
            "CountryCode"            : "US",
            "Email"                  : "ExampleString",
            "Phone"                  : "480-309-6332",
            "Fax"                    : "480-309-6333",
            "PostCode"               : "87111",
            "POBox"                  : "true",
            "SaveToAddressBook"      : "true",
            "Type"                   : null,
            "TaxId"                  : null,
            "Department"             : "IT, Sales, Marketing",
            "ShowPickupAtCheckout"   : "true",
            "Validated"              : "true or false",
            "IsPrimaryAddress"       : "true",
            "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
          }
        }
      ],
      "PaymentStatus"  : {"Name" : "example not found 2"},
      "SentDate"                  : "2017-10-30T07:00:00Z",
      "ApprovedDate"              : "2017-10-30T07:00:00Z",
      "DueDate"                   : "2017-10-30T07:00:00Z",
      "DueInDays"                 : 1,
      "TaxRate"                   : 3.14,
      "TaxExempt"                 : "true",
      "TaxExemptReason"           : "ExampleString",
      "ShippingHandlingTaxable"   : "true",
      "ExpirationDate"            : "2017-10-30T07:00:00Z",
      "InHandsDate"               : "2017-10-30T07:00:00Z",
      "OrderCreatedDate"          : "2017-10-30T07:00:00Z",
      "OrderId"                   : 1,
      "OrderProductionStatus"     : "",
      "LostDate"                  : "2017-10-30T07:00:00Z",
      "Notes"                     : "ExampleString",
      "Status"  : {"Name" : "example not found 2"},
      "ApprovalStatus"  : {"Name" : "example not found 2"},
      "DisplayManufacturerName"   : "true",
      "DisplayManufacturerSku"    : "true",
      "ShippingTaxable"           : "true",
      "ShippingAddress"  : 
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      },
      "ShippingMethod"  : 
      {
        "CarrierId"                      : "ExampleString",
        "CarrierEstimatedDeliveryDate"   : "2017-10-30T07:00:00Z",
        "Description"                    : "UPS Ground",
        "ID"                             : 1000019,
        "Name"                           : "Ground",
        "PackageType"                    : "ExampleString",
        "PackageCode"                    : "ExampleString",
        "RateId"                         : "ExampleString",
        "ServiceCode"                    : "ExampleString",
        "ServiceType"                    : "ExampleString",
        "VendorId"                       : 1000001,
        "VendorName"                     : "UPS",
        "VendorType"                     : "UPS",
        "Price"                          : 5.00,
        "AllowBeforeAddressKnown"        : "true",
        "AllowResidential"               : "true",
        "AllowPoBox"                     : "true",
        "AllowCommercial"                : "true",
        "DiscountingEnabled"             : "true",
        "ProcessDays"                    : 2,
        "PromptForCartShipperAccount"    : "true",
        "RequireCartShipperAccount"      : "true",
        "AllowShippingAddress"           : "true",
        "ProcessMarkup"                  : null,
        "PickupSetAtStoreId"             : null,
        "TransitDays_Min"                : 3,
        "TransitDays_Max"                : 5,
        "RtMarkupDollar"                 : null,
        "RtMarkupPercent"                : null,
        "Address"  : 
        {
          "ID"                     : 1000014,
          "StateId"                : 4,
          "CountryId"              : 1,
          "Business"               : "true",
          "TaxExempt"              : "true",
          "FirstName"              : "John",
          "LastName"               : "Doe",
          "Name"                   : "John Doe",
          "CompanyName"            : "Doe Co",
          "Street1"                : "1234 Test St",
          "Street2"                : "Suite 500",
          "City"                   : "Albuquerque",
          "State"                  : "NM",
          "StateName"              : "New Mexico",
          "Country"                : "United States",
          "CountryCode"            : "US",
          "Email"                  : "ExampleString",
          "Phone"                  : "480-309-6332",
          "Fax"                    : "480-309-6333",
          "PostCode"               : "87111",
          "POBox"                  : "true",
          "SaveToAddressBook"      : "true",
          "Type"                   : null,
          "TaxId"                  : null,
          "Department"             : "IT, Sales, Marketing",
          "ShowPickupAtCheckout"   : "true",
          "Validated"              : "true or false",
          "IsPrimaryAddress"       : "true",
          "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
        },
        "PickupNotes"                    : null,
        "PickupDateStart"                : "2017-10-30T07:00:00Z",
        "PickupDateEnd"                  : "2017-10-30T07:00:00Z",
        "OffsetGmt"                      : 7,
        "PickupType"  : {"Name" : "example not found 2"},
        "CalculationType"                : "Weight",
        "ShippingSchedules"  : 
        [{"Name" : "example not found 2"}
        ],
        "IsTaxExempt"                    : "true",
        "SortOrder"                      : 1,
        "ShipToStateIds"                 : [1,2,3],
        "IsDeleted"                      : "true",
        "IsProposalPickup"               : "true"
      },
      "ShippingAmount"            : 3.14,
      "DateCreated"               : "2017-10-30T07:00:00Z",
      "CreatedByUserId"           : 1,
      "Modified"                  : "2017-10-30T07:00:00Z",
      "ModifiedByUserId"          : 1,
      "CustomLineItems"  : 
      [
        {
          "ID"                     : 1,
          "ParentId"               : 1,
          "UniqueId"               : "",
          "Name"                   : "ExampleString",
          "Description"            : "ExampleString",
          "ImageUrl"               : "ExampleString",
          "Taxable"                : "true",
          "TaxRate"                : 3.14,
          "TaxRateOverride"        : 3.14,
          "UnitCost"               : 3.14,
          "UnitPrice"              : 3.14,
          "UnitWeight"             : 3.14,
          "Quantity"               : 1,
          "UnitType"  : {"Name" : "example not found 2"},
          "Active"                 : "true",
          "Size"                   : "ExampleString",
          "Style"                  : "ExampleString",
          "CustomLineItemImages"  : 
          [
            {
              "ID"         : 1,
              "UniqueId"   : "",
              "ImageUrl"   : "ExampleString",
              "Deleted"    : "true"
            }
          ]
        }
      ],
      "CartItems"  : 
      [
        {
          "CartRetailItemId"                     : 1,
          "CartRetailItemSizeId"                 : 1,
          "ProductSku"                           : "ExampleString",
          "ProductName"                          : "ExampleString",
          "AddOns"  : 
          [
            {
              "ID"            : 1,
              "Quantity"      : 1,
              "Name"          : "ExampleString",
              "Description"   : "ExampleString",
              "Price"         : 3.14
            }
          ],
          "ArtId"                                : 1,
          "DesignId"                             : 1,
          "EstimatedProductionDays"              : 1,
          "FullName"                             : "ExampleString",
          "ItemTotal"                            : 3.14,
          "NameNumberValues"  : 
          [
            {
              "RetailItemSizeId"   : 1000000,
              "Name"               : "Bob",
              "Number"             : "32",
              "Quantity"           : 1,
              "Price"              : 32
            }
          ],
          "Notes"                                : "ExampleString",
          "PersonalizationValues"  : 
          [
            {
              "Name"                       : "ExampleString",
              "Value"                      : "ExampleString",
              "Price"                      : 3.14,
              "ProductPersonalizationId"   : 1
            }
          ],
          "PrintCost"                            : 3.14,
          "PrintCostOverride"                    : 3.14,
          "PrintOverridePriceBack"               : 3.14,
          "PrintOverridePriceFront"              : 3.14,
          "PrintOverridePriceSleeveLeft"         : 3.14,
          "PrintOverridePriceSleeveRight"        : 3.14,
          "PrintPriceBack"                       : 3.14,
          "PrintPriceFront"                      : 3.14,
          "PrintPriceSleeveLeft"                 : 3.14,
          "PrintPriceSleeveRight"                : 3.14,
          "PrintSetupCharge"                     : 3.14,
          "PrintSetupOverridePriceBack"          : 3.14,
          "PrintSetupOverridePriceFront"         : 3.14,
          "PrintSetupOverridePriceSleeveLeft"    : 3.14,
          "PrintSetupOverridePriceSleeveRight"   : 3.14,
          "PrintSetupPriceBack"                  : 3.14,
          "PrintSetupPriceFront"                 : 3.14,
          "PrintSetupPriceSleeveLeft"            : 3.14,
          "PrintSetupPriceSleeveRight"           : 3.14,
          "ProductId"                            : 1,
          "ProductPriceEach"                     : 3.14,
          "ProductPriceEachOverride"             : 3.14,
          "ProductStyleId"                       : 1,
          "ProductStyleSizeId"                   : 1,
          "Quantity"                             : 1,
          "QuantityDiscountAmount"               : 3.14,
          "QuantityDiscountPercent"              : 3.14,
          "RetailItemId"                         : 1,
          "RetailItemSizeId"                     : 1,
          "SideColorways"  : 
          [
            {
              "SideId"       : "ExampleString",
              "ColorwayId"   : 1
            }
          ],
          "SidePreviews"  : 
          [
            {
              "SideName"             : "ExampleString",
              "ProductOnlyUrl"       : "ExampleString",
              "DesignOnlyUrl"        : "ExampleString",
              "DesignOnProductUrl"   : "ExampleString",
              "SideArtId"            : 1
            }
          ],
          "TaxRate"                              : 3.14,
          "TaxRateOverride"                      : 3.14,
          "UnitPrice"                            : 3.14,
          "UniqueId"                             : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7"
        }
      ],
      "LostReason"                : "ExampleString",
      "LostComment"               : "ExampleString",
      "ItemQuantity"              : 1,
      "PrintCost"                 : 3.14,
      "RetailAmount"              : 3.14,
      "TaxAmount"                 : 3.14,
      "TotalAmount"               : 3.14,
      "ProcessMarkupAmount"       : 3.14,
      "AmountDue"                 : 3.14,
      "ArchivedDate"              : "2017-10-30T07:00:00Z",
      "Timeline"  : 
      [
        {
          "EventDescription"    : ,
          "ID"                  : 1,
          "ContactIds"          : [1,2,3],
          "CompanyIds"          : [1,2,3],
          "JobIds"              : [1,2,3],
          "OrderIds"            : [1,2,3],
          "ProposalIds"         : [1,2,3],
          "ProductionCardIds"   : [1,2,3],
          "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
          "Event"               : "ExampleString",
          "Comment"             : "ExampleString",
          "EventType"  : {"Name" : "example not found 2"},
          "Edited"              : "true",
          "EditedDate"          : "2017-10-30T07:00:00Z",
          "Deleted"             : "true",
          "DeletedDate"         : "2017-10-30T07:00:00Z",
          "Created"             : "2017-10-30T07:00:00Z",
          "CreatedByUserId"     : 1,
          "CreatedByName"       : "ExampleString",
          "Details"  : 
          [
            {
              "Property"   : "ExampleString",
              "OldValue"   : "ExampleString",
              "NewValue"   : "ExampleString",
              "Date"       : "2017-10-30T07:00:00Z"
            }
          ],
          "Associations"  : {"Name" : "example not found 2"}
        }
      ],
      "Views"  : 
      [
        {
          "UserId"       : 1,
          "LastViewed"   : "2017-10-30T07:00:00Z"
        }
      ],
      "Discount"  : 
      {
        "ID"                       : 100000,
        "CouponCode"               : "sale",
        "Description"              : null,
        "DiscountCode"             : "ExampleString",
        "ExcludeDesigns"           : "ExampleString",
        "ExcludeProducts"          : "ExampleString",
        "ExcludeProductStyles"     : "ExampleString",
        "ExcludeShippingMethods"   : "ExampleString",
        "ExcludeStores"            : "ExampleString",
        "Name"                     : "Promotion",
        "OnlyDesigns"              : "ExampleString",
        "OnlyProducts"             : "ExampleString",
        "OnlyProductStyles"        : "ExampleString",
        "OnlyStores"               : "ExampleString",
        "DiscountItems"            : "true",
        "DiscountShipping"         : "true",
        "DiscountPickup"           : "true",
        "RequiresCoupon"           : "true",
        "DiscountAmount"           : 30.00,
        "DiscountPercent"          : null,
        "MinItemTotal"             : null,
        "MinItemCount"             : "3",
        "EffectiveDate"            : "2017-10-30T07:00:00Z",
        "ExpirationDate"           : "2018-10-30T07:00:00Z",
        "AutomaticDiscount"        : "true"
      },
      "RetailDiscount"            : 3.14,
      "TotalDiscount"             : 3.14,
      "PaymentMethod"             : "ExampleString",
      "PaymentToken"              : "ExampleString",
      "GroupingJSON"              : "ExampleString",
      "StyleJSON"                 : "ExampleString",
      "ShippingPostCode"          : "ExampleString",
      "PostCodeTaxRate"           : 3.14,
      "LineItemNotes"  : 
      [
        {
          "ID"                      : 1000001,
          "OrderId"                 : 1,
          "ProposalId"              : 1,
          "ArtId"                   : 1,
          "DesignId"                : 1,
          "CustomLineItemId"        : 1,
          "ProductStyleId"          : 1,
          "PersonalizationValues"   : "ExampleString",
          "Content"                 : "ExampleString",
          "DateCreated"             : "2017-10-30T07:00:00Z",
          "DateModified"            : "2017-10-30T07:00:00Z",
          "UniqueId"                : "",
          "ItemGuid"                : ""
        }
      ]
    }
  ],
  "Stores"  : 
  [
    {
      "StoreId"                      : 1,
      "StoreLogoUrl"                 : "ExampleString",
      "Name"                         : "ExampleString",
      "StoreUri"                     : "ExampleString",
      "TermsOfUse"                   : "ExampleString",
      "StoreStatus"                  : "ExampleString",
      "ShippingIntegrationEnabled"   : "true",
      "CheckoutFields"  : 
      [{"Name" : "example not found 2"}
      ]
    }
  ],
  "Shipments"  : 
  [
    {
      "ID"             : 1,
      "OrderId"        : 1,
      "PackageCount"   : 1,
      "DateCreated"    : "2017-10-30T07:00:00Z",
      "LastModified"   : "2017-10-30T07:00:00Z",
      "Notes"          : "ExampleString",
      "PickedUpBy"     : "ExampleString",
      "Pickup"         : "true",
      "ToAddress"  : 
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      },
      "FromAddress"  : 
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      },
      "Packages"  : 
      [
        {
          "ID"                      : 1,
          "ShippedDate"             : "2017-10-30T07:00:00Z",
          "TrackingNumber"          : "ExampleString",
          "TrackingUrl"             : "ExampleString",
          "ShippingServiceType"     : "ExampleString",
          "Status"                  : "ExampleString",
          "CarrierName"             : "ExampleString",
          "ShippingLabelFileName"   : "ExampleString",
          "LabelCost"               : 3.14,
          "Items"  : 
          [
            {
              "Guid"       : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
              "ItemGuid"   : "",
              "Quantity"   : 1
            }
          ]
        }
      ]
    }
  ],
  "Publisher"  : 
  {
    "ContactEmail"    : "ExampleString",
    "ContactNumber"   : "ExampleString",
    "TermsOfUse"      : "ExampleString"
  },
  "CheckoutNotes"     : "ExampleString",
  "Products"  : 
  [
    {
      "BaseStyles"  : 
      [
        {
          "CanPrint"                      : "true",
          "CanDigitalPrint"               : "true",
          "CanScreenPrint"                : "true",
          "CanEmbroider"                  : "true",
          "IsDefault"                     : "true",
          "ID"                            : 1000001,
          "HtmlColor1"                    : "ExampleString",
          "HtmlColor2"                    : "ExampleString",
          "Name"                          : "Red",
          "Active"                        : "true",
          "IsLightColor"                  : "true",
          "IsDarkColor"                   : "true",
          "IsHeathered"                   : "true",
          "ImageFilePath_Front"           : "ExampleString",
          "Sides"  : 
          [
            {
              "Side"            : "ExampleString",
              "ImageFilePath"   : "ExampleString",
              "Width"           : 1,
              "Height"          : 1,
              "Colorway"  : 
              {
                "ID"             : 1,
                "Colors"  : 
                [
                  {
                    "Index"                : 1,
                    "Color"                : "ExampleString",
                    "EmbroideryThreadId"   : 1,
                    "InkColorId"           : 1,
                    "ColorName"            : "ExampleString",
                    "PMS"                  : "ExampleString"
                  }
                ],
                "Name"           : "ExampleString",
                "SvgUrl"         : "ExampleString",
                "RenderedUrl"    : "ExampleString",
                "ThumbnailUrl"   : "ExampleString"
              }
            }
          ],
          "ColorwayImageFilePath_Front"   : "ExampleString",
          "Sizes"  : 
          [
            {
              "ID"                        : 1000001,
              "Active"                    : "true",
              "IsDeleted"                 : "true",
              "Name"                      : "L",
              "ManufacturerSku"           : "B174BE097",
              "LongName"                  : "Large",
              "UnitPrice"                 : 15.00,
              "Price"                     : 3.14,
              "OverridePrice"             : 3.14,
              "SalePrice"                 : 12.99,
              "SaleStart"                 : "2017-10-30T07:00:00Z",
              "SaleEnd"                   : "2017-10-30T07:00:00Z",
              "IsDefault"                 : "true",
              "InStock"                   : "true",
              "SupplierInventory"         : 1,
              "LocalInventory"            : 1,
              "SupplierCost"              : 3.14,
              "UpCharge"                  : 0.00,
              "Weight"                    : 3.14,
              "SortOrder"                 : 1,
              "Detail"  : 
              {
                "GTIN"   : "ExampleString"
              },
              "QuantityPackPricing"  : 
              [
                {
                  "Quantity"   : 1,
                  "Price"      : 3.14,
                  "Cost"       : 3.14
                }
              ],
              "ProductStyleSizeToStore"  : 
              [
                {
                  "ProductId"                   : 1,
                  "ProductStyleId"              : 1,
                  "ProductStyleSizeId"          : 1,
                  "ProductStyleSizeToStoreId"   : 1,
                  "PriceOverride"               : 3.14,
                  "StoreId"                     : 1
                }
              ]
            }
          ],
          "AvailableQuantityPacks"        : [1,2,3],
          "QuantityPackPricing"  : 
          [
            {
              "Quantity"   : 1,
              "Price"      : 3.14,
              "Cost"       : 3.14
            }
          ],
          "Price"                         : 3.14
        }
      ],
      "Keywords"                            : [ExampleString,ExampleString,ExampleString],
      "DecoratedProductSides"  : 
      [
        {
          "ProductFilename"   : "ExampleString",
          "ProductWidth"      : 1,
          "ProductHeight"     : 1,
          "Side"              : "ExampleString",
          "Images"  : 
          [
            {
              "ImageFilename"   : "ExampleString",
              "Region"  : 
              {
                "X"          : 3.14,
                "Y"          : 3.14,
                "Width"      : 3.14,
                "Height"     : 3.14,
                "Rotation"   : 3.14
              },
              "RegionString"    : "ExampleString"
            }
          ]
        }
      ],
      "Categories"  : 
      [
        {
          "ID"     : 1,
          "Name"   : "ExampleString",
          "Path"   : "ExampleString"
        }
      ],
      "Sides"  : 
      [
        {
          "Name"                 : "ExampleString",
          "DisplayName"          : "ExampleString",
          "Active"               : "true",
          "Regions"  : 
          [
            {
              "ID"                          : 1000001,
              "Name"                        : "Full",
              "X"                           : 10,
              "Y"                           : 10,
              "Width"                       : 100,
              "Height"                      : 200,
              "Rotation"                    : null,
              "Shape"                       : null,
              "Side"                        : "front",
              "IsDefault"                   : "true",
              "ProductRegionRenderSizeId"   : 1,
              "RenderWidthInches"           : null,
              "RenderHeightInches"          : null
            }
          ],
          "OverlayArtImageUrl"   : "ExampleString"
        }
      ],
      "StoreIds"                            : [1,2,3],
      "Personalizations"  : 
      [
        {
          "ID"            : 10000,
          "ProductId"     : 10000,
          "Name"          : "First Name",
          "Description"   : "Your first name",
          "Required"      : "true",
          "Active"        : "true",
          "Price"         : null,
          "Options"  : 
          [
            {
              "ID"      : 100000,
              "Value"   : "Highland High School"
            }
          ],
          "Format"        : "NumbersOnly",
          "MinLength"     : 1,
          "MaxLength"     : 1
        }
      ],
      "ID"                                  : 1000000,
      "SourceProductId"                     : 1000001,
      "Active"                              : "true",
      "Manufacturer"                        : "Gildan",
      "ManufacturerSku"                     : "2200",
      "ManufacturerId"                      : 1000000,
      "SupplierId"                          : Sanmar,
      "Supplier"                            : "Sanmar",
      "MaxColors"                           : "true",
      "CanPrint"                            : "true",
      "CanDigitalPrint"                     : "true",
      "CanScreenPrint"                      : "true",
      "CanEmbroider"                        : "true",
      "Sku"                                 : "2200_41157_1000000",
      "Name"                                : "Ultra Cotton Tank Top",
      "IsStatic"                            : "true",
      "BuyBlank"                            : "true",
      "DesignOnline"                        : "true",
      "DesignDetailsForm"                   : "true",
      "StaticDesignId"                      : 1,
      "Created"                             : "2017-10-30T07:00:00Z",
      "PersonalizationType"                 : "ExampleString",
      "HasProductArt"                       : "true",
      "EnforceProductInventoriesLocal"      : "true",
      "EnforceProductInventoriesSupplier"   : "true",
      "UnitCost"                            : 3.14,
      "UnitPrice"                           : 3.14,
      "SalePrice"                           : 3.14,
      "PriceRuleMarkup"  : 
      {
        "Schedules"  : 
        [
          {
            "ID"              : 1000000,
            "MinimumPrice"    : 0.01,
            "MaximumPrice"    : 5.00,
            "MarkupPercent"   : 100.00,
            "MarkupAmount"    : null
          }
        ],
        "ID"                         : 1000000,
        "Name"                       : "Markup",
        "MarkupFromCost"             : "true",
        "MarkupFromQuantity"         : "true",
        "MarkupAmountFromCost"       : "true",
        "MarkupAmountFromQuantity"   : "true"
      },
      "PriceRuleDiscount"  : 
      {
        "ID"             : 1000000,
        "Name"           : "Save10",
        "EntireCart"     : "true",
        "EachCartItem"   : "false",
        "Schedules"  : 
        [
          {
            "ID"                : 1000004,
            "MinimumQuantity"   : 3,
            "MaximumQuantity"   : 1000,
            "DiscountPercent"   : null,
            "DiscountAmount"    : 10.00
          }
        ]
      },
      "StyleCount"                          : 1,
      "TaxExempt"                           : "true",
      "SizeUnit"                            : "ExampleString",
      "SizeChartUrl"                        : "ExampleString",
      "ProductType"  : {"Name" : "example not found 2"},
      "LongDescription"                     : "This is a great looking shirt that will make you look great when you wear it",
      "ManufacturerBrandImageUrl"           : "ExampleString",
      "DefaultSide"                         : "ExampleString",
      "HasOrders"                           : "true"
    }
  ],
  "Manufacturers"  : 
  [
    {
      "ID"              : 1000001,
      "Name"            : "Gildan",
      "HasBrandImage"   : "true",
      "HasSizeChart"    : "true",
      "SizeChartUrl"    : "ExampleString",
      "BrandImageUrl"   : "ExampleString",
      "ProductCount"    : 1,
      "SizeCharts"      : [A,A,A]
    }
  ],
  "Art"  : 
  [
    {
      "ID"                    : 1,
      "ColorCount"            : 1,
      "Colors"                : ["#FF0000","#FFFFFF","#0000FF"],
      "OriginalColorway"  : 
      {
        "ID"             : 1,
        "Colors"  : 
        [
          {
            "Index"                : 1,
            "Color"                : "ExampleString",
            "EmbroideryThreadId"   : 1,
            "InkColorId"           : 1,
            "ColorName"            : "ExampleString",
            "PMS"                  : "ExampleString"
          }
        ],
        "Name"           : "ExampleString",
        "SvgUrl"         : "ExampleString",
        "RenderedUrl"    : "ExampleString",
        "ThumbnailUrl"   : "ExampleString"
      },
      "StitchCount"           : 1,
      "TrimCount"             : 1,
      "GalleryId"             : 1,
      "CategoryIds"           : [1,2,3],
      "Name"                  : "Business_Designs",
      "Type"                  : "ExampleString",
      "Keywords"              : "pretty,big,black and white,zebra",
      "FixedSvg"              : "true",
      "Digitized"             : "true",
      "CanScreenPrint"        : "true",
      "FullName"              : "store5976/Business/Business_Designs",
      "ExternalReferenceID"   : "ExampleString",
      "Width"                 : 762,
      "Height"                : 538,
      "Notes"                 : "ExampleString",
      "FileExt"               : "png",
      "ImageUrl"              : "ExampleString",
      "ThumbUrl"              : "ExampleString",
      "ThumbUrlAlt"           : "ExampleString",
      "OriginalUrl"           : "ExampleString",
      "UploadedUrl"           : "ExampleString",
      "UploadedOn"            : "2017-10-30T07:00:00Z",
      "IsActive"              : "true",
      "Colorways"  : 
      [
        {
          "ID"             : 1,
          "Colors"  : 
          [
            {
              "Index"                : 1,
              "Color"                : "ExampleString",
              "EmbroideryThreadId"   : 1,
              "InkColorId"           : 1,
              "ColorName"            : "ExampleString",
              "PMS"                  : "ExampleString"
            }
          ],
          "Name"           : "ExampleString",
          "SvgUrl"         : "ExampleString",
          "RenderedUrl"    : "ExampleString",
          "ThumbnailUrl"   : "ExampleString"
        }
      ],
      "UniqueId"              : "",
      "MatchFileColor"        : "true"
    }
  ],
  "DesignSummaries"  : 
  [
    {
      "DesignID"                   : 1,
      "UserID"                     : 1,
      "UserEmail"                  : "ExampleString",
      "Uri"                        : "ExampleString",
      "DesignedOnSku"              : "ExampleString",
      "DesignedOnStyleName"        : "ExampleString",
      "DesignedOnProductId"        : 1,
      "DesignedOnProductStyleId"   : 1,
      "Canvases"  : 
      [{"Name" : "example not found 2"}
      ],
      "LastModified"               : "2017-10-30T07:00:00Z",
      "Name"                       : "ExampleString",
      "Notes"                      : "ExampleString"
    }
  ],
  "Contacts"  : 
  [
    {
      "Phones"  : 
      [
        {
          "ID"            : 1000000,
          "Number"        : "888-222-3333",
          "Extension"     : "1234",
          "PhoneType"     : "Mobile",
          "IsSMSOptOut"   : "false"
        }
      ],
      "Tags"  : 
      [
        {
          "ID"      : 1000000,
          "Name"    : "Walter",
          "Count"   : 12
        }
      ],
      "Addresses"  : 
      [
        {
          "ID"                     : 1000014,
          "StateId"                : 4,
          "CountryId"              : 1,
          "Business"               : "true",
          "TaxExempt"              : "true",
          "FirstName"              : "John",
          "LastName"               : "Doe",
          "Name"                   : "John Doe",
          "CompanyName"            : "Doe Co",
          "Street1"                : "1234 Test St",
          "Street2"                : "Suite 500",
          "City"                   : "Albuquerque",
          "State"                  : "NM",
          "StateName"              : "New Mexico",
          "Country"                : "United States",
          "CountryCode"            : "US",
          "Email"                  : "ExampleString",
          "Phone"                  : "480-309-6332",
          "Fax"                    : "480-309-6333",
          "PostCode"               : "87111",
          "POBox"                  : "true",
          "SaveToAddressBook"      : "true",
          "Type"                   : null,
          "TaxId"                  : null,
          "Department"             : "IT, Sales, Marketing",
          "ShowPickupAtCheckout"   : "true",
          "Validated"              : "true or false",
          "IsPrimaryAddress"       : "true",
          "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
        }
      ],
      "ID"                      : 1000000,
      "FirstName"               : "Walter",
      "LastName"                : "White",
      "JobTitle"                : "Owner",
      "Email"                   : "email@walterwhite.com",
      "ProfilePicture"          : "email@walterwhite.com",
      "Newsletter"              : "true",
      "Store"  : 
      {
        "ID"                    : 1000000,
        "Uri"                   : "ExampleString",
        "Name"                  : "Walter",
        "Logo"                  : "logo.png",
        "AcceptPurchaseOrder"   : "true or false",
        "AllowPaymentLater"     : "true or false"
      },
      "Origin"  : 
      {
        "ID"      : 1000000,
        "Name"    : "Walter",
        "Image"   : "Walter",
        "Count"   : Walter
      },
      "Company"  : 
      {
        "ID"                     : 1000000,
        "Name"                   : "Inksoft",
        "PrimaryContact"  : 
        {
          "Fax"                     : "111-222-3333",
          "Note"                    : "Some details about the Contact",
          "SalesDocs"  : 
          [{"Name" : "example not found 2"}
          ],
          "PurchaseOrdersEnabled"   : "true",
          "PayLaterEnabled"         : "true",
          "Timeline"  : 
          [
            {
              "EventDescription"    : ,
              "ID"                  : 1,
              "ContactIds"          : [1,2,3],
              "CompanyIds"          : [1,2,3],
              "JobIds"              : [1,2,3],
              "OrderIds"            : [1,2,3],
              "ProposalIds"         : [1,2,3],
              "ProductionCardIds"   : [1,2,3],
              "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
              "Event"               : "ExampleString",
              "Comment"             : "ExampleString",
              "EventType"  : {"Name" : "example not found 2"},
              "Edited"              : "true",
              "EditedDate"          : "2017-10-30T07:00:00Z",
              "Deleted"             : "true",
              "DeletedDate"         : "2017-10-30T07:00:00Z",
              "Created"             : "2017-10-30T07:00:00Z",
              "CreatedByUserId"     : 1,
              "CreatedByName"       : "ExampleString",
              "Details"  : 
              [
                {
                  "Property"   : "ExampleString",
                  "OldValue"   : "ExampleString",
                  "NewValue"   : "ExampleString",
                  "Date"       : "2017-10-30T07:00:00Z"
                }
              ],
              "Associations"  : {"Name" : "example not found 2"}
            }
          ],
          "TierId"                  : 1,
          "Tiers"  : 
          [
            {
              "ID"         : 1000000,
              "Name"       : "Reseller",
              "UniqueId"   : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
              "Active"     : "true"
            }
          ],
          "IsTaxable"               : "true",
          "ID"                      : 1,
          "FirstName"               : "ExampleString",
          "LastName"                : "ExampleString",
          "JobTitle"                : "ExampleString",
          "Email"                   : "ExampleString",
          "Phones"  : 
          [
            {
              "ID"            : 1000000,
              "Number"        : "888-222-3333",
              "Extension"     : "1234",
              "PhoneType"     : "Mobile",
              "IsSMSOptOut"   : "false"
            }
          ],
          "ProfilePicture"          : "ExampleString",
          "Newsletter"              : "true",
          "Tags"  : 
          [
            {
              "ID"      : 1000000,
              "Name"    : "Walter",
              "Count"   : 12
            }
          ],
          "Store"  : 
          {
            "ID"                    : 1000000,
            "Uri"                   : "ExampleString",
            "Name"                  : "Walter",
            "Logo"                  : "logo.png",
            "AcceptPurchaseOrder"   : "true or false",
            "AllowPaymentLater"     : "true or false"
          },
          "Origin"  : 
          {
            "ID"      : 1000000,
            "Name"    : "Walter",
            "Image"   : "Walter",
            "Count"   : Walter
          },
          "Company"  : null,
          "PrimaryAddressId"        : 1,
          "Addresses"  : 
          [
            {
              "ID"                     : 1000014,
              "StateId"                : 4,
              "CountryId"              : 1,
              "Business"               : "true",
              "TaxExempt"              : "true",
              "FirstName"              : "John",
              "LastName"               : "Doe",
              "Name"                   : "John Doe",
              "CompanyName"            : "Doe Co",
              "Street1"                : "1234 Test St",
              "Street2"                : "Suite 500",
              "City"                   : "Albuquerque",
              "State"                  : "NM",
              "StateName"              : "New Mexico",
              "Country"                : "United States",
              "CountryCode"            : "US",
              "Email"                  : "ExampleString",
              "Phone"                  : "480-309-6332",
              "Fax"                    : "480-309-6333",
              "PostCode"               : "87111",
              "POBox"                  : "true",
              "SaveToAddressBook"      : "true",
              "Type"                   : null,
              "TaxId"                  : null,
              "Department"             : "IT, Sales, Marketing",
              "ShowPickupAtCheckout"   : "true",
              "Validated"              : "true or false",
              "IsPrimaryAddress"       : "true",
              "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
            }
          ],
          "Discount"                : 3.14,
          "BirthDate"               : "2017-10-30T07:00:00Z",
          "DateCreated"             : "2017-10-30T07:00:00Z",
          "LastModified"            : "2017-10-30T07:00:00Z",
          "ExternalReferenceId"     : "ExampleString",
          "StoreAnalyticsEnabled"   : "true"
        },
        "PrimaryContactId"       : 1,
        "PrimaryAddress"  : 
        {
          "ID"                     : 1000014,
          "StateId"                : 4,
          "CountryId"              : 1,
          "Business"               : "true",
          "TaxExempt"              : "true",
          "FirstName"              : "John",
          "LastName"               : "Doe",
          "Name"                   : "John Doe",
          "CompanyName"            : "Doe Co",
          "Street1"                : "1234 Test St",
          "Street2"                : "Suite 500",
          "City"                   : "Albuquerque",
          "State"                  : "NM",
          "StateName"              : "New Mexico",
          "Country"                : "United States",
          "CountryCode"            : "US",
          "Email"                  : "ExampleString",
          "Phone"                  : "480-309-6332",
          "Fax"                    : "480-309-6333",
          "PostCode"               : "87111",
          "POBox"                  : "true",
          "SaveToAddressBook"      : "true",
          "Type"                   : null,
          "TaxId"                  : null,
          "Department"             : "IT, Sales, Marketing",
          "ShowPickupAtCheckout"   : "true",
          "Validated"              : "true or false",
          "IsPrimaryAddress"       : "true",
          "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
        },
        "PrimaryAddressId"       : 1,
        "Addresses"  : 
        [
          {
            "ID"                     : 1000014,
            "StateId"                : 4,
            "CountryId"              : 1,
            "Business"               : "true",
            "TaxExempt"              : "true",
            "FirstName"              : "John",
            "LastName"               : "Doe",
            "Name"                   : "John Doe",
            "CompanyName"            : "Doe Co",
            "Street1"                : "1234 Test St",
            "Street2"                : "Suite 500",
            "City"                   : "Albuquerque",
            "State"                  : "NM",
            "StateName"              : "New Mexico",
            "Country"                : "United States",
            "CountryCode"            : "US",
            "Email"                  : "ExampleString",
            "Phone"                  : "480-309-6332",
            "Fax"                    : "480-309-6333",
            "PostCode"               : "87111",
            "POBox"                  : "true",
            "SaveToAddressBook"      : "true",
            "Type"                   : null,
            "TaxId"                  : null,
            "Department"             : "IT, Sales, Marketing",
            "ShowPickupAtCheckout"   : "true",
            "Validated"              : "true or false",
            "IsPrimaryAddress"       : "true",
            "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
          }
        ],
        "WebsiteUrl"             : "http://www.inksoft.com",
        "Fax"                    : "111-222-3333",
        "USFederalTaxId"         : "22-3333333",
        "USStateTaxId"           : "22-3333333",
        "CanadaBusinessNumber"   : "22-3333333",
        "IsUSTaxExempt"          : "true or false",
        "USTaxExemptionType"     : "NGO",
        "Discount"               : 22-3333333,
        "Note"                   : "Something about the company",
        "Phones"  : 
        [
          {
            "ID"            : 1000000,
            "Number"        : "888-222-3333",
            "Extension"     : "1234",
            "PhoneType"     : "Mobile",
            "IsSMSOptOut"   : "false"
          }
        ],
        "Tags"  : 
        [
          {
            "ID"      : 1000000,
            "Name"    : "Walter",
            "Count"   : 12
          }
        ],
        "Contacts"  : 
        [
          {
            "Fax"                     : "111-222-3333",
            "Note"                    : "Some details about the Contact",
            "SalesDocs"  : 
            [{"Name" : "example not found 2"}
            ],
            "PurchaseOrdersEnabled"   : "true",
            "PayLaterEnabled"         : "true",
            "Timeline"  : 
            [
              {
                "EventDescription"    : ,
                "ID"                  : 1,
                "ContactIds"          : [1,2,3],
                "CompanyIds"          : [1,2,3],
                "JobIds"              : [1,2,3],
                "OrderIds"            : [1,2,3],
                "ProposalIds"         : [1,2,3],
                "ProductionCardIds"   : [1,2,3],
                "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
                "Event"               : "ExampleString",
                "Comment"             : "ExampleString",
                "EventType"  : {"Name" : "example not found 2"},
                "Edited"              : "true",
                "EditedDate"          : "2017-10-30T07:00:00Z",
                "Deleted"             : "true",
                "DeletedDate"         : "2017-10-30T07:00:00Z",
                "Created"             : "2017-10-30T07:00:00Z",
                "CreatedByUserId"     : 1,
                "CreatedByName"       : "ExampleString",
                "Details"  : 
                [
                  {
                    "Property"   : "ExampleString",
                    "OldValue"   : "ExampleString",
                    "NewValue"   : "ExampleString",
                    "Date"       : "2017-10-30T07:00:00Z"
                  }
                ],
                "Associations"  : {"Name" : "example not found 2"}
              }
            ],
            "TierId"                  : 1,
            "Tiers"  : 
            [
              {
                "ID"         : 1000000,
                "Name"       : "Reseller",
                "UniqueId"   : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
                "Active"     : "true"
              }
            ],
            "IsTaxable"               : "true",
            "ID"                      : 1,
            "FirstName"               : "ExampleString",
            "LastName"                : "ExampleString",
            "JobTitle"                : "ExampleString",
            "Email"                   : "ExampleString",
            "Phones"  : 
            [
              {
                "ID"            : 1000000,
                "Number"        : "888-222-3333",
                "Extension"     : "1234",
                "PhoneType"     : "Mobile",
                "IsSMSOptOut"   : "false"
              }
            ],
            "ProfilePicture"          : "ExampleString",
            "Newsletter"              : "true",
            "Tags"  : 
            [
              {
                "ID"      : 1000000,
                "Name"    : "Walter",
                "Count"   : 12
              }
            ],
            "Store"  : 
            {
              "ID"                    : 1000000,
              "Uri"                   : "ExampleString",
              "Name"                  : "Walter",
              "Logo"                  : "logo.png",
              "AcceptPurchaseOrder"   : "true or false",
              "AllowPaymentLater"     : "true or false"
            },
            "Origin"  : 
            {
              "ID"      : 1000000,
              "Name"    : "Walter",
              "Image"   : "Walter",
              "Count"   : Walter
            },
            "Company"  : null,
            "PrimaryAddressId"        : 1,
            "Addresses"  : 
            [
              {
                "ID"                     : 1000014,
                "StateId"                : 4,
                "CountryId"              : 1,
                "Business"               : "true",
                "TaxExempt"              : "true",
                "FirstName"              : "John",
                "LastName"               : "Doe",
                "Name"                   : "John Doe",
                "CompanyName"            : "Doe Co",
                "Street1"                : "1234 Test St",
                "Street2"                : "Suite 500",
                "City"                   : "Albuquerque",
                "State"                  : "NM",
                "StateName"              : "New Mexico",
                "Country"                : "United States",
                "CountryCode"            : "US",
                "Email"                  : "ExampleString",
                "Phone"                  : "480-309-6332",
                "Fax"                    : "480-309-6333",
                "PostCode"               : "87111",
                "POBox"                  : "true",
                "SaveToAddressBook"      : "true",
                "Type"                   : null,
                "TaxId"                  : null,
                "Department"             : "IT, Sales, Marketing",
                "ShowPickupAtCheckout"   : "true",
                "Validated"              : "true or false",
                "IsPrimaryAddress"       : "true",
                "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
              }
            ],
            "Discount"                : 3.14,
            "BirthDate"               : "2017-10-30T07:00:00Z",
            "DateCreated"             : "2017-10-30T07:00:00Z",
            "LastModified"            : "2017-10-30T07:00:00Z",
            "ExternalReferenceId"     : "ExampleString",
            "StoreAnalyticsEnabled"   : "true"
          }
        ],
        "Timeline"  : 
        [
          {
            "EventDescription"    : ,
            "ID"                  : 1,
            "ContactIds"          : [1,2,3],
            "CompanyIds"          : [1,2,3],
            "JobIds"              : [1,2,3],
            "OrderIds"            : [1,2,3],
            "ProposalIds"         : [1,2,3],
            "ProductionCardIds"   : [1,2,3],
            "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
            "Event"               : "ExampleString",
            "Comment"             : "ExampleString",
            "EventType"  : {"Name" : "example not found 2"},
            "Edited"              : "true",
            "EditedDate"          : "2017-10-30T07:00:00Z",
            "Deleted"             : "true",
            "DeletedDate"         : "2017-10-30T07:00:00Z",
            "Created"             : "2017-10-30T07:00:00Z",
            "CreatedByUserId"     : 1,
            "CreatedByName"       : "ExampleString",
            "Details"  : 
            [
              {
                "Property"   : "ExampleString",
                "OldValue"   : "ExampleString",
                "NewValue"   : "ExampleString",
                "Date"       : "2017-10-30T07:00:00Z"
              }
            ],
            "Associations"  : {"Name" : "example not found 2"}
          }
        ]
      },
      "PrimaryAddressId"        : 1,
      "Discount"                : VIP Discount for the Contact,
      "BirthDate"               : "2017-10-30T07:00:00Z",
      "DateCreated"             : "2017-01-01",
      "LastModified"            : "2017-01-01",
      "ExternalReferenceId"     : "H32504E04F8911D39AAC0305E82C4201",
      "StoreAnalyticsEnabled"   : "true"
    }
  ],
  "SimpleDesigns"  : 
  [
    {
      "ID"                 : 1,
      "DesignArtRegions"  : 
      [
        {
          "RegionName"         : "ExampleString",
          "SideId"             : "ExampleString",
          "ColorCount"         : 1,
          "ArtId"              : 1,
          "DistressId"         : 1,
          "ArtRegion"  : 
          {
            "ID"                          : 1000001,
            "Name"                        : "Full",
            "X"                           : 10,
            "Y"                           : 10,
            "Width"                       : 100,
            "Height"                      : 200,
            "Rotation"                    : null,
            "Shape"                       : null,
            "Side"                        : "front",
            "IsDefault"                   : "true",
            "ProductRegionRenderSizeId"   : 1,
            "RenderWidthInches"           : null,
            "RenderHeightInches"          : null
          },
          "DecorationMethod"  : {"Name" : "example not found 2"},
          "MatchFileColor"     : "true"
        }
      ],
      "Name"               : "ExampleString",
      "Notes"              : "ExampleString",
      "ProductStyleId"     : 1
    }
  ]
}

 

OrderPayment

Represents a payment applied toward an order

Properties

  • ID type: integer

    The unique integer ID of this order payment

  • OrderId type: (nullable) integer

    The ID of the order to which this payment was applied

  • ProposalId type: (nullable) integer

    The ID of the proposal to which this payment was applied

  • EventType type: string

    A description of the type of payment event (CAPTURE, PURCHASEORDER)

  • CardLast4 type: string

    The last four digits of the card used, if a card was used

  • CardType type: string

    The type of credit card used, if applicable

  • ResponseCode type: string

    The response code returned from the payment gateway, if any

  • TransactionId type: string

    The transaction ID returned from the payment gateway, if any

  • OriginalTransactionId type: string

    The original transaction ID, if this was a follow-up transaction

  • ApprovalCode type: string

    The approval code returned from the payment gateway, if any

  • AvsCode type: string

    The AVS code returned from the payment gateway, if any

  • DateCreated type: DateTime

    The date this transaction was processed

  • DateVoided type: (nullable) DateTime

    The date this transaction was voided

  • TestMode type: boolean

    True if this payment was placed in test mode

  • GatewayAccount type: string

    The gateway account number, if applicable

  • GiftCertificateId type: (nullable) integer

    The ID of the gift certificate used, if applicable

  • Amount type: (nullable) decimal

    The amount processed, if applicable

  • ProcessingFee type: (nullable) decimal

    The processing fee charged, if applicable

  • InkSoftFee type: (nullable) decimal

    The fee charged by InkSoft, if applicable

  • GatewayName type: string

    The name of the payment gateway, if applicable

  • AttachmentFileName type: string

    The name of the attachment uploaded, if applicable

  • Notes type: string

    Notes added to document the order payment

  • BillingAddress type: Address 


{
  "ID"                      : 1000001,
  "OrderId"                 : 1,
  "ProposalId"              : 1,
  "EventType"               : "ExampleString",
  "CardLast4"               : "ExampleString",
  "CardType"                : "ExampleString",
  "ResponseCode"            : "ExampleString",
  "TransactionId"           : "ExampleString",
  "OriginalTransactionId"   : "ExampleString",
  "ApprovalCode"            : "ExampleString",
  "AvsCode"                 : "ExampleString",
  "DateCreated"             : "2017-10-30T07:00:00Z",
  "DateVoided"              : "2017-10-30T07:00:00Z",
  "TestMode"                : "true",
  "GatewayAccount"          : "ExampleString",
  "GiftCertificateId"       : 1,
  "Amount"                  : 3.14,
  "ProcessingFee"           : 3.14,
  "InkSoftFee"              : 3.14,
  "GatewayName"             : "ExampleString",
  "AttachmentFileName"      : "ExampleString",
  "Notes"                   : "ExampleString",
  "BillingAddress"  : 
  {
    "ID"                     : 1000014,
    "StateId"                : 4,
    "CountryId"              : 1,
    "Business"               : "true",
    "TaxExempt"              : "true",
    "FirstName"              : "John",
    "LastName"               : "Doe",
    "Name"                   : "John Doe",
    "CompanyName"            : "Doe Co",
    "Street1"                : "1234 Test St",
    "Street2"                : "Suite 500",
    "City"                   : "Albuquerque",
    "State"                  : "NM",
    "StateName"              : "New Mexico",
    "Country"                : "United States",
    "CountryCode"            : "US",
    "Email"                  : "ExampleString",
    "Phone"                  : "480-309-6332",
    "Fax"                    : "480-309-6333",
    "PostCode"               : "87111",
    "POBox"                  : "true",
    "SaveToAddressBook"      : "true",
    "Type"                   : null,
    "TaxId"                  : null,
    "Department"             : "IT, Sales, Marketing",
    "ShowPickupAtCheckout"   : "true",
    "Validated"              : "true or false",
    "IsPrimaryAddress"       : "true",
    "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
  }
}

 

OrderPublisher

A subset of orders' publisher information

Properties

  • ContactEmail type: string

    The Publisher contact email

  • ContactNumber type: string

    The Publisher contact phone number

  • TermsOfUse type: string

    Text for terms of use 


{
  "ContactEmail"    : "ExampleString",
  "ContactNumber"   : "ExampleString",
  "TermsOfUse"      : "ExampleString"
}

 

OrderShipment

An order shipment or pickup

Properties

  • ID type: integer

    The unique integer ID of this shipment

  • OrderId type: integer

    The ID of the order to which this shipment is associated

  • PackageCount type: integer

    The number of packages involved in this shipment. For pickup (full or partial) this will always be: 1

  • DateCreated type: DateTime

    The date and time this order shipment was created

  • LastModified type: DateTime

    The date and time this order shipment was last modified

  • Notes type: string

    Notes about this shipment. Currently used only for pickup

  • PickedUpBy type: string

    The name of the person who picked up the order

  • Pickup type: boolean

    True if this order shipment reqpresents a pickup rather than a shipment

  • ToAddress type: Address

    Shipment address if there was any

  • FromAddress type: Address

    Shipment From Address

  • Packages type: List of OrderShipmentPackage 


{
  "ID"             : 1,
  "OrderId"        : 1,
  "PackageCount"   : 1,
  "DateCreated"    : "2017-10-30T07:00:00Z",
  "LastModified"   : "2017-10-30T07:00:00Z",
  "Notes"          : "ExampleString",
  "PickedUpBy"     : "ExampleString",
  "Pickup"         : "true",
  "ToAddress"  : 
  {
    "ID"                     : 1000014,
    "StateId"                : 4,
    "CountryId"              : 1,
    "Business"               : "true",
    "TaxExempt"              : "true",
    "FirstName"              : "John",
    "LastName"               : "Doe",
    "Name"                   : "John Doe",
    "CompanyName"            : "Doe Co",
    "Street1"                : "1234 Test St",
    "Street2"                : "Suite 500",
    "City"                   : "Albuquerque",
    "State"                  : "NM",
    "StateName"              : "New Mexico",
    "Country"                : "United States",
    "CountryCode"            : "US",
    "Email"                  : "ExampleString",
    "Phone"                  : "480-309-6332",
    "Fax"                    : "480-309-6333",
    "PostCode"               : "87111",
    "POBox"                  : "true",
    "SaveToAddressBook"      : "true",
    "Type"                   : null,
    "TaxId"                  : null,
    "Department"             : "IT, Sales, Marketing",
    "ShowPickupAtCheckout"   : "true",
    "Validated"              : "true or false",
    "IsPrimaryAddress"       : "true",
    "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
  },
  "FromAddress"  : 
  {
    "ID"                     : 1000014,
    "StateId"                : 4,
    "CountryId"              : 1,
    "Business"               : "true",
    "TaxExempt"              : "true",
    "FirstName"              : "John",
    "LastName"               : "Doe",
    "Name"                   : "John Doe",
    "CompanyName"            : "Doe Co",
    "Street1"                : "1234 Test St",
    "Street2"                : "Suite 500",
    "City"                   : "Albuquerque",
    "State"                  : "NM",
    "StateName"              : "New Mexico",
    "Country"                : "United States",
    "CountryCode"            : "US",
    "Email"                  : "ExampleString",
    "Phone"                  : "480-309-6332",
    "Fax"                    : "480-309-6333",
    "PostCode"               : "87111",
    "POBox"                  : "true",
    "SaveToAddressBook"      : "true",
    "Type"                   : null,
    "TaxId"                  : null,
    "Department"             : "IT, Sales, Marketing",
    "ShowPickupAtCheckout"   : "true",
    "Validated"              : "true or false",
    "IsPrimaryAddress"       : "true",
    "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
  },
  "Packages"  : 
  [
    {
      "ID"                      : 1,
      "ShippedDate"             : "2017-10-30T07:00:00Z",
      "TrackingNumber"          : "ExampleString",
      "TrackingUrl"             : "ExampleString",
      "ShippingServiceType"     : "ExampleString",
      "Status"                  : "ExampleString",
      "CarrierName"             : "ExampleString",
      "ShippingLabelFileName"   : "ExampleString",
      "LabelCost"               : 3.14,
      "Items"  : 
      [
        {
          "Guid"       : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
          "ItemGuid"   : "",
          "Quantity"   : 1
        }
      ]
    }
  ]
}

 

OrderShipmentPackage

Represents a package of a shipment for an order

Properties

  • ID type: integer

    The ID of this package

  • ShippedDate type: (nullable) DateTime

    The date this package was shipped

  • TrackingNumber type: string

    The tracking number for this package

  • TrackingUrl type: string

    The tracking URL for this package

  • ShippingServiceType type: string

    The type of shipping service used to ship this package

  • Status type: string

    Status of the shipment.

  • CarrierName type: string

    Try to find the Vendor based on the tracking number

  • ShippingLabelFileName type: string

    Link to Download the Shipping Label

  • LabelCost type: (nullable) decimal

    Label Cost

  • Items type: List of OrderShipmentPackageItem

    A list of items contained within this package 


{
  "ID"                      : 1,
  "ShippedDate"             : "2017-10-30T07:00:00Z",
  "TrackingNumber"          : "ExampleString",
  "TrackingUrl"             : "ExampleString",
  "ShippingServiceType"     : "ExampleString",
  "Status"                  : "ExampleString",
  "CarrierName"             : "ExampleString",
  "ShippingLabelFileName"   : "ExampleString",
  "LabelCost"               : 3.14,
  "Items"  : 
  [
    {
      "Guid"       : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
      "ItemGuid"   : "",
      "Quantity"   : 1
    }
  ]
}

 

OrderShipmentPackageItem

Represents an item of a shipment package for an order

Properties

  • Guid type: guid

    The unique guid of this package

  • ItemGuid type: (nullable) guid

    The order retail item guid for this item

  • Quantity type: integer

    The quantity of the specified order retail item size ID 


{
  "Guid"       : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
  "ItemGuid"   : "",
  "Quantity"   : 1
}

 

OrderStore

A subset of orders' store information

Properties

  • StoreId type: integer

    The primary key of the store

  • StoreLogoUrl type: string

    Logo URL, if there is one.

  • Name type: string

    Store Name

  • StoreUri type: string

    The URI of the store

  • TermsOfUse type: string

    Text for terms of use

  • StoreStatus type: string

    State of the Store

  • ShippingIntegrationEnabled type: boolean

    Returns if the Shipping integration is enabled or not

  • CheckoutFields type: List of Field

    A list of custom checkout fields that apply to this store 


{
  "StoreId"                      : 1,
  "StoreLogoUrl"                 : "ExampleString",
  "Name"                         : "ExampleString",
  "StoreUri"                     : "ExampleString",
  "TermsOfUse"                   : "ExampleString",
  "StoreStatus"                  : "ExampleString",
  "ShippingIntegrationEnabled"   : "true",
  "CheckoutFields"  : 
  [{"Name" : "example not found 2"}
  ]
}

 

OrderSummary

Properties

  • ID type: integer

    The unique integer ID of this order

  • Guid type: (nullable) guid

    The salesdoc guid for this order

  • UserId type: (nullable) integer

    The ID of the contact associated with this order

  • Customer type: string

    The name of the Customer who placed this order. It will be either the full name or email

  • FirstName type: string

    The first name of the customer who placed this order

  • LastName type: string

    The last name of the customer who placed this order

  • CompanyName type: string

    The name of the company associated with the person who placed this order

  • DateCreated type: DateTime

    The date this order was created

  • IpAddress type: string

    The IP address of the customer who placed this order

  • PaymentMethod type: string

    The name of the payment method used to complete this order

  • PaymentStatus type: OrderPaymentStatus

    The payment status of the order (Paid, NotPaid, PartiallyPaid, RefundDue, Refunded)

  • TotalDiscount type: decimal

    The total discount applied to this order, including coupons and discount codes as well as quantity discounts.

  • TotalAmount type: decimal

    The total amount of this order, including shipping and taxes

  • TotalQuantity type: integer

    The total item quantity for this order

  • TotalTax type: decimal

    The total amount of tax for this order

  • AmountDue type: decimal

    The amount due after discounts and gift certificates have been subtracted

  • ProposalId type: (nullable) integer

    The ID of the proposal from which this order was created

  • ProposalReferenceId type: string

    The reference id of the proposal from which this order was created

  • ProposalGuid type: (nullable) guid

    The salesdoc guid of the proposal from which this order was created

  • OrderType type: string

    The source of this ordersummary: WebOrder, Invoice or Proposal

  • ProcessAmount type: decimal

    The payment amount processed for this order

  • PaymentDueDate type: (nullable) DateTime

    The date this order payment is due (when available)

  • EstimatedShipDate type: (nullable) DateTime

    The date this order is expected to ship

  • ConfirmedShipDate type: (nullable) DateTime

    The actual date this order shipped

  • EstimatedDeliveryDate_Min type: (nullable) DateTime

    The earliest date this order is expected to arrive

  • EstimatedDeliveryDate_Max type: (nullable) DateTime

    The earliest date this order is expected to arrive

  • ReadyForPickupNotificationSentDate type: (nullable) DateTime

    The date the customer was notified that the order is ready to be picked up

  • Status type: OrderStatus

    The status of the order (Canceled, Processing, Fulfilled, Shipped)

  • Email type: string

    The email address associated with this order

  • Authorized type: boolean

    True if payment has been authorized

  • Paid type: boolean

    True if full payment for amount due has been received

  • Confirmed type: boolean

    True if payment has been confirmed

  • Ordered type: boolean

    True if this order has ben placed

  • Received type: boolean

    True if this order has been received by the customer

  • Prepared type: boolean

    True if this order has been prepared for shipment

  • Shipped type: boolean

    True if this order has been shipped

  • Cancelled type: boolean

    True if this order has been cancelled

  • StoreName type: string

    The name of the store on which this order was placed

  • StoreId type: integer

    The ID of the store on which this order was placed

  • ProductionStatus type: OrderProductionStatus

    The production status of the order

  • ShippingMethodId type: (nullable) integer

    The ID of the shipping method associated with this order

  • ShippingMethodName type: string

    The name of the shipping method associated with this order

  • ShippingVendorId type: (nullable) integer

    The ID of the shipping vendor associated with this order

  • ShippingVendorName type: string

    The name of the shipping vendor associated with this order

  • VendorType type: string

    The name of the shipping vendor type associated with this order

  • ExportedToQuickBooks type: boolean

    True if order information has been exported to QuickBooks.

  • DateExportedToQuickBooks type: (nullable) DateTime

    Set only when the order info has been exported to QuickBooks.

  • ProductionCardCount type: integer

    The number of production cards associated to this order

  • JobCount type: integer

    The number of jobs associated to the production cards in this order

  • ProductionCards type: List of ProductionCard

    ProductionCards associated with the Order 


{
  "ID"                                   : 1000001,
  "Guid"                                 : "",
  "UserId"                               : 1,
  "Customer"                             : "ExampleString",
  "FirstName"                            : "ExampleString",
  "LastName"                             : "ExampleString",
  "CompanyName"                          : "ExampleString",
  "DateCreated"                          : "2017-10-30T07:00:00Z",
  "IpAddress"                            : "23.231.20.11",
  "PaymentMethod"                        : "CREDITCARD",
  "PaymentStatus"  : {"Name" : "example not found 2"},
  "TotalDiscount"                        : 3146.14,
  "TotalAmount"                          : 3177.92,
  "TotalQuantity"                        : 1,
  "TotalTax"                             : 3.14,
  "AmountDue"                            : 31.78,
  "ProposalId"                           : 1,
  "ProposalReferenceId"                  : "ExampleString",
  "ProposalGuid"                         : "",
  "OrderType"                            : "WebOrder",
  "ProcessAmount"                        : 31.78,
  "PaymentDueDate"                       : "2013-01-18T00:00:00Z",
  "EstimatedShipDate"                    : "2013-01-18T00:00:00Z",
  "ConfirmedShipDate"                    : "2013-01-18T00:00:00Z",
  "EstimatedDeliveryDate_Min"            : "2013-01-20T00:00:00Z",
  "EstimatedDeliveryDate_Max"            : "2013-01-20T00:00:00Z",
  "ReadyForPickupNotificationSentDate"   : "2017-10-30T07:00:00Z",
  "Status"  : {"Name" : "example not found 2"},
  "Email"                                : "ExampleString",
  "Authorized"                           : "true",
  "Paid"                                 : "true",
  "Confirmed"                            : "true",
  "Ordered"                              : "true",
  "Received"                             : "true",
  "Prepared"                             : "true",
  "Shipped"                              : "true",
  "Cancelled"                            : "true",
  "StoreName"                            : "Awesome T-shirts",
  "StoreId"                              : 10000000,
  "ProductionStatus"  : {"Name" : "example not found 2"},
  "ShippingMethodId"                     : 10000000,
  "ShippingMethodName"                   : "ExampleString",
  "ShippingVendorId"                     : 10000000,
  "ShippingVendorName"                   : "ExampleString",
  "VendorType"                           : "ExampleString",
  "ExportedToQuickBooks"                 : "true",
  "DateExportedToQuickBooks"             : "2017-10-30T07:00:00Z",
  "ProductionCardCount"                  : 1,
  "JobCount"                             : 1,
  "ProductionCards"  : 
  [
    {
      "ID"                        : 1000001,
      "JobId"                     : 1,
      "JobName"                   : "ExampleString",
      "JobStatusName"             : "ExampleString",
      "JobStatusId"               : 1,
      "JobNumber"                 : "ExampleString",
      "OrderId"                   : 1,
      "PrintavoOrderId"           : "ExampleString",
      "PrintavoOrderLink"         : "ExampleString",
      "SalesDocGuid"              : "",
      "DecorationGuid"            : "",
      "OrderFirstName"            : "ExampleString",
      "OrderLastName"             : "ExampleString",
      "OrderEmail"                : "ExampleString",
      "OrderStoreName"            : "ExampleString",
      "OrderDate"                 : "2017-10-30T07:00:00Z",
      "OrderRetailItemId"         : 1,
      "OrderPaymentStatus"        : "",
      "Number"                    : "ExampleString",
      "DesignGroupKey"            : "ExampleString",
      "ShipDate"                  : "2017-10-30T07:00:00Z",
      "OrderIsPickup"             : "true",
      "ProductId"                 : 1,
      "ProductName"               : "ExampleString",
      "ProductSku"                : "ExampleString",
      "ProductManufacturer"       : "ExampleString",
      "ProductSupplier"           : "ExampleString",
      "ProductStyleName"          : "ExampleString",
      "ProductStyleId"            : 1,
      "DesignName"                : "ExampleString",
      "DesignType"                : "",
      "Art"  : 
      {
        "ID"                    : 1,
        "ColorCount"            : 1,
        "Colors"                : ["#FF0000","#FFFFFF","#0000FF"],
        "OriginalColorway"  : 
        {
          "ID"             : 1,
          "Colors"  : 
          [
            {
              "Index"                : 1,
              "Color"                : "ExampleString",
              "EmbroideryThreadId"   : 1,
              "InkColorId"           : 1,
              "ColorName"            : "ExampleString",
              "PMS"                  : "ExampleString"
            }
          ],
          "Name"           : "ExampleString",
          "SvgUrl"         : "ExampleString",
          "RenderedUrl"    : "ExampleString",
          "ThumbnailUrl"   : "ExampleString"
        },
        "StitchCount"           : 1,
        "TrimCount"             : 1,
        "GalleryId"             : 1,
        "CategoryIds"           : [1,2,3],
        "Name"                  : "Business_Designs",
        "Type"                  : "ExampleString",
        "Keywords"              : "pretty,big,black and white,zebra",
        "FixedSvg"              : "true",
        "Digitized"             : "true",
        "CanScreenPrint"        : "true",
        "FullName"              : "store5976/Business/Business_Designs",
        "ExternalReferenceID"   : "ExampleString",
        "Width"                 : 762,
        "Height"                : 538,
        "Notes"                 : "ExampleString",
        "FileExt"               : "png",
        "ImageUrl"              : "ExampleString",
        "ThumbUrl"              : "ExampleString",
        "ThumbUrlAlt"           : "ExampleString",
        "OriginalUrl"           : "ExampleString",
        "UploadedUrl"           : "ExampleString",
        "UploadedOn"            : "2017-10-30T07:00:00Z",
        "IsActive"              : "true",
        "Colorways"  : 
        [
          {
            "ID"             : 1,
            "Colors"  : 
            [
              {
                "Index"                : 1,
                "Color"                : "ExampleString",
                "EmbroideryThreadId"   : 1,
                "InkColorId"           : 1,
                "ColorName"            : "ExampleString",
                "PMS"                  : "ExampleString"
              }
            ],
            "Name"           : "ExampleString",
            "SvgUrl"         : "ExampleString",
            "RenderedUrl"    : "ExampleString",
            "ThumbnailUrl"   : "ExampleString"
          }
        ],
        "UniqueId"              : "",
        "MatchFileColor"        : "true"
      },
      "ArtId"                     : 1,
      "DesignId"                  : 1,
      "ColorwayId"                : 1,
      "CanvasId"                  : 1,
      "Side"                      : "ExampleString",
      "SideInternalName"          : "ExampleString",
      "RegionName"                : "ExampleString",
      "Region"  : 
      {
        "ID"                          : 1000001,
        "Name"                        : "Full",
        "X"                           : 10,
        "Y"                           : 10,
        "Width"                       : 100,
        "Height"                      : 200,
        "Rotation"                    : null,
        "Shape"                       : null,
        "Side"                        : "front",
        "IsDefault"                   : "true",
        "ProductRegionRenderSizeId"   : 1,
        "RenderWidthInches"           : null,
        "RenderHeightInches"          : null
      },
      "ProductType"  : {"Name" : "example not found 2"},
      "SizeUnit"                  : "ExampleString",
      "ProductUrl"                : "ExampleString",
      "PreviewUrl"                : "ExampleString",
      "DesignUrl"                 : "ExampleString",
      "ArtUrl"                    : "ExampleString",
      "PrintMethod"               : "ExampleString",
      "Quantity"                  : 1,
      "ColorCount"                : 1,
      "ProductionNotes"           : "ExampleString",
      "OrderNotes"                : "ExampleString",
      "OrderItemNotes"            : "ExampleString",
      "DateCompleted"             : "2017-10-30T07:00:00Z",
      "Timeline"  : 
      [
        {
          "EventDescription"    : ,
          "ID"                  : 1,
          "ContactIds"          : [1,2,3],
          "CompanyIds"          : [1,2,3],
          "JobIds"              : [1,2,3],
          "OrderIds"            : [1,2,3],
          "ProposalIds"         : [1,2,3],
          "ProductionCardIds"   : [1,2,3],
          "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
          "Event"               : "ExampleString",
          "Comment"             : "ExampleString",
          "EventType"  : {"Name" : "example not found 2"},
          "Edited"              : "true",
          "EditedDate"          : "2017-10-30T07:00:00Z",
          "Deleted"             : "true",
          "DeletedDate"         : "2017-10-30T07:00:00Z",
          "Created"             : "2017-10-30T07:00:00Z",
          "CreatedByUserId"     : 1,
          "CreatedByName"       : "ExampleString",
          "Details"  : 
          [
            {
              "Property"   : "ExampleString",
              "OldValue"   : "ExampleString",
              "NewValue"   : "ExampleString",
              "Date"       : "2017-10-30T07:00:00Z"
            }
          ],
          "Associations"  : {"Name" : "example not found 2"}
        }
      ],
      "Attachments"  : 
      [
        {
          "ID"                 : 1000001,
          "Type"  : {"Name" : "example not found 2"},
          "ProductionCardId"   : 1,
          "OriginalName"       : "ExampleString",
          "Name"               : "ExampleString",
          "Description"        : "ExampleString",
          "MimeType"           : "ExampleString",
          "Url"                : "ExampleString",
          "UrlThumbnail"       : "ExampleString",
          "UrlPreview"         : "ExampleString"
        }
      ],
      "Colors"  : 
      [
        {
          "ID"                  : 1000001,
          "ProductionCardId"    : 1,
          "Index"               : 1,
          "Name"                : "ExampleString",
          "PMS"                 : "ExampleString",
          "HtmlColor"           : "ExampleString",
          "ThreadLibraryName"   : "ExampleString",
          "ThreadChartName"     : "ExampleString",
          "ThreadColorName"     : "ExampleString",
          "ThreadColorCode"     : "ExampleString"
        }
      ],
      "Items"  : 
      [
        {
          "ID"                      : 1000001,
          "ProductionCardId"        : 1,
          "SalesDocItemGuid"        : "",
          "Size"                    : "ExampleString",
          "Quantity"                : 1,
          "Status"                  : "ExampleString",
          "PurchasingStatus"        : "ExampleString",
          "IsComplete"              : "true",
          "PersonalizationValues"  : 
          [
            {
              "Name"                       : "ExampleString",
              "Value"                      : "ExampleString",
              "Price"                      : 3.14,
              "ProductPersonalizationId"   : 1
            }
          ],
          "NameNumberValue"  : 
          {
            "RetailItemSizeId"   : 1000000,
            "Name"               : "Bob",
            "Number"             : "32",
            "Quantity"           : 1,
            "Price"              : 32
          },
          "SortOrder"               : 1
        }
      ],
      "ColorwayName"              : "ExampleString",
      "ProductHtmlColor"          : "ExampleString",
      "ProductShape"              : "ExampleString",
      "EstimatedProductionDays"   : 1
    }
  ]
}

 

OrderTotalAdjustment

Properties

  • ID type: integer

    The unique integer ID of this OrderTotalAdjustment

  • Type type: (nullable) OrderTotalAdjustmentType

    Discount, Fee, Refund

  • Description type: string

    User entered adjustment description

  • Percentage type: (nullable) decimal

    Percentage of adjustment

  • Amount type: decimal

    Amount of adjustment

  • CreatedByName type: string

    Name of admin who entered the adjustment

  • Created type: DateTime

    Date adjustment created

  • ModifiedByName type: string

    Name of admin who modified the adjustment, if any

  • LastModified type: DateTime

    Date adjustment was modified, set to creation date if no modification 


{
  "ID"               : 1,
  "Type"             : "",
  "Description"      : "ExampleString",
  "Percentage"       : 3.14,
  "Amount"           : 3.14,
  "CreatedByName"    : "ExampleString",
  "Created"          : "2017-10-30T07:00:00Z",
  "ModifiedByName"   : "ExampleString",
  "LastModified"     : "2017-10-30T07:00:00Z"
}

 

Origin

Properties

  • ID type: integer

    A unique integer ID for the Origin

  • Name type: string

    The Origin Value

  • Image type: string

    The Image URL for the Origin

  • Count type: (nullable) integer

    Count for Tag 


{
  "ID"      : 1000000,
  "Name"    : "Walter",
  "Image"   : "Walter",
  "Count"   : Walter
}

 

PaymentGateway

Properties

  • STRIPE type: string

  • PAYRIX type: string

  • CREDIT_CARD_TYPE type: string

  • ID type: integer

  • Name type: string

  • PaymentType type: string

  • TestMode type: boolean

  • PublicKey type: string

  • MerchantId type: string

  • ServerEndpoint type: string

  • HostedPaymentForm type: boolean

  • Active type: boolean 


{
  "STRIPE"              : "ExampleString",
  "PAYRIX"              : "ExampleString",
  "CREDIT_CARD_TYPE"    : "ExampleString",
  "ID"                  : 1,
  "Name"                : "ExampleString",
  "PaymentType"         : "ExampleString",
  "TestMode"            : "true",
  "PublicKey"           : "ExampleString",
  "MerchantId"          : "ExampleString",
  "ServerEndpoint"      : "ExampleString",
  "HostedPaymentForm"   : "true",
  "Active"              : "true"
}

 

PersonalizationValue

Properties

  • Name type: string

  • Value type: string

  • Price type: (nullable) decimal

  • ProductPersonalizationId type: integer 


{
  "Name"                       : "ExampleString",
  "Value"                      : "ExampleString",
  "Price"                      : 3.14,
  "ProductPersonalizationId"   : 1
}

 

Phone

ProductBase contains a small number of lightweight properties used to quickly search and display contacts. Inherited by [Object:User] for full Contact properties

Properties

  • ID type: integer

    A unique integer ID for this Phone

  • Number type: string

    A Phone Number

  • Extension type: string

    Phone Extension

  • PhoneType type: string

    The type of Phone Numbe (Mobile, Work, Home)

  • IsSMSOptOut type: boolean

    Is Text Messages Enabled for this Phone 


{
  "ID"            : 1000000,
  "Number"        : "888-222-3333",
  "Extension"     : "1234",
  "PhoneType"     : "Mobile",
  "IsSMSOptOut"   : "false"
}

 

PriceRuleDiscount

A PriceRuleDiscount is a QuantityDiscount on the UI. PriceRuleDiscounts are product-based, as opposed to style-based like [Object:PriceRuleMarkup]s. An admin can configure as many PriceRuleDiscounts as they like, but only one rule can be applied to each line item. If multiple rules apply to the cart, we apply the one with the greatest discount. If multiple rules apply to a line item, we apply the one with the greatest discount. If a rule is applied to the cart, all line-item rules are ignored

Properties

  • ID type: integer

    A unique integer ID for this PriceRuleDiscount

  • Name type: string

    The name of this PriceRuleDiscount

  • EntireCart type: boolean

    True if this PriceRuleDiscount applies to the entire cart. PriceRuleDiscounts that apply to the entire cart take precedence over PriceRuleDiscounts that apply to line items. Mutually exclusive with EachCartItem

  • EachCartItem type: boolean

    True if this PriceRuleDiscount applies to each cart item. Mutually exclusive with EntireCart

  • Schedules type: List of PriceRuleDiscountSchedule

    A list of PriceRuleDiscountSchedules associated with this PriceRuleDiscount 


{
  "ID"             : 1000000,
  "Name"           : "Save10",
  "EntireCart"     : "true",
  "EachCartItem"   : "false",
  "Schedules"  : 
  [
    {
      "ID"                : 1000004,
      "MinimumQuantity"   : 3,
      "MaximumQuantity"   : 1000,
      "DiscountPercent"   : null,
      "DiscountAmount"    : 10.00
    }
  ]
}

 

PriceRuleDiscountSchedule

A schedule for [Object:PriceRuleDiscount]

Properties

  • ID type: integer

    A unique integer ID for this schedule

  • MinimumQuantity type: integer

    The minimum quantity required for this schedule to apply

  • MaximumQuantity type: integer

    The maximum quantity for which this schedule will apply

  • DiscountPercent type: (nullable) decimal

    The percent to be discounted. If not null, DiscountAmount must be null

  • DiscountAmount type: (nullable) decimal

    The amount to be discounted. If not null, DiscountPercent must be null 


{
  "ID"                : 1000004,
  "MinimumQuantity"   : 3,
  "MaximumQuantity"   : 1000,
  "DiscountPercent"   : null,
  "DiscountAmount"    : 10.00
}

 

PriceRuleMarkup

A PriceRuleMarkup is a Pricing Rule on the UI. PriceRuleMarkups are style-based, as opposed to product-based like [Object:PriceRuleDiscount]s. Only one MarkupFromXXX / MarginFromXXX / MarkupAmountFromXXX can be true

Properties

  • Schedules type: List of PriceRuleMarkupSchedule

    A list of PriceRuleMarkupSchedules associated with this PriceRuleMarkup

  • ID type: integer

    A unique integer ID for this PriceRuleMarkup

  • Name type: string

    The name of this PriceRuleMarkup

  • MarkupFromCost type: boolean

    True if this is a percent-based markup based on cost (percent markup on product cost)

  • MarkupFromQuantity type: boolean

    True if this is a percent-based markup based on quantity (percent markup on product quantity)

  • MarkupAmountFromCost type: boolean

    True if this is a dollar-based markup based on cost (dollar markup on product quantity)

  • MarkupAmountFromQuantity type: boolean

    True if this is a dollar-based markup based on quantity (dollar markup on product quantity) 


{
  "Schedules"  : 
  [
    {
      "ID"              : 1000000,
      "MinimumPrice"    : 0.01,
      "MaximumPrice"    : 5.00,
      "MarkupPercent"   : 100.00,
      "MarkupAmount"    : null
    }
  ],
  "ID"                         : 1000000,
  "Name"                       : "Markup",
  "MarkupFromCost"             : "true",
  "MarkupFromQuantity"         : "true",
  "MarkupAmountFromCost"       : "true",
  "MarkupAmountFromQuantity"   : "true"
}

 

PriceRuleMarkupSchedule

A schedule for [Object:PriceRuleMarkup]

Properties

  • ID type: integer

    A unique integer ID for this schedule

  • MinimumPrice type: decimal

    The minimum price required for this rule to apply

  • MaximumPrice type: decimal

    The maximum price for which this rule will apply

  • MarkupPercent type: decimal

    The percentage markup to apply. Must be zero if MarkupAmount is set

  • MarkupAmount type: (nullable) decimal

    The markup amount to apply. Must be null if MarkupPercent is set 


{
  "ID"              : 1000000,
  "MinimumPrice"    : 0.01,
  "MaximumPrice"    : 5.00,
  "MarkupPercent"   : 100.00,
  "MarkupAmount"    : null
}

 

PricedQuoteItem

Properties

  • StoreId type: integer

  • ProductId type: integer

  • ProductStyleId type: integer

  • ProductStyleSizeId type: integer

  • Quantity type: integer

  • ItemGuid type: guid

  • Sides type: List of PricedQuoteItemSide 


{
  "StoreId"              : 1,
  "ProductId"            : 1,
  "ProductStyleId"       : 1,
  "ProductStyleSizeId"   : 1,
  "Quantity"             : 1,
  "ItemGuid"             : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
  "Sides"  : 
  [
    {
      "SideId"                     : "ExampleString",
      "DecorationGuid"             : "",
      "NumColors"                  : 1,
      "IsFullColor"                : "true",
      "SetupPriceOverride"         : 3.14,
      "PrintPriceOverrideEach"     : 3.14,
      "ArtIdentifier"              : "ExampleString",
      "OverrideDecorationMethod"   : "ExampleString"
    }
  ]
}

 

PricedQuoteItemSide

Properties

  • SideId type: string

  • DecorationGuid type: (nullable) guid

  • NumColors type: (nullable) integer

  • IsFullColor type: boolean

  • SetupPriceOverride type: (nullable) decimal

  • PrintPriceOverrideEach type: (nullable) decimal

  • ArtIdentifier type: string

  • OverrideDecorationMethod type: string 


{
  "SideId"                     : "ExampleString",
  "DecorationGuid"             : "",
  "NumColors"                  : 1,
  "IsFullColor"                : "true",
  "SetupPriceOverride"         : 3.14,
  "PrintPriceOverrideEach"     : 3.14,
  "ArtIdentifier"              : "ExampleString",
  "OverrideDecorationMethod"   : "ExampleString"
}

 

PrintedProductPrice

Properties

  • ProductId type: integer

  • ProductStyleId type: integer

  • ProductStyleSizeId type: integer

  • Quantity type: integer

  • Identifier type: Object

  • EstimatedProductionDays type: (nullable) integer

  • EachPrintPrice type: (nullable) decimal

  • EachSetupPrice type: (nullable) decimal

  • EachProductPrice type: decimal

  • EachProductTotal type: (nullable) decimal

  • EachProductOriginalPrice type: (nullable) decimal

  • ProductAndPrintingTotal type: (nullable) decimal

  • ProductAndPrintingTotalOriginal type: (nullable) decimal

  • QuantityDiscountAmount type: (nullable) decimal

  • EntireCart type: boolean

  • EachCartItem type: boolean

  • SidePrices type: List of integer 


{
  "ProductId"                         : 1,
  "ProductStyleId"                    : 1,
  "ProductStyleSizeId"                : 1,
  "Quantity"                          : 1,
  "Identifier"  : {"Name" : "example not found 2"},
  "EstimatedProductionDays"           : 1,
  "EachPrintPrice"                    : 3.14,
  "EachSetupPrice"                    : 3.14,
  "EachProductPrice"                  : 3.14,
  "EachProductTotal"                  : 3.14,
  "EachProductOriginalPrice"          : 3.14,
  "ProductAndPrintingTotal"           : 3.14,
  "ProductAndPrintingTotalOriginal"   : 3.14,
  "QuantityDiscountAmount"            : 3.14,
  "EntireCart"                        : "true",
  "EachCartItem"                      : "true",
  "SidePrices"                        : [1,2,3]
}

 

Product

A product, containing [Object:ProductStyle]s. Inherits from [Object:ProductBase]

Properties

  • DefaultStyleId type: integer

    The ID of the defaults ProductStyle to be used on the storefront

  • HasFront type: boolean

    True if this product has a front

  • HasBack type: boolean

    True if this product has a back

  • HasThirdSide type: boolean

    True if this product has a third side

  • HasFourthSide type: boolean

    True if this product has a fourth side

  • ThirdSideName type: string

    The name of the third side, if any

  • FourthSideName type: string

    The name of the fourth side, if any

  • Featured type: boolean

    True if this product is marked as a featured product

  • TeamNameNumbersEnabled type: boolean

    True if this product supports names and numbers

  • AddToCartButtonText type: string

    Custom text to be displayed when adding this product to the cart

  • Availability type: string

    Custom text regarding a product's availability

  • MinimumItemQuantity type: (nullable) integer

    Represents the minimum number of this product (including all styles together) that can be ordered.

  • MinimumItemStyleQuantity type: (nullable) integer

    Represents the minimum number of each style of this product that can be ordered. This can have a different value at the ProductStyle level.

  • MinimumDesignQuantity type: (nullable) integer

    Represents the minimum number of this blank product that must be ordered with a design.

  • InventoryEnforcedAtSupplier type: boolean

    True if inventory is enforced at supplier

  • DesignDetailsFormButtonLabel type: string

    The label of the button for the design details form

  • StorePurchaseOptions type: List of ProductStorePurchaseOption

    The list of store-level overrides for purchase options

  • Styles type: List of ProductStyle

    A list of styles (most often colors) available for this product

  • BaseStyles type: List of ProductStyleBase

  • Attachments type: List of ProductAttachment

  • AttachmentTabName type: string

  • EstimatedProductionDays type: (nullable) integer

    An override for shipping method processing days.

  • Shape type: string

    The shape of the product, if this is a vector Signage product.

  • HarmonizedCode type: HarmonizedCode

  • TaxJarCategoryId type: string

    ID of the TaxJar product category that this product is assigned to

  • TaxJarCategoryName type: string

    Name of the TaxJar product category that this product is assigned to

  • ManufacturerSizeChartId type: (nullable) integer

  • ID type: integer

  • SourceProductId type: (nullable) integer

  • Active type: boolean

  • Manufacturer type: string

  • ManufacturerSku type: string

  • ManufacturerId type: integer

  • SupplierId type: integer

  • Supplier type: string

  • MaxColors type: (nullable) byte

  • CanPrint type: boolean

  • CanDigitalPrint type: boolean

  • CanScreenPrint type: boolean

  • CanEmbroider type: boolean

  • Sku type: string

  • Name type: string

  • Keywords type: List of string

  • IsStatic type: boolean

  • BuyBlank type: boolean

  • DesignOnline type: boolean

  • DesignDetailsForm type: boolean

  • StaticDesignId type: (nullable) integer

  • Created type: DateTime

  • PersonalizationType type: string

  • HasProductArt type: boolean

  • EnforceProductInventoriesLocal type: (nullable) boolean

  • EnforceProductInventoriesSupplier type: (nullable) boolean

  • DecoratedProductSides type: List of DecoratedProductSide

  • UnitCost type: (nullable) decimal

  • UnitPrice type: (nullable) decimal

  • SalePrice type: (nullable) decimal

  • PriceRuleMarkup type: PriceRuleMarkup

  • PriceRuleDiscount type: PriceRuleDiscount

  • StyleCount type: integer

  • TaxExempt type: boolean

  • Categories type: List of CategoryBase

  • Sides type: List of ProductSide

  • StoreIds type: List of integer

  • Personalizations type: List of ProductPersonalization

  • SizeUnit type: string

  • SizeChartUrl type: string

  • ProductType type: ProductType

  • LongDescription type: string

  • ManufacturerBrandImageUrl type: string

  • DefaultSide type: string

  • HasOrders type: (nullable) boolean 


{
  "DefaultStyleId"                      : 1000000,
  "HasFront"                            : "true",
  "HasBack"                             : "true",
  "HasThirdSide"                        : "true",
  "HasFourthSide"                       : "true",
  "ThirdSideName"                       : "Sleve Left",
  "FourthSideName"                      : "ExampleString",
  "Featured"                            : "true",
  "TeamNameNumbersEnabled"              : "true",
  "AddToCartButtonText"                 : "Make It Yours!",
  "Availability"                        : "Produced on demand, usually ships within 10 business days",
  "MinimumItemQuantity"                 : 1,
  "MinimumItemStyleQuantity"            : 1,
  "MinimumDesignQuantity"               : 1,
  "InventoryEnforcedAtSupplier"         : "true",
  "DesignDetailsFormButtonLabel"        : "ExampleString",
  "StorePurchaseOptions"  : 
  [
    {
      "ID"                             : 1,
      "ProductId"                      : 1,
      "StoreId"                        : 1,
      "BuyBlank"                       : "true",
      "DesignOnline"                   : "true",
      "DesignDetailsForm"              : "true",
      "DesignDetailsFormButtonLabel"   : "ExampleString"
    }
  ],
  "Styles"  : 
  [
    {
      "UnitPrice"                     : 3.14,
      "SupplierCost"                  : 3.14,
      "Price_Canvas"                  : 3.14,
      "Price_Name"                    : 3.14,
      "Price_Number"                  : 3.14,
      "ImageWidth_Front"              : 1,
      "ImageWidth_Back"               : 1,
      "ImageHeight_Front"             : 1,
      "ImageHeight_Back"              : 1,
      "ImageFilePath_Back"            : "ExampleString",
      "ImageFilePath_SleeveLeft"      : "ExampleString",
      "ImageFilePath_SleeveRight"     : "ExampleString",
      "Colorway_Front"  : 
      {
        "ID"             : 1,
        "Colors"  : 
        [
          {
            "Index"                : 1,
            "Color"                : "ExampleString",
            "EmbroideryThreadId"   : 1,
            "InkColorId"           : 1,
            "ColorName"            : "ExampleString",
            "PMS"                  : "ExampleString"
          }
        ],
        "Name"           : "ExampleString",
        "SvgUrl"         : "ExampleString",
        "RenderedUrl"    : "ExampleString",
        "ThumbnailUrl"   : "ExampleString"
      },
      "Colorway_Back"  : 
      {
        "ID"             : 1,
        "Colors"  : 
        [
          {
            "Index"                : 1,
            "Color"                : "ExampleString",
            "EmbroideryThreadId"   : 1,
            "InkColorId"           : 1,
            "ColorName"            : "ExampleString",
            "PMS"                  : "ExampleString"
          }
        ],
        "Name"           : "ExampleString",
        "SvgUrl"         : "ExampleString",
        "RenderedUrl"    : "ExampleString",
        "ThumbnailUrl"   : "ExampleString"
      },
      "Colorway_SleeveLeft"  : 
      {
        "ID"             : 1,
        "Colors"  : 
        [
          {
            "Index"                : 1,
            "Color"                : "ExampleString",
            "EmbroideryThreadId"   : 1,
            "InkColorId"           : 1,
            "ColorName"            : "ExampleString",
            "PMS"                  : "ExampleString"
          }
        ],
        "Name"           : "ExampleString",
        "SvgUrl"         : "ExampleString",
        "RenderedUrl"    : "ExampleString",
        "ThumbnailUrl"   : "ExampleString"
      },
      "Colorway_SleeveRight"  : 
      {
        "ID"             : 1,
        "Colors"  : 
        [
          {
            "Index"                : 1,
            "Color"                : "ExampleString",
            "EmbroideryThreadId"   : 1,
            "InkColorId"           : 1,
            "ColorName"            : "ExampleString",
            "PMS"                  : "ExampleString"
          }
        ],
        "Name"           : "ExampleString",
        "SvgUrl"         : "ExampleString",
        "RenderedUrl"    : "ExampleString",
        "ThumbnailUrl"   : "ExampleString"
      },
      "MinimumItemStyleQuantity"      : 1,
      "CanPrint"                      : "true",
      "CanDigitalPrint"               : "true",
      "CanScreenPrint"                : "true",
      "CanEmbroider"                  : "true",
      "IsDefault"                     : "true",
      "ID"                            : 1,
      "HtmlColor1"                    : "ExampleString",
      "HtmlColor2"                    : "ExampleString",
      "Name"                          : "ExampleString",
      "Active"                        : "true",
      "IsLightColor"                  : "true",
      "IsDarkColor"                   : "true",
      "IsHeathered"                   : "true",
      "ImageFilePath_Front"           : "ExampleString",
      "Sides"  : 
      [
        {
          "Side"            : "ExampleString",
          "ImageFilePath"   : "ExampleString",
          "Width"           : 1,
          "Height"          : 1,
          "Colorway"  : 
          {
            "ID"             : 1,
            "Colors"  : 
            [
              {
                "Index"                : 1,
                "Color"                : "ExampleString",
                "EmbroideryThreadId"   : 1,
                "InkColorId"           : 1,
                "ColorName"            : "ExampleString",
                "PMS"                  : "ExampleString"
              }
            ],
            "Name"           : "ExampleString",
            "SvgUrl"         : "ExampleString",
            "RenderedUrl"    : "ExampleString",
            "ThumbnailUrl"   : "ExampleString"
          }
        }
      ],
      "ColorwayImageFilePath_Front"   : "ExampleString",
      "Sizes"  : 
      [
        {
          "ID"                        : 1000001,
          "Active"                    : "true",
          "IsDeleted"                 : "true",
          "Name"                      : "L",
          "ManufacturerSku"           : "B174BE097",
          "LongName"                  : "Large",
          "UnitPrice"                 : 15.00,
          "Price"                     : 3.14,
          "OverridePrice"             : 3.14,
          "SalePrice"                 : 12.99,
          "SaleStart"                 : "2017-10-30T07:00:00Z",
          "SaleEnd"                   : "2017-10-30T07:00:00Z",
          "IsDefault"                 : "true",
          "InStock"                   : "true",
          "SupplierInventory"         : 1,
          "LocalInventory"            : 1,
          "SupplierCost"              : 3.14,
          "UpCharge"                  : 0.00,
          "Weight"                    : 3.14,
          "SortOrder"                 : 1,
          "Detail"  : 
          {
            "GTIN"   : "ExampleString"
          },
          "QuantityPackPricing"  : 
          [
            {
              "Quantity"   : 1,
              "Price"      : 3.14,
              "Cost"       : 3.14
            }
          ],
          "ProductStyleSizeToStore"  : 
          [
            {
              "ProductId"                   : 1,
              "ProductStyleId"              : 1,
              "ProductStyleSizeId"          : 1,
              "ProductStyleSizeToStoreId"   : 1,
              "PriceOverride"               : 3.14,
              "StoreId"                     : 1
            }
          ]
        }
      ],
      "AvailableQuantityPacks"        : [1,2,3],
      "QuantityPackPricing"  : 
      [
        {
          "Quantity"   : 1,
          "Price"      : 3.14,
          "Cost"       : 3.14
        }
      ],
      "Price"                         : 3.14
    }
  ],
  "BaseStyles"  : 
  [
    {
      "CanPrint"                      : "true",
      "CanDigitalPrint"               : "true",
      "CanScreenPrint"                : "true",
      "CanEmbroider"                  : "true",
      "IsDefault"                     : "true",
      "ID"                            : 1000001,
      "HtmlColor1"                    : "ExampleString",
      "HtmlColor2"                    : "ExampleString",
      "Name"                          : "Red",
      "Active"                        : "true",
      "IsLightColor"                  : "true",
      "IsDarkColor"                   : "true",
      "IsHeathered"                   : "true",
      "ImageFilePath_Front"           : "ExampleString",
      "Sides"  : 
      [
        {
          "Side"            : "ExampleString",
          "ImageFilePath"   : "ExampleString",
          "Width"           : 1,
          "Height"          : 1,
          "Colorway"  : 
          {
            "ID"             : 1,
            "Colors"  : 
            [
              {
                "Index"                : 1,
                "Color"                : "ExampleString",
                "EmbroideryThreadId"   : 1,
                "InkColorId"           : 1,
                "ColorName"            : "ExampleString",
                "PMS"                  : "ExampleString"
              }
            ],
            "Name"           : "ExampleString",
            "SvgUrl"         : "ExampleString",
            "RenderedUrl"    : "ExampleString",
            "ThumbnailUrl"   : "ExampleString"
          }
        }
      ],
      "ColorwayImageFilePath_Front"   : "ExampleString",
      "Sizes"  : 
      [
        {
          "ID"                        : 1000001,
          "Active"                    : "true",
          "IsDeleted"                 : "true",
          "Name"                      : "L",
          "ManufacturerSku"           : "B174BE097",
          "LongName"                  : "Large",
          "UnitPrice"                 : 15.00,
          "Price"                     : 3.14,
          "OverridePrice"             : 3.14,
          "SalePrice"                 : 12.99,
          "SaleStart"                 : "2017-10-30T07:00:00Z",
          "SaleEnd"                   : "2017-10-30T07:00:00Z",
          "IsDefault"                 : "true",
          "InStock"                   : "true",
          "SupplierInventory"         : 1,
          "LocalInventory"            : 1,
          "SupplierCost"              : 3.14,
          "UpCharge"                  : 0.00,
          "Weight"                    : 3.14,
          "SortOrder"                 : 1,
          "Detail"  : 
          {
            "GTIN"   : "ExampleString"
          },
          "QuantityPackPricing"  : 
          [
            {
              "Quantity"   : 1,
              "Price"      : 3.14,
              "Cost"       : 3.14
            }
          ],
          "ProductStyleSizeToStore"  : 
          [
            {
              "ProductId"                   : 1,
              "ProductStyleId"              : 1,
              "ProductStyleSizeId"          : 1,
              "ProductStyleSizeToStoreId"   : 1,
              "PriceOverride"               : 3.14,
              "StoreId"                     : 1
            }
          ]
        }
      ],
      "AvailableQuantityPacks"        : [1,2,3],
      "QuantityPackPricing"  : 
      [
        {
          "Quantity"   : 1,
          "Price"      : 3.14,
          "Cost"       : 3.14
        }
      ],
      "Price"                         : 3.14
    }
  ],
  "Attachments"  : 
  [
    {
      "ID"     : 1,
      "Type"   : "ExampleString",
      "Url"    : "ExampleString"
    }
  ],
  "AttachmentTabName"                   : "ExampleString",
  "EstimatedProductionDays"             : 1,
  "Shape"                               : "ExampleString",
  "HarmonizedCode"  : 
  {
    "Code"             : "5103.10.93",
    "Description"      : "Garments",
    "OverrideLocale"  : 
    [
      {
        "TaxRateOverrideId"   : 1000000,
        "County"              : "Maricopa",
        "State"  : 
        {
          "ID"          : 4,
          "CountryId"   : 1,
          "Code"        : "AZ",
          "Name"        : "Arizona",
          "Tax"         : 0.056000
        },
        "Country"  : 
        {
          "ID"                  : 100001,
          "Code"                : "US",
          "Name"                : "United States",
          "PostCodeSupported"   : "true",
          "PostCodeRequired"    : "true"
        },
        "City"                : "Tempe",
        "PostCode"            : "85281",
        "TaxRate"             : 0.08,
        "ShippingTaxable"     : "true or false",
        "HarmonizedCode"      : "ExampleString"
      }
    ]
  },
  "TaxJarCategoryId"                    : "ExampleString",
  "TaxJarCategoryName"                  : "ExampleString",
  "ManufacturerSizeChartId"             : 1,
  "ID"                                  : 1,
  "SourceProductId"                     : 1,
  "Active"                              : "true",
  "Manufacturer"                        : "ExampleString",
  "ManufacturerSku"                     : "ExampleString",
  "ManufacturerId"                      : 1,
  "SupplierId"                          : 1,
  "Supplier"                            : "ExampleString",
  "MaxColors"                           : "1",
  "CanPrint"                            : "true",
  "CanDigitalPrint"                     : "true",
  "CanScreenPrint"                      : "true",
  "CanEmbroider"                        : "true",
  "Sku"                                 : "ExampleString",
  "Name"                                : "ExampleString",
  "Keywords"                            : [ExampleString,ExampleString,ExampleString],
  "IsStatic"                            : "true",
  "BuyBlank"                            : "true",
  "DesignOnline"                        : "true",
  "DesignDetailsForm"                   : "true",
  "StaticDesignId"                      : 1,
  "Created"                             : "2017-10-30T07:00:00Z",
  "PersonalizationType"                 : "ExampleString",
  "HasProductArt"                       : "true",
  "EnforceProductInventoriesLocal"      : "true",
  "EnforceProductInventoriesSupplier"   : "true",
  "DecoratedProductSides"  : 
  [
    {
      "ProductFilename"   : "ExampleString",
      "ProductWidth"      : 1,
      "ProductHeight"     : 1,
      "Side"              : "ExampleString",
      "Images"  : 
      [
        {
          "ImageFilename"   : "ExampleString",
          "Region"  : 
          {
            "X"          : 3.14,
            "Y"          : 3.14,
            "Width"      : 3.14,
            "Height"     : 3.14,
            "Rotation"   : 3.14
          },
          "RegionString"    : "ExampleString"
        }
      ]
    }
  ],
  "UnitCost"                            : 3.14,
  "UnitPrice"                           : 3.14,
  "SalePrice"                           : 3.14,
  "PriceRuleMarkup"  : 
  {
    "Schedules"  : 
    [
      {
        "ID"              : 1000000,
        "MinimumPrice"    : 0.01,
        "MaximumPrice"    : 5.00,
        "MarkupPercent"   : 100.00,
        "MarkupAmount"    : null
      }
    ],
    "ID"                         : 1000000,
    "Name"                       : "Markup",
    "MarkupFromCost"             : "true",
    "MarkupFromQuantity"         : "true",
    "MarkupAmountFromCost"       : "true",
    "MarkupAmountFromQuantity"   : "true"
  },
  "PriceRuleDiscount"  : 
  {
    "ID"             : 1000000,
    "Name"           : "Save10",
    "EntireCart"     : "true",
    "EachCartItem"   : "false",
    "Schedules"  : 
    [
      {
        "ID"                : 1000004,
        "MinimumQuantity"   : 3,
        "MaximumQuantity"   : 1000,
        "DiscountPercent"   : null,
        "DiscountAmount"    : 10.00
      }
    ]
  },
  "StyleCount"                          : 1,
  "TaxExempt"                           : "true",
  "Categories"  : 
  [
    {
      "ID"     : 1,
      "Name"   : "ExampleString",
      "Path"   : "ExampleString"
    }
  ],
  "Sides"  : 
  [
    {
      "Name"                 : "ExampleString",
      "DisplayName"          : "ExampleString",
      "Active"               : "true",
      "Regions"  : 
      [
        {
          "ID"                          : 1000001,
          "Name"                        : "Full",
          "X"                           : 10,
          "Y"                           : 10,
          "Width"                       : 100,
          "Height"                      : 200,
          "Rotation"                    : null,
          "Shape"                       : null,
          "Side"                        : "front",
          "IsDefault"                   : "true",
          "ProductRegionRenderSizeId"   : 1,
          "RenderWidthInches"           : null,
          "RenderHeightInches"          : null
        }
      ],
      "OverlayArtImageUrl"   : "ExampleString"
    }
  ],
  "StoreIds"                            : [1,2,3],
  "Personalizations"  : 
  [
    {
      "ID"            : 10000,
      "ProductId"     : 10000,
      "Name"          : "First Name",
      "Description"   : "Your first name",
      "Required"      : "true",
      "Active"        : "true",
      "Price"         : null,
      "Options"  : 
      [
        {
          "ID"      : 100000,
          "Value"   : "Highland High School"
        }
      ],
      "Format"        : "NumbersOnly",
      "MinLength"     : 1,
      "MaxLength"     : 1
    }
  ],
  "SizeUnit"                            : "ExampleString",
  "SizeChartUrl"                        : "ExampleString",
  "ProductType"  : {"Name" : "example not found 2"},
  "LongDescription"                     : "ExampleString",
  "ManufacturerBrandImageUrl"           : "ExampleString",
  "DefaultSide"                         : "ExampleString",
  "HasOrders"                           : "true"
}

 

ProductAttachment

Represents an attachment to a product.

Properties

  • ID type: integer

    The ID of this attachment

  • Type type: string

    The type of this attachment - currently always "sizechart"

  • Url type: string

    The relative URL to this attachment's originally uploaded file (an image file or a pdf). 


{
  "ID"     : 1,
  "Type"   : "ExampleString",
  "Url"    : "ExampleString"
}

 

ProductBase

ProductBase contains a small number of lightweight properties used to quickly search and display products. Inherited by [Object:Product] for full product properties

Properties

  • BaseStyles type: List of ProductStyleBase

    A list of BaseStyles that apply to this ProductBase

  • Keywords type: List of string

    A list of keywords associated with this product

  • DecoratedProductSides type: List of DecoratedProductSide

    An object describing where art should be placed on top of product images.

  • Categories type: List of CategoryBase

    List of categories to which the product belongs

  • Sides type: List of ProductSide

    A list of sides available for this product, each with the corresponding print region definitions.

  • StoreIds type: List of integer

    A list of store IDs that apply to this ProductBase

  • Personalizations type: List of ProductPersonalization

    A list of personalizations available for this product

  • ID type: integer

    A unique integer ID for this product

  • SourceProductId type: (nullable) integer

    The ID of the product from which this product was created

  • Active type: boolean

    True if this product is active

  • Manufacturer type: string

    The name of the manufacturer of this product

  • ManufacturerSku type: string

    The manufacturer SKU of this product

  • ManufacturerId type: integer

    The ID of the manufacturer of this product

  • SupplierId type: integer

    The ID of the supplier of this product

  • Supplier type: string

    The name of the supplier of this product

  • MaxColors type: (nullable) byte

    The maximum number of colors that this product can be printed with.

  • CanPrint type: boolean

    True if this product can be printed (if either CanDigitalPrint or CanScreenPrint are true)

  • CanDigitalPrint type: boolean

    True if this product can be digitally printed

  • CanScreenPrint type: boolean

    True if this product can be screen printed

  • CanEmbroider type: boolean

    True if this product can be embroidered

  • Sku type: string

    The unique Stock Keeping Unit (SKU) ID of this product

  • Name type: string

    The name of this product

  • IsStatic type: boolean

    True if this is a predecorated product

  • BuyBlank type: boolean

    True if blanks can be purchased

  • DesignOnline type: boolean

    True if this product can be designed in the online designer

  • DesignDetailsForm type: boolean

    True if this product can be purchased via the design details form

  • StaticDesignId type: (nullable) integer

    If this is a predecorated product created in the design studio, the ID of the design that it was created with.

  • Created type: DateTime

    The date/time this product was created

  • PersonalizationType type: string

    A string description of the personalization type that applies to this product (none, namesnumbers, custom)

  • HasProductArt type: boolean

    If true, at least one side of this product has art that is placed on top of the product image dynamically. These products are created via the Rapid Product Creator.

  • EnforceProductInventoriesLocal type: (nullable) boolean

    True if enforcing local product inventory for orders

  • EnforceProductInventoriesSupplier type: (nullable) boolean

    True if enforcing supplier inventories for orders

  • UnitCost type: (nullable) decimal

    The cost per unit of this product (the cost of the default style of this product)

  • UnitPrice type: (nullable) decimal

    The price per unit of this product (the price of the cheapest size of the default style of this product). May be overridden by SalePrice.

  • SalePrice type: (nullable) decimal

    The price per unit of this product (the sale price of the cheapest size of the default style of this product). If this has a value and is less than UnitPrice, the product is considered "On Sale" and this price is the correct one and the UnitPrice is the "Original" price.

  • PriceRuleMarkup type: PriceRuleMarkup

    Pricing Rule schedule (aka product price markup rule). will be null when this markup rule is present since a product cannot have both, and markups take precedent.

  • PriceRuleDiscount type: PriceRuleDiscount

    Quantity Discount schedule (aka product price discount rule). NOT the product pricing rule schedule, contrary to the term 'PriceRule' in the name, and is only present when there is no applicable Pricing Rule (). Probably named as such because Quantity Discounts decrease base product price while Price Rules markup base product price. When more than one quantity discount applies to a given product, this will contain probably the oldest active discount (with the lowest ID), so it can't be reliably used to find the biggest discount according to the Confluence spec.

  • StyleCount type: integer

    The number of styles for this product

  • TaxExempt type: boolean

    Mark if the Product is tax exempt or not.

  • SizeUnit type: string

    The unit that the product size is expressed in for Signage products

  • SizeChartUrl type: string

    The URL of the size chart of this product, if it has one.

  • ProductType type: ProductType

  • LongDescription type: string

    A long text description about this product

  • ManufacturerBrandImageUrl type: string

    Url of manufacturer brand image

  • DefaultSide type: string

    Default product side

  • HasOrders type: (nullable) boolean

    Returns true or false if the product has orders. If this field is null, the data was not requested 


{
  "BaseStyles"  : 
  [
    {
      "CanPrint"                      : "true",
      "CanDigitalPrint"               : "true",
      "CanScreenPrint"                : "true",
      "CanEmbroider"                  : "true",
      "IsDefault"                     : "true",
      "ID"                            : 1000001,
      "HtmlColor1"                    : "ExampleString",
      "HtmlColor2"                    : "ExampleString",
      "Name"                          : "Red",
      "Active"                        : "true",
      "IsLightColor"                  : "true",
      "IsDarkColor"                   : "true",
      "IsHeathered"                   : "true",
      "ImageFilePath_Front"           : "ExampleString",
      "Sides"  : 
      [
        {
          "Side"            : "ExampleString",
          "ImageFilePath"   : "ExampleString",
          "Width"           : 1,
          "Height"          : 1,
          "Colorway"  : 
          {
            "ID"             : 1,
            "Colors"  : 
            [
              {
                "Index"                : 1,
                "Color"                : "ExampleString",
                "EmbroideryThreadId"   : 1,
                "InkColorId"           : 1,
                "ColorName"            : "ExampleString",
                "PMS"                  : "ExampleString"
              }
            ],
            "Name"           : "ExampleString",
            "SvgUrl"         : "ExampleString",
            "RenderedUrl"    : "ExampleString",
            "ThumbnailUrl"   : "ExampleString"
          }
        }
      ],
      "ColorwayImageFilePath_Front"   : "ExampleString",
      "Sizes"  : 
      [
        {
          "ID"                        : 1000001,
          "Active"                    : "true",
          "IsDeleted"                 : "true",
          "Name"                      : "L",
          "ManufacturerSku"           : "B174BE097",
          "LongName"                  : "Large",
          "UnitPrice"                 : 15.00,
          "Price"                     : 3.14,
          "OverridePrice"             : 3.14,
          "SalePrice"                 : 12.99,
          "SaleStart"                 : "2017-10-30T07:00:00Z",
          "SaleEnd"                   : "2017-10-30T07:00:00Z",
          "IsDefault"                 : "true",
          "InStock"                   : "true",
          "SupplierInventory"         : 1,
          "LocalInventory"            : 1,
          "SupplierCost"              : 3.14,
          "UpCharge"                  : 0.00,
          "Weight"                    : 3.14,
          "SortOrder"                 : 1,
          "Detail"  : 
          {
            "GTIN"   : "ExampleString"
          },
          "QuantityPackPricing"  : 
          [
            {
              "Quantity"   : 1,
              "Price"      : 3.14,
              "Cost"       : 3.14
            }
          ],
          "ProductStyleSizeToStore"  : 
          [
            {
              "ProductId"                   : 1,
              "ProductStyleId"              : 1,
              "ProductStyleSizeId"          : 1,
              "ProductStyleSizeToStoreId"   : 1,
              "PriceOverride"               : 3.14,
              "StoreId"                     : 1
            }
          ]
        }
      ],
      "AvailableQuantityPacks"        : [1,2,3],
      "QuantityPackPricing"  : 
      [
        {
          "Quantity"   : 1,
          "Price"      : 3.14,
          "Cost"       : 3.14
        }
      ],
      "Price"                         : 3.14
    }
  ],
  "Keywords"                            : [ExampleString,ExampleString,ExampleString],
  "DecoratedProductSides"  : 
  [
    {
      "ProductFilename"   : "ExampleString",
      "ProductWidth"      : 1,
      "ProductHeight"     : 1,
      "Side"              : "ExampleString",
      "Images"  : 
      [
        {
          "ImageFilename"   : "ExampleString",
          "Region"  : 
          {
            "X"          : 3.14,
            "Y"          : 3.14,
            "Width"      : 3.14,
            "Height"     : 3.14,
            "Rotation"   : 3.14
          },
          "RegionString"    : "ExampleString"
        }
      ]
    }
  ],
  "Categories"  : 
  [
    {
      "ID"     : 1,
      "Name"   : "ExampleString",
      "Path"   : "ExampleString"
    }
  ],
  "Sides"  : 
  [
    {
      "Name"                 : "ExampleString",
      "DisplayName"          : "ExampleString",
      "Active"               : "true",
      "Regions"  : 
      [
        {
          "ID"                          : 1000001,
          "Name"                        : "Full",
          "X"                           : 10,
          "Y"                           : 10,
          "Width"                       : 100,
          "Height"                      : 200,
          "Rotation"                    : null,
          "Shape"                       : null,
          "Side"                        : "front",
          "IsDefault"                   : "true",
          "ProductRegionRenderSizeId"   : 1,
          "RenderWidthInches"           : null,
          "RenderHeightInches"          : null
        }
      ],
      "OverlayArtImageUrl"   : "ExampleString"
    }
  ],
  "StoreIds"                            : [1,2,3],
  "Personalizations"  : 
  [
    {
      "ID"            : 10000,
      "ProductId"     : 10000,
      "Name"          : "First Name",
      "Description"   : "Your first name",
      "Required"      : "true",
      "Active"        : "true",
      "Price"         : null,
      "Options"  : 
      [
        {
          "ID"      : 100000,
          "Value"   : "Highland High School"
        }
      ],
      "Format"        : "NumbersOnly",
      "MinLength"     : 1,
      "MaxLength"     : 1
    }
  ],
  "ID"                                  : 1000000,
  "SourceProductId"                     : 1000001,
  "Active"                              : "true",
  "Manufacturer"                        : "Gildan",
  "ManufacturerSku"                     : "2200",
  "ManufacturerId"                      : 1000000,
  "SupplierId"                          : Sanmar,
  "Supplier"                            : "Sanmar",
  "MaxColors"                           : "true",
  "CanPrint"                            : "true",
  "CanDigitalPrint"                     : "true",
  "CanScreenPrint"                      : "true",
  "CanEmbroider"                        : "true",
  "Sku"                                 : "2200_41157_1000000",
  "Name"                                : "Ultra Cotton Tank Top",
  "IsStatic"                            : "true",
  "BuyBlank"                            : "true",
  "DesignOnline"                        : "true",
  "DesignDetailsForm"                   : "true",
  "StaticDesignId"                      : 1,
  "Created"                             : "2017-10-30T07:00:00Z",
  "PersonalizationType"                 : "ExampleString",
  "HasProductArt"                       : "true",
  "EnforceProductInventoriesLocal"      : "true",
  "EnforceProductInventoriesSupplier"   : "true",
  "UnitCost"                            : 3.14,
  "UnitPrice"                           : 3.14,
  "SalePrice"                           : 3.14,
  "PriceRuleMarkup"  : 
  {
    "Schedules"  : 
    [
      {
        "ID"              : 1000000,
        "MinimumPrice"    : 0.01,
        "MaximumPrice"    : 5.00,
        "MarkupPercent"   : 100.00,
        "MarkupAmount"    : null
      }
    ],
    "ID"                         : 1000000,
    "Name"                       : "Markup",
    "MarkupFromCost"             : "true",
    "MarkupFromQuantity"         : "true",
    "MarkupAmountFromCost"       : "true",
    "MarkupAmountFromQuantity"   : "true"
  },
  "PriceRuleDiscount"  : 
  {
    "ID"             : 1000000,
    "Name"           : "Save10",
    "EntireCart"     : "true",
    "EachCartItem"   : "false",
    "Schedules"  : 
    [
      {
        "ID"                : 1000004,
        "MinimumQuantity"   : 3,
        "MaximumQuantity"   : 1000,
        "DiscountPercent"   : null,
        "DiscountAmount"    : 10.00
      }
    ]
  },
  "StyleCount"                          : 1,
  "TaxExempt"                           : "true",
  "SizeUnit"                            : "ExampleString",
  "SizeChartUrl"                        : "ExampleString",
  "ProductType"  : {"Name" : "example not found 2"},
  "LongDescription"                     : "This is a great looking shirt that will make you look great when you wear it",
  "ManufacturerBrandImageUrl"           : "ExampleString",
  "DefaultSide"                         : "ExampleString",
  "HasOrders"                           : "true"
}

 

ProductPersonalization

A personalization that applies to a product

Properties

  • ID type: integer

    A unique integer ID for this product personalization

  • ProductId type: (nullable) integer

    The ID of the product to which this personalization applies

  • Name type: string

    The name of this personalization

  • Description type: string

    A description of this personalization

  • Required type: boolean

    True if this personalization is required

  • Active type: boolean

    True if this personalization is active - this field is only populated when editing a product.

  • Price type: (nullable) decimal

    The cost associated with this personalzation (if any)

  • Options type: List of ProductPersonalizationOption

    A list of available options for this field from which the user should select.

  • Format type: (nullable) InputFormat

    Restrict a text input to a specified format.

  • MinLength type: (nullable) integer

    The minimum character length allowed.

  • MaxLength type: (nullable) integer

    The maximum character length allowed. 


{
  "ID"            : 10000,
  "ProductId"     : 10000,
  "Name"          : "First Name",
  "Description"   : "Your first name",
  "Required"      : "true",
  "Active"        : "true",
  "Price"         : null,
  "Options"  : 
  [
    {
      "ID"      : 100000,
      "Value"   : "Highland High School"
    }
  ],
  "Format"        : "NumbersOnly",
  "MinLength"     : 1,
  "MaxLength"     : 1
}

 

ProductPersonalizationOption

An option that should appear in a dropdown for a personalization field

Properties

  • ID type: integer

    A unique integer ID for this product personalization option.

  • Value type: string

    The value of this personalization option. 


{
  "ID"      : 100000,
  "Value"   : "Highland High School"
}

 

ProductRegion

Properties

  • ID type: integer

    A unique integer ID for this region

  • Name type: string

    The name of this region

  • X type: decimal

    The X (horizontal) position of this region

  • Y type: decimal

    The Y (vertical) position of this region

  • Width type: decimal

    The width of this region

  • Height type: decimal

    The height of this region

  • Rotation type: (nullable) decimal

    The rotation value of this region

  • Shape type: (nullable) integer

    The shape of this region

  • Side type: string

    One of "front", "back", "sleeveleft", "sleeveright"

  • IsDefault type: boolean

    True if this is the default region for the applicable product

  • ProductRegionRenderSizeId type: integer

    The ID of the product region's render size. The render size is a defined list of values that define a name and a width (eg: Adult 13"). It allows InkSoft to correlate the size of the region on the screen to a physical printed size.

  • RenderWidthInches type: (nullable) decimal

    The width in inches at which this region will be rendered

  • RenderHeightInches type: (nullable) decimal

    The width in inches at which this region will be rendered 


{
  "ID"                          : 1000001,
  "Name"                        : "Full",
  "X"                           : 10,
  "Y"                           : 10,
  "Width"                       : 100,
  "Height"                      : 200,
  "Rotation"                    : null,
  "Shape"                       : null,
  "Side"                        : "front",
  "IsDefault"                   : "true",
  "ProductRegionRenderSizeId"   : 1,
  "RenderWidthInches"           : null,
  "RenderHeightInches"          : null
}

 

ProductSide

A product side

Properties

  • Name type: string

    The name of this side (front, back, sleeveleft, sleeveright)

  • DisplayName type: string

    The name of this side that should be displayed to the end user

  • Active type: boolean

    True if this side is enabled and should be displayed to the end user.

  • Regions type: List of ProductRegion

    A list of ProductRegions that apply to this side

  • OverlayArtImageUrl type: string

    The image to be overlaid onto this region for masking purposes. 


{
  "Name"                 : "ExampleString",
  "DisplayName"          : "ExampleString",
  "Active"               : "true",
  "Regions"  : 
  [
    {
      "ID"                          : 1000001,
      "Name"                        : "Full",
      "X"                           : 10,
      "Y"                           : 10,
      "Width"                       : 100,
      "Height"                      : 200,
      "Rotation"                    : null,
      "Shape"                       : null,
      "Side"                        : "front",
      "IsDefault"                   : "true",
      "ProductRegionRenderSizeId"   : 1,
      "RenderWidthInches"           : null,
      "RenderHeightInches"          : null
    }
  ],
  "OverlayArtImageUrl"   : "ExampleString"
}

 

ProductStorePurchaseOption

Store level override for purchase options for a product

Properties

  • ID type: integer

  • ProductId type: integer

    The ID of the product

  • StoreId type: (nullable) integer

    The ID of the store, will be null if included as a property of a store, or to specify product-level options

  • BuyBlank type: boolean

    True if blanks can be purchased

  • DesignOnline type: boolean

    True if this product can be designed in the online designer

  • DesignDetailsForm type: boolean

    True if this product can be purchased via the design details form

  • DesignDetailsFormButtonLabel type: string

    Tbe text that will appear on the design details form button 


{
  "ID"                             : 1,
  "ProductId"                      : 1,
  "StoreId"                        : 1,
  "BuyBlank"                       : "true",
  "DesignOnline"                   : "true",
  "DesignDetailsForm"              : "true",
  "DesignDetailsFormButtonLabel"   : "ExampleString"
}

 

ProductStyle

A product, containing [Object:ProductStyle]s. Inherits from [Object:ProductBase]

Properties

  • UnitPrice type: (nullable) decimal

    The unit price of this style (sizes may have upcharges)

  • SupplierCost type: (nullable) decimal

    Supplier cost of this style

  • Price_Canvas type: decimal

    The canvas price of this style

  • Price_Name type: decimal

    The price for adding a name to be printed on this style

  • Price_Number type: decimal

    The price for adding a number to be printed on this style

  • ImageWidth_Front type: (nullable) integer

    Deprecated: use Sides instead. The width of the front image

  • ImageWidth_Back type: (nullable) integer

    Deprecated: use Sides instead. The width of the back image

  • ImageHeight_Front type: (nullable) integer

    Deprecated: use Sides instead. The height of the front image

  • ImageHeight_Back type: (nullable) integer

    Deprecated: use Sides instead. The height of the back image

  • ImageFilePath_Back type: string

    Deprecated: use Sides instead. The file path of the back image. This value will be present when this style was copied from another Deprecated: use Sides instead.

  • ImageFilePath_SleeveLeft type: string

    Deprecated: use Sides instead. The file path of the left image. This value will be present when this style was copied from another

  • ImageFilePath_SleeveRight type: string

    Deprecated: use Sides instead. The file path of the right image. This value will be present when this style was copied from another

  • Colorway_Front type: Colorway

    Deprecated: use Sides instead. If this product was created via the RapidProductCreator and has a colorway associated with it, this is the colorway for this style on the front. If null, default colorway should be used.

  • Colorway_Back type: Colorway

    Deprecated: use Sides instead. If this product was created via the RapidProductCreator and has a colorway associated with it, this is the colorway for this style on the back. If null, default colorway should be used.

  • Colorway_SleeveLeft type: Colorway

    Deprecated: use Sides instead. If this product was created via the RapidProductCreator and has a colorway associated with it, this is the colorway for this style on the left sleeve. If null, default colorway should be used.

  • Colorway_SleeveRight type: Colorway

    Deprecated: use Sides instead. If this product was created via the RapidProductCreator and has a colorway associated with it, this is the colorway for this style on the right sleeve. If null, default colorway should be used.

  • MinimumItemStyleQuantity type: (nullable) integer

    Represents the minimum number of this style that can be ordered. This overrides the value at the Product level.

  • CanPrint type: boolean

  • CanDigitalPrint type: boolean

  • CanScreenPrint type: boolean

  • CanEmbroider type: boolean

  • IsDefault type: boolean

  • ID type: integer

  • HtmlColor1 type: string

  • HtmlColor2 type: string

  • Name type: string

  • Active type: boolean

  • IsLightColor type: boolean

  • IsDarkColor type: boolean

  • IsHeathered type: boolean

  • ImageFilePath_Front type: string

  • Sides type: List of ProductStyleSide

  • ColorwayImageFilePath_Front type: string

  • Sizes type: List of ProductStyleSize

  • AvailableQuantityPacks type: List of integer

  • QuantityPackPricing type: List of QuantityPackPrice

  • Price type: (nullable) decimal 


{
  "UnitPrice"                     : 3.14,
  "SupplierCost"                  : 3.14,
  "Price_Canvas"                  : 3.14,
  "Price_Name"                    : 3.14,
  "Price_Number"                  : 3.14,
  "ImageWidth_Front"              : 1,
  "ImageWidth_Back"               : 1,
  "ImageHeight_Front"             : 1,
  "ImageHeight_Back"              : 1,
  "ImageFilePath_Back"            : "ExampleString",
  "ImageFilePath_SleeveLeft"      : "ExampleString",
  "ImageFilePath_SleeveRight"     : "ExampleString",
  "Colorway_Front"  : 
  {
    "ID"             : 1,
    "Colors"  : 
    [
      {
        "Index"                : 1,
        "Color"                : "ExampleString",
        "EmbroideryThreadId"   : 1,
        "InkColorId"           : 1,
        "ColorName"            : "ExampleString",
        "PMS"                  : "ExampleString"
      }
    ],
    "Name"           : "ExampleString",
    "SvgUrl"         : "ExampleString",
    "RenderedUrl"    : "ExampleString",
    "ThumbnailUrl"   : "ExampleString"
  },
  "Colorway_Back"  : 
  {
    "ID"             : 1,
    "Colors"  : 
    [
      {
        "Index"                : 1,
        "Color"                : "ExampleString",
        "EmbroideryThreadId"   : 1,
        "InkColorId"           : 1,
        "ColorName"            : "ExampleString",
        "PMS"                  : "ExampleString"
      }
    ],
    "Name"           : "ExampleString",
    "SvgUrl"         : "ExampleString",
    "RenderedUrl"    : "ExampleString",
    "ThumbnailUrl"   : "ExampleString"
  },
  "Colorway_SleeveLeft"  : 
  {
    "ID"             : 1,
    "Colors"  : 
    [
      {
        "Index"                : 1,
        "Color"                : "ExampleString",
        "EmbroideryThreadId"   : 1,
        "InkColorId"           : 1,
        "ColorName"            : "ExampleString",
        "PMS"                  : "ExampleString"
      }
    ],
    "Name"           : "ExampleString",
    "SvgUrl"         : "ExampleString",
    "RenderedUrl"    : "ExampleString",
    "ThumbnailUrl"   : "ExampleString"
  },
  "Colorway_SleeveRight"  : 
  {
    "ID"             : 1,
    "Colors"  : 
    [
      {
        "Index"                : 1,
        "Color"                : "ExampleString",
        "EmbroideryThreadId"   : 1,
        "InkColorId"           : 1,
        "ColorName"            : "ExampleString",
        "PMS"                  : "ExampleString"
      }
    ],
    "Name"           : "ExampleString",
    "SvgUrl"         : "ExampleString",
    "RenderedUrl"    : "ExampleString",
    "ThumbnailUrl"   : "ExampleString"
  },
  "MinimumItemStyleQuantity"      : 1,
  "CanPrint"                      : "true",
  "CanDigitalPrint"               : "true",
  "CanScreenPrint"                : "true",
  "CanEmbroider"                  : "true",
  "IsDefault"                     : "true",
  "ID"                            : 1,
  "HtmlColor1"                    : "ExampleString",
  "HtmlColor2"                    : "ExampleString",
  "Name"                          : "ExampleString",
  "Active"                        : "true",
  "IsLightColor"                  : "true",
  "IsDarkColor"                   : "true",
  "IsHeathered"                   : "true",
  "ImageFilePath_Front"           : "ExampleString",
  "Sides"  : 
  [
    {
      "Side"            : "ExampleString",
      "ImageFilePath"   : "ExampleString",
      "Width"           : 1,
      "Height"          : 1,
      "Colorway"  : 
      {
        "ID"             : 1,
        "Colors"  : 
        [
          {
            "Index"                : 1,
            "Color"                : "ExampleString",
            "EmbroideryThreadId"   : 1,
            "InkColorId"           : 1,
            "ColorName"            : "ExampleString",
            "PMS"                  : "ExampleString"
          }
        ],
        "Name"           : "ExampleString",
        "SvgUrl"         : "ExampleString",
        "RenderedUrl"    : "ExampleString",
        "ThumbnailUrl"   : "ExampleString"
      }
    }
  ],
  "ColorwayImageFilePath_Front"   : "ExampleString",
  "Sizes"  : 
  [
    {
      "ID"                        : 1000001,
      "Active"                    : "true",
      "IsDeleted"                 : "true",
      "Name"                      : "L",
      "ManufacturerSku"           : "B174BE097",
      "LongName"                  : "Large",
      "UnitPrice"                 : 15.00,
      "Price"                     : 3.14,
      "OverridePrice"             : 3.14,
      "SalePrice"                 : 12.99,
      "SaleStart"                 : "2017-10-30T07:00:00Z",
      "SaleEnd"                   : "2017-10-30T07:00:00Z",
      "IsDefault"                 : "true",
      "InStock"                   : "true",
      "SupplierInventory"         : 1,
      "LocalInventory"            : 1,
      "SupplierCost"              : 3.14,
      "UpCharge"                  : 0.00,
      "Weight"                    : 3.14,
      "SortOrder"                 : 1,
      "Detail"  : 
      {
        "GTIN"   : "ExampleString"
      },
      "QuantityPackPricing"  : 
      [
        {
          "Quantity"   : 1,
          "Price"      : 3.14,
          "Cost"       : 3.14
        }
      ],
      "ProductStyleSizeToStore"  : 
      [
        {
          "ProductId"                   : 1,
          "ProductStyleId"              : 1,
          "ProductStyleSizeId"          : 1,
          "ProductStyleSizeToStoreId"   : 1,
          "PriceOverride"               : 3.14,
          "StoreId"                     : 1
        }
      ]
    }
  ],
  "AvailableQuantityPacks"        : [1,2,3],
  "QuantityPackPricing"  : 
  [
    {
      "Quantity"   : 1,
      "Price"      : 3.14,
      "Cost"       : 3.14
    }
  ],
  "Price"                         : 3.14
}

 

ProductStyleBase

ProductStyleBase contains a small number of lightweight properties used to quickly search and display product styles. Inherited by [Object:ProductStyle] for full product properties

Properties

  • CanPrint type: boolean

    True if this style can be printed (screen or digitally)

  • CanDigitalPrint type: boolean

    True if this style can be digitally printed

  • CanScreenPrint type: boolean

    True if this style can be screen printed

  • CanEmbroider type: boolean

    True if this style can be embroidered

  • IsDefault type: boolean

    True if this is the default style for the applicable product

  • ID type: integer

    A unique integer ID for this style

  • HtmlColor1 type: string

    The hex value corresponding to the primary color of this style

  • HtmlColor2 type: string

    The hex value corresponding to the secondary color of this style

  • Name type: string

    The name of this style

  • Active type: boolean

    True if this style is active

  • IsLightColor type: boolean

    True if this style is a light color

  • IsDarkColor type: boolean

    True if this style is a dark color

  • IsHeathered type: boolean

    True if this style is heathered

  • ImageFilePath_Front type: string

    The path to the front image for this style

  • Sides type: List of ProductStyleSide

    Includes data for each enabled side of the ProductBase.

  • ColorwayImageFilePath_Front type: string

    Deprecated: use Sides instead. If the product has product art and this style has a different colorway, this is the URL to the thumbnail png image of that colorway.

  • Sizes type: List of ProductStyleSize

    A list of sizes for this style

  • AvailableQuantityPacks type: List of integer

    Available quantity packs for the product

  • QuantityPackPricing type: List of QuantityPackPrice

    List of quantity based pack pricing across the style

  • Price type: (nullable) decimal

    Reflects field dbo.product_styles.price 


{
  "CanPrint"                      : "true",
  "CanDigitalPrint"               : "true",
  "CanScreenPrint"                : "true",
  "CanEmbroider"                  : "true",
  "IsDefault"                     : "true",
  "ID"                            : 1000001,
  "HtmlColor1"                    : "ExampleString",
  "HtmlColor2"                    : "ExampleString",
  "Name"                          : "Red",
  "Active"                        : "true",
  "IsLightColor"                  : "true",
  "IsDarkColor"                   : "true",
  "IsHeathered"                   : "true",
  "ImageFilePath_Front"           : "ExampleString",
  "Sides"  : 
  [
    {
      "Side"            : "ExampleString",
      "ImageFilePath"   : "ExampleString",
      "Width"           : 1,
      "Height"          : 1,
      "Colorway"  : 
      {
        "ID"             : 1,
        "Colors"  : 
        [
          {
            "Index"                : 1,
            "Color"                : "ExampleString",
            "EmbroideryThreadId"   : 1,
            "InkColorId"           : 1,
            "ColorName"            : "ExampleString",
            "PMS"                  : "ExampleString"
          }
        ],
        "Name"           : "ExampleString",
        "SvgUrl"         : "ExampleString",
        "RenderedUrl"    : "ExampleString",
        "ThumbnailUrl"   : "ExampleString"
      }
    }
  ],
  "ColorwayImageFilePath_Front"   : "ExampleString",
  "Sizes"  : 
  [
    {
      "ID"                        : 1000001,
      "Active"                    : "true",
      "IsDeleted"                 : "true",
      "Name"                      : "L",
      "ManufacturerSku"           : "B174BE097",
      "LongName"                  : "Large",
      "UnitPrice"                 : 15.00,
      "Price"                     : 3.14,
      "OverridePrice"             : 3.14,
      "SalePrice"                 : 12.99,
      "SaleStart"                 : "2017-10-30T07:00:00Z",
      "SaleEnd"                   : "2017-10-30T07:00:00Z",
      "IsDefault"                 : "true",
      "InStock"                   : "true",
      "SupplierInventory"         : 1,
      "LocalInventory"            : 1,
      "SupplierCost"              : 3.14,
      "UpCharge"                  : 0.00,
      "Weight"                    : 3.14,
      "SortOrder"                 : 1,
      "Detail"  : 
      {
        "GTIN"   : "ExampleString"
      },
      "QuantityPackPricing"  : 
      [
        {
          "Quantity"   : 1,
          "Price"      : 3.14,
          "Cost"       : 3.14
        }
      ],
      "ProductStyleSizeToStore"  : 
      [
        {
          "ProductId"                   : 1,
          "ProductStyleId"              : 1,
          "ProductStyleSizeId"          : 1,
          "ProductStyleSizeToStoreId"   : 1,
          "PriceOverride"               : 3.14,
          "StoreId"                     : 1
        }
      ]
    }
  ],
  "AvailableQuantityPacks"        : [1,2,3],
  "QuantityPackPricing"  : 
  [
    {
      "Quantity"   : 1,
      "Price"      : 3.14,
      "Cost"       : 3.14
    }
  ],
  "Price"                         : 3.14
}

 

ProductStyleSide

Represents a side of a product style. Intended to work along with ProductBase.DecoratedProductSides to provide all the information necessary to render any side and style of a product.

Properties

  • Side type: string

    One of 'front', 'back', 'sleeveleft', 'sleeveright'

  • ImageFilePath type: string

    A url to an image of this side of the product style.

  • Width type: (nullable) integer

    The width in pixels of the image referred to in ImageFilePath.

  • Height type: (nullable) integer

    The height in pixels of the image referred to in ImageFilePath.

  • Colorway type: Colorway

    The colorway assigned to this specific style, if different from the original art colors. 


{
  "Side"            : "ExampleString",
  "ImageFilePath"   : "ExampleString",
  "Width"           : 1,
  "Height"          : 1,
  "Colorway"  : 
  {
    "ID"             : 1,
    "Colors"  : 
    [
      {
        "Index"                : 1,
        "Color"                : "ExampleString",
        "EmbroideryThreadId"   : 1,
        "InkColorId"           : 1,
        "ColorName"            : "ExampleString",
        "PMS"                  : "ExampleString"
      }
    ],
    "Name"           : "ExampleString",
    "SvgUrl"         : "ExampleString",
    "RenderedUrl"    : "ExampleString",
    "ThumbnailUrl"   : "ExampleString"
  }
}

 

ProductStyleSize

A size of a [Object:ProductStyle]

Properties

  • ID type: integer

    The unique integer ID of this size. Size IDs are universally unique. The sizes of one ProductStyle are separate and distinct from the sizes of another, though the names of the sizes may be identical

  • Active type: boolean

    True if this size is active

  • IsDeleted type: boolean

    True if this size is deleted

  • Name type: string

    The name of this size

  • ManufacturerSku type: string

    The manufacturer SKU of this size

  • LongName type: string

    The long name, programatically determined via dictionary of common size abbreviations

  • UnitPrice type: (nullable) decimal

    The unit price of this size, programmatically determined by adding the upcharge to the price of the parent ProductStyle

  • Price type: (nullable) decimal

    Reflects dbo.product_style_size.price

  • OverridePrice type: (nullable) decimal

    Reflects dbo.product_style_size.price_override

  • SalePrice type: (nullable) decimal

    The sale price for this style

  • SaleStart type: (nullable) DateTime

    The date the sale takes effect

  • SaleEnd type: (nullable) DateTime

    The date the sale ends

  • IsDefault type: boolean

  • InStock type: boolean

    True if this size is in stock

  • SupplierInventory type: (nullable) integer

    Amount of product size in supplier inventory

  • LocalInventory type: (nullable) integer

    Amount of product size in local inventory

  • SupplierCost type: (nullable) decimal

    Supplier cost for the size

  • UpCharge type: decimal

    DEPRECATED: the upcharge for this size, based on the price of the parent ProductStyle. Only very old products should have upcharges, upcharges are now included in UnitPrice. Included only for support of microstores, and is not saved if it's set on the client.

  • Weight type: (nullable) decimal

    Weight of the Product Size

  • SortOrder type: (nullable) integer

    The sort order of this size. If sort order is null, sizes will be sorted based on common names (S, M, L, XL, 2XL, etc), then by alphabetical order

  • Detail type: ProductStyleSizeDetail

    Product Size Details such as GTIN, etc...

  • QuantityPackPricing type: List of QuantityPackPrice

    List of quantity based pack pricing per size

  • ProductStyleSizeToStore type: List of ProductStyleSizeToStore

    List of Product Style Size to Store 


{
  "ID"                        : 1000001,
  "Active"                    : "true",
  "IsDeleted"                 : "true",
  "Name"                      : "L",
  "ManufacturerSku"           : "B174BE097",
  "LongName"                  : "Large",
  "UnitPrice"                 : 15.00,
  "Price"                     : 3.14,
  "OverridePrice"             : 3.14,
  "SalePrice"                 : 12.99,
  "SaleStart"                 : "2017-10-30T07:00:00Z",
  "SaleEnd"                   : "2017-10-30T07:00:00Z",
  "IsDefault"                 : "true",
  "InStock"                   : "true",
  "SupplierInventory"         : 1,
  "LocalInventory"            : 1,
  "SupplierCost"              : 3.14,
  "UpCharge"                  : 0.00,
  "Weight"                    : 3.14,
  "SortOrder"                 : 1,
  "Detail"  : 
  {
    "GTIN"   : "ExampleString"
  },
  "QuantityPackPricing"  : 
  [
    {
      "Quantity"   : 1,
      "Price"      : 3.14,
      "Cost"       : 3.14
    }
  ],
  "ProductStyleSizeToStore"  : 
  [
    {
      "ProductId"                   : 1,
      "ProductStyleId"              : 1,
      "ProductStyleSizeId"          : 1,
      "ProductStyleSizeToStoreId"   : 1,
      "PriceOverride"               : 3.14,
      "StoreId"                     : 1
    }
  ]
}

 

ProductStyleSizeDetail

Properties

  • GTIN type: string 


{
  "GTIN"   : "ExampleString"
}

 

ProductStyleSizeInventory

The quantity of a product size currently in stock, along with product and style ID for each front end referencing

Properties

  • ProductStyleSizeId type: integer

    The ID of the product style size to which this inventory applies

  • Gtin type: string

    The GTIN/Barcode of the size that the inventory refers to.

  • LocalInventory type: (nullable) integer

    The quantity of this size available locally

  • SupplierInventory type: (nullable) integer

    The quantity of this size available from the supplier

  • LocalLastUpdated type: (nullable) DateTime

    The date/time the value for LocalInventory was last updated

  • SupplierLastUpdated type: (nullable) DateTime

    The date/time the value for LocalInventory was last updated 


{
  "ProductStyleSizeId"    : 1,
  "Gtin"                  : "ExampleString",
  "LocalInventory"        : 1,
  "SupplierInventory"     : 1,
  "LocalLastUpdated"      : "2017-10-30T07:00:00Z",
  "SupplierLastUpdated"   : "2017-10-30T07:00:00Z"
}

 

ProductStyleSizePrice

Pricing information about a product style size

Properties

  • ProductStyleSizeId type: integer

    The unique integer ID of the product style size

  • PriceEach type: decimal

    The price of this size

  • CostEach type: (nullable) decimal

    The unit cost of this size 


{
  "ProductStyleSizeId"   : 1,
  "PriceEach"            : 3.14,
  "CostEach"             : 3.14
}

 

ProductStyleSizeToStore

Properties

  • ProductId type: integer

  • ProductStyleId type: integer

  • ProductStyleSizeId type: integer

  • ProductStyleSizeToStoreId type: integer

  • PriceOverride type: (nullable) decimal

  • StoreId type: integer 


{
  "ProductId"                   : 1,
  "ProductStyleId"              : 1,
  "ProductStyleSizeId"          : 1,
  "ProductStyleSizeToStoreId"   : 1,
  "PriceOverride"               : 3.14,
  "StoreId"                     : 1
}

 

ProductionCard

Represents a production card for an order

Properties

  • ID type: integer

    The unique integer ID of this production card

  • JobId type: (nullable) integer

    The ID of the job to which this production card is associated, if any

  • JobName type: string

    The Name of the job to which this production card is associated, if any

  • JobStatusName type: string

    The Status Name of the job to which this production card is associated, if any

  • JobStatusId type: (nullable) integer

    The ID of the current status of the job to which this production card is associated, if any

  • JobNumber type: string

    The number to display of the job to which this production card is associated, if any

  • OrderId type: integer

    The ID of the Order to which this production card is associated

  • PrintavoOrderId type: string

    The internal ID of the printavo order to which this production card is associated, if any. If this has a value, JobNumber will be the associated printavo visual order ID.

  • PrintavoOrderLink type: string

    The link to the printavo order to which this production card is associated, if any.

  • SalesDocGuid type: (nullable) guid

    The Guid of the SalesDoc to which this production card is associated

  • DecorationGuid type: (nullable) guid

    The Guid of the SalesDoc decoration to which this production card is associated

  • OrderFirstName type: string

    The First Name on the Order to which this production card is associated

  • OrderLastName type: string

    The Last Name on the Order to which this production card is associated

  • OrderEmail type: string

    The Email on the Order to which this production card is associated

  • OrderStoreName type: string

    The StoreName of the Order to which this production card is associated

  • OrderDate type: DateTime

    The Date of the Order to which this production card is associated (In UTC)

  • OrderRetailItemId type: (nullable) integer

    The ID of the Order Retail Item to which this production card is associated

  • OrderPaymentStatus type: (nullable) OrderPaymentStatus

    The OrderPaymentStatus of the Order to which this production card is associated

  • Number type: string

    The number to display for this production card

  • DesignGroupKey type: string

    The key to group this production card when grouping by design

  • ShipDate type: (nullable) DateTime

    The expected ship date for the items on production card (In UTC)

  • OrderIsPickup type: boolean

    If the order is being Shipped or Picked Up

  • ProductId type: (nullable) integer

    The product id for this production card

  • ProductName type: string

    The name of the product for this production card

  • ProductSku type: string

    The SKU of the product for this production card

  • ProductManufacturer type: string

    The manufacturer name of the product for this production card

  • ProductSupplier type: string

    The supplier name of the product for this production card

  • ProductStyleName type: string

    The color/style of the product for this production card

  • ProductStyleId type: integer

    The color/style ID of the product for this production card

  • DesignName type: string

    The name of the art/design to be produced on for this production card

  • DesignType type: (nullable) ProductionCardDesignType

  • Art type: Art

    The Art to which this production card is associated

  • ArtId type: (nullable) integer

    The ID of the Art to which this production card is associated. If this production card has both an ArtId and a , the references the principal art/design object, and the ArtId is just a convenience property that is also referenced via the object.

  • DesignId type: (nullable) integer

    The ID of the Design to which this production card is associated

  • ColorwayId type: (nullable) integer

    The ID of the Colorway of the design, if applicable

  • CanvasId type: (nullable) integer

    The ID of the Design Canvas to which this production card is associated

  • Side type: string

    The side of the product for the design to be produced on for this production card

  • SideInternalName type: string

    The internal side name of the product for the design to be proudced on for this production card.

  • RegionName type: string

    The decoration's region name on the product side

  • Region type: ProductRegion

    The decoration's coordinates on the product side

  • ProductType type: ProductType

    The type of product for this production card

  • SizeUnit type: string

    The unit that the product size is expressed in for Signage products

  • ProductUrl type: string

    The URL to display the blank product for this production card

  • PreviewUrl type: string

    The URL to display the preview of the design on the product for this production card

  • DesignUrl type: string

    The URL to display the preview of the design for this production card

  • ArtUrl type: string

    The URL to display the art/design for this production card

  • PrintMethod type: string

    The production method for this production card

  • Quantity type: integer

    The quantity of all the line items of the product to be produced for this production card

  • ColorCount type: (nullable) integer

    The number of colors associated with the design for this production card

  • ProductionNotes type: string

    The production notes for this production card

  • OrderNotes type: string

    The notes for this Order

  • OrderItemNotes type: string

    The customer-entered notes for this Order Item

  • DateCompleted type: (nullable) DateTime

    The date this production card was completed (In UTC) null if not completed

  • Timeline type: List of TimelineEntry

    A list of TimelineEntry objects representing all the activities performed on this production card.

  • Attachments type: List of ProductionCardAttachment

    A list of ProductionCardAttachments representing all the files attached to this production card.

  • Colors type: List of ProductionCardColor

    A list of ProductionCardColors representing all the colors associated with the art/design on this production card.

  • Items type: List of ProductionCardItem

    A list of ProductionCardItems representing all the items to be produced on this production card.

  • ColorwayName type: string

    Name of assigned Colorway

  • ProductHtmlColor type: string

    The HTML color of the product for this production card.

  • ProductShape type: string

    The canvas shape of the product for this production card.

  • EstimatedProductionDays type: (nullable) integer

    The estimated production time for an item. Overrides shipping method processing days if greater than that value. 


{
  "ID"                        : 1000001,
  "JobId"                     : 1,
  "JobName"                   : "ExampleString",
  "JobStatusName"             : "ExampleString",
  "JobStatusId"               : 1,
  "JobNumber"                 : "ExampleString",
  "OrderId"                   : 1,
  "PrintavoOrderId"           : "ExampleString",
  "PrintavoOrderLink"         : "ExampleString",
  "SalesDocGuid"              : "",
  "DecorationGuid"            : "",
  "OrderFirstName"            : "ExampleString",
  "OrderLastName"             : "ExampleString",
  "OrderEmail"                : "ExampleString",
  "OrderStoreName"            : "ExampleString",
  "OrderDate"                 : "2017-10-30T07:00:00Z",
  "OrderRetailItemId"         : 1,
  "OrderPaymentStatus"        : "",
  "Number"                    : "ExampleString",
  "DesignGroupKey"            : "ExampleString",
  "ShipDate"                  : "2017-10-30T07:00:00Z",
  "OrderIsPickup"             : "true",
  "ProductId"                 : 1,
  "ProductName"               : "ExampleString",
  "ProductSku"                : "ExampleString",
  "ProductManufacturer"       : "ExampleString",
  "ProductSupplier"           : "ExampleString",
  "ProductStyleName"          : "ExampleString",
  "ProductStyleId"            : 1,
  "DesignName"                : "ExampleString",
  "DesignType"                : "",
  "Art"  : 
  {
    "ID"                    : 1,
    "ColorCount"            : 1,
    "Colors"                : ["#FF0000","#FFFFFF","#0000FF"],
    "OriginalColorway"  : 
    {
      "ID"             : 1,
      "Colors"  : 
      [
        {
          "Index"                : 1,
          "Color"                : "ExampleString",
          "EmbroideryThreadId"   : 1,
          "InkColorId"           : 1,
          "ColorName"            : "ExampleString",
          "PMS"                  : "ExampleString"
        }
      ],
      "Name"           : "ExampleString",
      "SvgUrl"         : "ExampleString",
      "RenderedUrl"    : "ExampleString",
      "ThumbnailUrl"   : "ExampleString"
    },
    "StitchCount"           : 1,
    "TrimCount"             : 1,
    "GalleryId"             : 1,
    "CategoryIds"           : [1,2,3],
    "Name"                  : "Business_Designs",
    "Type"                  : "ExampleString",
    "Keywords"              : "pretty,big,black and white,zebra",
    "FixedSvg"              : "true",
    "Digitized"             : "true",
    "CanScreenPrint"        : "true",
    "FullName"              : "store5976/Business/Business_Designs",
    "ExternalReferenceID"   : "ExampleString",
    "Width"                 : 762,
    "Height"                : 538,
    "Notes"                 : "ExampleString",
    "FileExt"               : "png",
    "ImageUrl"              : "ExampleString",
    "ThumbUrl"              : "ExampleString",
    "ThumbUrlAlt"           : "ExampleString",
    "OriginalUrl"           : "ExampleString",
    "UploadedUrl"           : "ExampleString",
    "UploadedOn"            : "2017-10-30T07:00:00Z",
    "IsActive"              : "true",
    "Colorways"  : 
    [
      {
        "ID"             : 1,
        "Colors"  : 
        [
          {
            "Index"                : 1,
            "Color"                : "ExampleString",
            "EmbroideryThreadId"   : 1,
            "InkColorId"           : 1,
            "ColorName"            : "ExampleString",
            "PMS"                  : "ExampleString"
          }
        ],
        "Name"           : "ExampleString",
        "SvgUrl"         : "ExampleString",
        "RenderedUrl"    : "ExampleString",
        "ThumbnailUrl"   : "ExampleString"
      }
    ],
    "UniqueId"              : "",
    "MatchFileColor"        : "true"
  },
  "ArtId"                     : 1,
  "DesignId"                  : 1,
  "ColorwayId"                : 1,
  "CanvasId"                  : 1,
  "Side"                      : "ExampleString",
  "SideInternalName"          : "ExampleString",
  "RegionName"                : "ExampleString",
  "Region"  : 
  {
    "ID"                          : 1000001,
    "Name"                        : "Full",
    "X"                           : 10,
    "Y"                           : 10,
    "Width"                       : 100,
    "Height"                      : 200,
    "Rotation"                    : null,
    "Shape"                       : null,
    "Side"                        : "front",
    "IsDefault"                   : "true",
    "ProductRegionRenderSizeId"   : 1,
    "RenderWidthInches"           : null,
    "RenderHeightInches"          : null
  },
  "ProductType"  : {"Name" : "example not found 2"},
  "SizeUnit"                  : "ExampleString",
  "ProductUrl"                : "ExampleString",
  "PreviewUrl"                : "ExampleString",
  "DesignUrl"                 : "ExampleString",
  "ArtUrl"                    : "ExampleString",
  "PrintMethod"               : "ExampleString",
  "Quantity"                  : 1,
  "ColorCount"                : 1,
  "ProductionNotes"           : "ExampleString",
  "OrderNotes"                : "ExampleString",
  "OrderItemNotes"            : "ExampleString",
  "DateCompleted"             : "2017-10-30T07:00:00Z",
  "Timeline"  : 
  [
    {
      "EventDescription"    : ,
      "ID"                  : 1,
      "ContactIds"          : [1,2,3],
      "CompanyIds"          : [1,2,3],
      "JobIds"              : [1,2,3],
      "OrderIds"            : [1,2,3],
      "ProposalIds"         : [1,2,3],
      "ProductionCardIds"   : [1,2,3],
      "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
      "Event"               : "ExampleString",
      "Comment"             : "ExampleString",
      "EventType"  : {"Name" : "example not found 2"},
      "Edited"              : "true",
      "EditedDate"          : "2017-10-30T07:00:00Z",
      "Deleted"             : "true",
      "DeletedDate"         : "2017-10-30T07:00:00Z",
      "Created"             : "2017-10-30T07:00:00Z",
      "CreatedByUserId"     : 1,
      "CreatedByName"       : "ExampleString",
      "Details"  : 
      [
        {
          "Property"   : "ExampleString",
          "OldValue"   : "ExampleString",
          "NewValue"   : "ExampleString",
          "Date"       : "2017-10-30T07:00:00Z"
        }
      ],
      "Associations"  : {"Name" : "example not found 2"}
    }
  ],
  "Attachments"  : 
  [
    {
      "ID"                 : 1000001,
      "Type"  : {"Name" : "example not found 2"},
      "ProductionCardId"   : 1,
      "OriginalName"       : "ExampleString",
      "Name"               : "ExampleString",
      "Description"        : "ExampleString",
      "MimeType"           : "ExampleString",
      "Url"                : "ExampleString",
      "UrlThumbnail"       : "ExampleString",
      "UrlPreview"         : "ExampleString"
    }
  ],
  "Colors"  : 
  [
    {
      "ID"                  : 1000001,
      "ProductionCardId"    : 1,
      "Index"               : 1,
      "Name"                : "ExampleString",
      "PMS"                 : "ExampleString",
      "HtmlColor"           : "ExampleString",
      "ThreadLibraryName"   : "ExampleString",
      "ThreadChartName"     : "ExampleString",
      "ThreadColorName"     : "ExampleString",
      "ThreadColorCode"     : "ExampleString"
    }
  ],
  "Items"  : 
  [
    {
      "ID"                      : 1000001,
      "ProductionCardId"        : 1,
      "SalesDocItemGuid"        : "",
      "Size"                    : "ExampleString",
      "Quantity"                : 1,
      "Status"                  : "ExampleString",
      "PurchasingStatus"        : "ExampleString",
      "IsComplete"              : "true",
      "PersonalizationValues"  : 
      [
        {
          "Name"                       : "ExampleString",
          "Value"                      : "ExampleString",
          "Price"                      : 3.14,
          "ProductPersonalizationId"   : 1
        }
      ],
      "NameNumberValue"  : 
      {
        "RetailItemSizeId"   : 1000000,
        "Name"               : "Bob",
        "Number"             : "32",
        "Quantity"           : 1,
        "Price"              : 32
      },
      "SortOrder"               : 1
    }
  ],
  "ColorwayName"              : "ExampleString",
  "ProductHtmlColor"          : "ExampleString",
  "ProductShape"              : "ExampleString",
  "EstimatedProductionDays"   : 1
}

 

ProductionCardAttachment

Represents a file attached to a production card

Properties

  • ID type: integer

    The unique integer ID of this production card attachment

  • Type type: ProductionCardAttachmentType

    The type of this attachment

  • ProductionCardId type: integer

    The ID of the production card to which this file is attached

  • OriginalName type: string

    The Original Name of the file

  • Name type: string

    The name of the file

  • Description type: string

    The description of the file

  • MimeType type: string

    The mime type of the file

  • Url type: string

    The URL to download the file

  • UrlThumbnail type: string

    The URL to the thumbnail for the file

  • UrlPreview type: string

    The URL to the large preview for the file 


{
  "ID"                 : 1000001,
  "Type"  : {"Name" : "example not found 2"},
  "ProductionCardId"   : 1,
  "OriginalName"       : "ExampleString",
  "Name"               : "ExampleString",
  "Description"        : "ExampleString",
  "MimeType"           : "ExampleString",
  "Url"                : "ExampleString",
  "UrlThumbnail"       : "ExampleString",
  "UrlPreview"         : "ExampleString"
}

 

ProductionCardColor

Represents a color associated with the design of a production card

Properties

  • ID type: integer

    The unique integer ID of this production card clor

  • ProductionCardId type: integer

    The ID of the production card to which this color is associated

  • Index type: integer

    The index of the color in the list of colors on this production card

  • Name type: string

    The name of the color

  • PMS type: string

    The PMS value of the color

  • HtmlColor type: string

    The HTML (hex) value of the color

  • ThreadLibraryName type: string

    The name of the thread library. Valid for thread colors only

  • ThreadChartName type: string

    The name of the thread chart. Valid for thread colors only

  • ThreadColorName type: string

    The name of the thread color (from the thread chart). Valid for thread colors only

  • ThreadColorCode type: string

    The code of the thread color. Valid for thread colors only 


{
  "ID"                  : 1000001,
  "ProductionCardId"    : 1,
  "Index"               : 1,
  "Name"                : "ExampleString",
  "PMS"                 : "ExampleString",
  "HtmlColor"           : "ExampleString",
  "ThreadLibraryName"   : "ExampleString",
  "ThreadChartName"     : "ExampleString",
  "ThreadColorName"     : "ExampleString",
  "ThreadColorCode"     : "ExampleString"
}

 

ProductionCardItem

Represents a line item to be produced on a production card

Properties

  • ID type: integer

    The unique integer ID of this production card order retail item size

  • ProductionCardId type: integer

    The ID of the production card to which this line item is associated

  • SalesDocItemGuid type: (nullable) guid

    The SalesDocItemGuid that this item is associated with

  • Size type: string

    The size of this line item

  • Quantity type: integer

    The quantity of the item to be produced for this production card

  • Status type: string

    The production status of this line item

  • PurchasingStatus type: string

    The purchasing status of this size and order

  • IsComplete type: boolean

    Display if the line item was Mark Completed or not.

  • PersonalizationValues type: List of PersonalizationValue

    A single set of personalization values for this line item

  • NameNumberValue type: NameNumberValue

    The name number value for this line item

  • SortOrder type: integer

    The sort order from the product style size of this item which is set by the admin portal product setting drag and drop This is included for ordering of product style sizes within job production cards when multiple cards are combined by the frontend 


{
  "ID"                      : 1000001,
  "ProductionCardId"        : 1,
  "SalesDocItemGuid"        : "",
  "Size"                    : "ExampleString",
  "Quantity"                : 1,
  "Status"                  : "ExampleString",
  "PurchasingStatus"        : "ExampleString",
  "IsComplete"              : "true",
  "PersonalizationValues"  : 
  [
    {
      "Name"                       : "ExampleString",
      "Value"                      : "ExampleString",
      "Price"                      : 3.14,
      "ProductPersonalizationId"   : 1
    }
  ],
  "NameNumberValue"  : 
  {
    "RetailItemSizeId"   : 1000000,
    "Name"               : "Bob",
    "Number"             : "32",
    "Quantity"           : 1,
    "Price"              : 32
  },
  "SortOrder"               : 1
}

 

Proposal

Represents a proposal of work to be shared with a customer

Properties

  • ID type: integer

    The unique integer ID of the proposal

  • CartId type: (nullable) integer

    The ID of the cart related to this proposal

  • Number type: string

    The unique number of the proposal

  • UniqueId type: (nullable) guid

    The unique ID of the proposal

  • Name type: string

    The name of the proposal

  • PurchaseOrderNumber type: string

    A PO number for reference

  • AssigneeId type: integer

    The ID of the admin assigned to this proposal

  • AssigneeName type: string

    The name of the admin assigned to this proposal

  • AssigneeEmail type: string

    The email of the admin assigned to this proposal

  • StoreEmail type: string

    The contact email of the publisher

  • StorePhone type: string

    The contact phone number of the publisher

  • PrimaryContactId type: integer

    The ID of the contact for which this proposal was created

  • PrimaryContactName type: string

    The name of the contact for which this proposal was created

  • PrimaryContactEmail type: string

    The name of the contact for which this proposal was created

  • Deleted type: boolean

    True is the proposal has been marked as Deleted

  • DepositAmount type: (nullable) decimal

    The amount of deposit required. Mutually exclusive with DepositPercent

  • DepositPercent type: (nullable) decimal

    The percent of deposit required. Mutually exclusive with DepositAmount

  • PartialPaymentAllowed type: boolean

    True if partial payments are accepted for this proposal

  • Arts type: List of Art

    A list of art that shows on this proposal

  • Payments type: List of OrderPayment

    The list of payments for this proposal

  • PaymentStatus type: OrderPaymentStatus

    The payment status of the proposal

  • SentDate type: (nullable) DateTime

    The date/time this proposal was sent

  • ApprovedDate type: (nullable) DateTime

    The date/time this proposal was approved

  • DueDate type: (nullable) DateTime

    The date/time this proposal is due. Mutually exclusive with DueInDays

  • DueInDays type: (nullable) integer

    The number of days from the date this proposal was created in which the proposal is due

  • TaxRate type: (nullable) decimal

    The rate of tax charged for this proposal

  • TaxExempt type: boolean

    True if tax is not applied to this proposal

  • TaxExemptReason type: string

    Reason why this is TaxExempt

  • ShippingHandlingTaxable type: boolean

    True if shipping handling is taxable

  • ExpirationDate type: (nullable) DateTime

    The date on which this proposal expires, if any

  • InHandsDate type: (nullable) DateTime

    The date on which this proposal was received by the customer, if any

  • OrderCreatedDate type: (nullable) DateTime

    The date on which an order was created from this proposal, if any

  • OrderId type: (nullable) integer

    The ID of the order that was created from this proposal

  • OrderProductionStatus type: (nullable) OrderProductionStatus

    The production status of the order that was created from this proposal

  • LostDate type: (nullable) DateTime

    The date on which this proposal was marked as lost

  • Notes type: string

    Notes relating to this proposal

  • Status type: ProposalStatus

    The status of this proposal

  • ApprovalStatus type: ProposalApprovalStatus

    The approval status of this proposal

  • DisplayManufacturerName type: boolean

    True if manufacturer name should be displayed for products on this proposal

  • DisplayManufacturerSku type: boolean

    True if manufacturer SKU should be displayed for products on this proposal

  • ShippingTaxable type: boolean

    True if tax is applied to shipping on this proposal

  • ShippingAddress type: Address

    The shipping Address associated with this order

  • ShippingMethod type: ShippingMethod

    The ShippingMethod associated with this order

  • ShippingAmount type: (nullable) decimal

    The total shipping amount of all items

  • DateCreated type: DateTime

    The date/time this proposal was created

  • CreatedByUserId type: integer

    The ID of the user who created this proposal

  • Modified type: DateTime

    The date/tiem this proposal was last modified

  • ModifiedByUserId type: integer

    The ID of the user who last modified this proposal

  • CustomLineItems type: List of CustomLineItem

    Custom line items associated with this proposal

  • CartItems type: List of ShoppingCartItem

    A list of products associated with this proposal

  • LostReason type: string

    Reason why the proposal was lost

  • LostComment type: string

    An optional comment on a lost proposal

  • ItemQuantity type: integer

    The total quantity of items (cart items + custom line items)

  • PrintCost type: decimal

    The total print cost of all cart items

  • RetailAmount type: decimal

    The total amount of all items (cart items + custom line items), not including tax

  • TaxAmount type: decimal

    The total tax for all items (cart items + custom line items) and shipping

  • TotalAmount type: decimal

    The total price of all items, plus tax

  • ProcessMarkupAmount type: (nullable) decimal

    The process markup amount if any

  • AmountDue type: decimal

    Total amount minus discounts and payments

  • ArchivedDate type: (nullable) DateTime

    The date/time this proposal was archived

  • Timeline type: List of TimelineEntry

    A list of timeline entries for this proposal

  • Views type: List of UserView

    A list of when each user last viewed the proposal

  • Discount type: Discount

    Proposal discount

  • RetailDiscount type: decimal

    The total discount applied to the RetailAmount

  • TotalDiscount type: decimal

    The total discount applied to this order, including coupons and discount codes as well as quantity discounts.

  • PaymentMethod type: string

    The Payment Method Used for the Proposal

  • PaymentToken type: string

    The PayPal Token for the Proposal if any.

  • GroupingJSON type: string

    JSON saved with the proposal, which will have all the sections and grouping.

  • StyleJSON type: string

    JSON saved with the proposal, which will have any style-related properties (eg: background color)

  • ShippingPostCode type: string

    Post code of shipping address for tax

  • PostCodeTaxRate type: (nullable) decimal

    Tax rate calculated based on shipping post code

  • LineItemNotes type: List of LineItemNote

    The list of line item notes for this proposal 


{
  "ID"                        : 1,
  "CartId"                    : 1,
  "Number"                    : "ExampleString",
  "UniqueId"                  : "",
  "Name"                      : "ExampleString",
  "PurchaseOrderNumber"       : "ExampleString",
  "AssigneeId"                : 1,
  "AssigneeName"              : "ExampleString",
  "AssigneeEmail"             : "ExampleString",
  "StoreEmail"                : "ExampleString",
  "StorePhone"                : "ExampleString",
  "PrimaryContactId"          : 1,
  "PrimaryContactName"        : "ExampleString",
  "PrimaryContactEmail"       : "ExampleString",
  "Deleted"                   : "true",
  "DepositAmount"             : 3.14,
  "DepositPercent"            : 3.14,
  "PartialPaymentAllowed"     : "true",
  "Arts"  : 
  [
    {
      "ID"                    : 1,
      "ColorCount"            : 1,
      "Colors"                : ["#FF0000","#FFFFFF","#0000FF"],
      "OriginalColorway"  : 
      {
        "ID"             : 1,
        "Colors"  : 
        [
          {
            "Index"                : 1,
            "Color"                : "ExampleString",
            "EmbroideryThreadId"   : 1,
            "InkColorId"           : 1,
            "ColorName"            : "ExampleString",
            "PMS"                  : "ExampleString"
          }
        ],
        "Name"           : "ExampleString",
        "SvgUrl"         : "ExampleString",
        "RenderedUrl"    : "ExampleString",
        "ThumbnailUrl"   : "ExampleString"
      },
      "StitchCount"           : 1,
      "TrimCount"             : 1,
      "GalleryId"             : 1,
      "CategoryIds"           : [1,2,3],
      "Name"                  : "Business_Designs",
      "Type"                  : "ExampleString",
      "Keywords"              : "pretty,big,black and white,zebra",
      "FixedSvg"              : "true",
      "Digitized"             : "true",
      "CanScreenPrint"        : "true",
      "FullName"              : "store5976/Business/Business_Designs",
      "ExternalReferenceID"   : "ExampleString",
      "Width"                 : 762,
      "Height"                : 538,
      "Notes"                 : "ExampleString",
      "FileExt"               : "png",
      "ImageUrl"              : "ExampleString",
      "ThumbUrl"              : "ExampleString",
      "ThumbUrlAlt"           : "ExampleString",
      "OriginalUrl"           : "ExampleString",
      "UploadedUrl"           : "ExampleString",
      "UploadedOn"            : "2017-10-30T07:00:00Z",
      "IsActive"              : "true",
      "Colorways"  : 
      [
        {
          "ID"             : 1,
          "Colors"  : 
          [
            {
              "Index"                : 1,
              "Color"                : "ExampleString",
              "EmbroideryThreadId"   : 1,
              "InkColorId"           : 1,
              "ColorName"            : "ExampleString",
              "PMS"                  : "ExampleString"
            }
          ],
          "Name"           : "ExampleString",
          "SvgUrl"         : "ExampleString",
          "RenderedUrl"    : "ExampleString",
          "ThumbnailUrl"   : "ExampleString"
        }
      ],
      "UniqueId"              : "",
      "MatchFileColor"        : "true"
    }
  ],
  "Payments"  : 
  [
    {
      "ID"                      : 1000001,
      "OrderId"                 : 1,
      "ProposalId"              : 1,
      "EventType"               : "ExampleString",
      "CardLast4"               : "ExampleString",
      "CardType"                : "ExampleString",
      "ResponseCode"            : "ExampleString",
      "TransactionId"           : "ExampleString",
      "OriginalTransactionId"   : "ExampleString",
      "ApprovalCode"            : "ExampleString",
      "AvsCode"                 : "ExampleString",
      "DateCreated"             : "2017-10-30T07:00:00Z",
      "DateVoided"              : "2017-10-30T07:00:00Z",
      "TestMode"                : "true",
      "GatewayAccount"          : "ExampleString",
      "GiftCertificateId"       : 1,
      "Amount"                  : 3.14,
      "ProcessingFee"           : 3.14,
      "InkSoftFee"              : 3.14,
      "GatewayName"             : "ExampleString",
      "AttachmentFileName"      : "ExampleString",
      "Notes"                   : "ExampleString",
      "BillingAddress"  : 
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      }
    }
  ],
  "PaymentStatus"  : {"Name" : "example not found 2"},
  "SentDate"                  : "2017-10-30T07:00:00Z",
  "ApprovedDate"              : "2017-10-30T07:00:00Z",
  "DueDate"                   : "2017-10-30T07:00:00Z",
  "DueInDays"                 : 1,
  "TaxRate"                   : 3.14,
  "TaxExempt"                 : "true",
  "TaxExemptReason"           : "ExampleString",
  "ShippingHandlingTaxable"   : "true",
  "ExpirationDate"            : "2017-10-30T07:00:00Z",
  "InHandsDate"               : "2017-10-30T07:00:00Z",
  "OrderCreatedDate"          : "2017-10-30T07:00:00Z",
  "OrderId"                   : 1,
  "OrderProductionStatus"     : "",
  "LostDate"                  : "2017-10-30T07:00:00Z",
  "Notes"                     : "ExampleString",
  "Status"  : {"Name" : "example not found 2"},
  "ApprovalStatus"  : {"Name" : "example not found 2"},
  "DisplayManufacturerName"   : "true",
  "DisplayManufacturerSku"    : "true",
  "ShippingTaxable"           : "true",
  "ShippingAddress"  : 
  {
    "ID"                     : 1000014,
    "StateId"                : 4,
    "CountryId"              : 1,
    "Business"               : "true",
    "TaxExempt"              : "true",
    "FirstName"              : "John",
    "LastName"               : "Doe",
    "Name"                   : "John Doe",
    "CompanyName"            : "Doe Co",
    "Street1"                : "1234 Test St",
    "Street2"                : "Suite 500",
    "City"                   : "Albuquerque",
    "State"                  : "NM",
    "StateName"              : "New Mexico",
    "Country"                : "United States",
    "CountryCode"            : "US",
    "Email"                  : "ExampleString",
    "Phone"                  : "480-309-6332",
    "Fax"                    : "480-309-6333",
    "PostCode"               : "87111",
    "POBox"                  : "true",
    "SaveToAddressBook"      : "true",
    "Type"                   : null,
    "TaxId"                  : null,
    "Department"             : "IT, Sales, Marketing",
    "ShowPickupAtCheckout"   : "true",
    "Validated"              : "true or false",
    "IsPrimaryAddress"       : "true",
    "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
  },
  "ShippingMethod"  : 
  {
    "CarrierId"                      : "ExampleString",
    "CarrierEstimatedDeliveryDate"   : "2017-10-30T07:00:00Z",
    "Description"                    : "UPS Ground",
    "ID"                             : 1000019,
    "Name"                           : "Ground",
    "PackageType"                    : "ExampleString",
    "PackageCode"                    : "ExampleString",
    "RateId"                         : "ExampleString",
    "ServiceCode"                    : "ExampleString",
    "ServiceType"                    : "ExampleString",
    "VendorId"                       : 1000001,
    "VendorName"                     : "UPS",
    "VendorType"                     : "UPS",
    "Price"                          : 5.00,
    "AllowBeforeAddressKnown"        : "true",
    "AllowResidential"               : "true",
    "AllowPoBox"                     : "true",
    "AllowCommercial"                : "true",
    "DiscountingEnabled"             : "true",
    "ProcessDays"                    : 2,
    "PromptForCartShipperAccount"    : "true",
    "RequireCartShipperAccount"      : "true",
    "AllowShippingAddress"           : "true",
    "ProcessMarkup"                  : null,
    "PickupSetAtStoreId"             : null,
    "TransitDays_Min"                : 3,
    "TransitDays_Max"                : 5,
    "RtMarkupDollar"                 : null,
    "RtMarkupPercent"                : null,
    "Address"  : 
    {
      "ID"                     : 1000014,
      "StateId"                : 4,
      "CountryId"              : 1,
      "Business"               : "true",
      "TaxExempt"              : "true",
      "FirstName"              : "John",
      "LastName"               : "Doe",
      "Name"                   : "John Doe",
      "CompanyName"            : "Doe Co",
      "Street1"                : "1234 Test St",
      "Street2"                : "Suite 500",
      "City"                   : "Albuquerque",
      "State"                  : "NM",
      "StateName"              : "New Mexico",
      "Country"                : "United States",
      "CountryCode"            : "US",
      "Email"                  : "ExampleString",
      "Phone"                  : "480-309-6332",
      "Fax"                    : "480-309-6333",
      "PostCode"               : "87111",
      "POBox"                  : "true",
      "SaveToAddressBook"      : "true",
      "Type"                   : null,
      "TaxId"                  : null,
      "Department"             : "IT, Sales, Marketing",
      "ShowPickupAtCheckout"   : "true",
      "Validated"              : "true or false",
      "IsPrimaryAddress"       : "true",
      "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
    },
    "PickupNotes"                    : null,
    "PickupDateStart"                : "2017-10-30T07:00:00Z",
    "PickupDateEnd"                  : "2017-10-30T07:00:00Z",
    "OffsetGmt"                      : 7,
    "PickupType"  : {"Name" : "example not found 2"},
    "CalculationType"                : "Weight",
    "ShippingSchedules"  : 
    [{"Name" : "example not found 2"}
    ],
    "IsTaxExempt"                    : "true",
    "SortOrder"                      : 1,
    "ShipToStateIds"                 : [1,2,3],
    "IsDeleted"                      : "true",
    "IsProposalPickup"               : "true"
  },
  "ShippingAmount"            : 3.14,
  "DateCreated"               : "2017-10-30T07:00:00Z",
  "CreatedByUserId"           : 1,
  "Modified"                  : "2017-10-30T07:00:00Z",
  "ModifiedByUserId"          : 1,
  "CustomLineItems"  : 
  [
    {
      "ID"                     : 1,
      "ParentId"               : 1,
      "UniqueId"               : "",
      "Name"                   : "ExampleString",
      "Description"            : "ExampleString",
      "ImageUrl"               : "ExampleString",
      "Taxable"                : "true",
      "TaxRate"                : 3.14,
      "TaxRateOverride"        : 3.14,
      "UnitCost"               : 3.14,
      "UnitPrice"              : 3.14,
      "UnitWeight"             : 3.14,
      "Quantity"               : 1,
      "UnitType"  : {"Name" : "example not found 2"},
      "Active"                 : "true",
      "Size"                   : "ExampleString",
      "Style"                  : "ExampleString",
      "CustomLineItemImages"  : 
      [
        {
          "ID"         : 1,
          "UniqueId"   : "",
          "ImageUrl"   : "ExampleString",
          "Deleted"    : "true"
        }
      ]
    }
  ],
  "CartItems"  : 
  [
    {
      "CartRetailItemId"                     : 1,
      "CartRetailItemSizeId"                 : 1,
      "ProductSku"                           : "ExampleString",
      "ProductName"                          : "ExampleString",
      "AddOns"  : 
      [
        {
          "ID"            : 1,
          "Quantity"      : 1,
          "Name"          : "ExampleString",
          "Description"   : "ExampleString",
          "Price"         : 3.14
        }
      ],
      "ArtId"                                : 1,
      "DesignId"                             : 1,
      "EstimatedProductionDays"              : 1,
      "FullName"                             : "ExampleString",
      "ItemTotal"                            : 3.14,
      "NameNumberValues"  : 
      [
        {
          "RetailItemSizeId"   : 1000000,
          "Name"               : "Bob",
          "Number"             : "32",
          "Quantity"           : 1,
          "Price"              : 32
        }
      ],
      "Notes"                                : "ExampleString",
      "PersonalizationValues"  : 
      [
        {
          "Name"                       : "ExampleString",
          "Value"                      : "ExampleString",
          "Price"                      : 3.14,
          "ProductPersonalizationId"   : 1
        }
      ],
      "PrintCost"                            : 3.14,
      "PrintCostOverride"                    : 3.14,
      "PrintOverridePriceBack"               : 3.14,
      "PrintOverridePriceFront"              : 3.14,
      "PrintOverridePriceSleeveLeft"         : 3.14,
      "PrintOverridePriceSleeveRight"        : 3.14,
      "PrintPriceBack"                       : 3.14,
      "PrintPriceFront"                      : 3.14,
      "PrintPriceSleeveLeft"                 : 3.14,
      "PrintPriceSleeveRight"                : 3.14,
      "PrintSetupCharge"                     : 3.14,
      "PrintSetupOverridePriceBack"          : 3.14,
      "PrintSetupOverridePriceFront"         : 3.14,
      "PrintSetupOverridePriceSleeveLeft"    : 3.14,
      "PrintSetupOverridePriceSleeveRight"   : 3.14,
      "PrintSetupPriceBack"                  : 3.14,
      "PrintSetupPriceFront"                 : 3.14,
      "PrintSetupPriceSleeveLeft"            : 3.14,
      "PrintSetupPriceSleeveRight"           : 3.14,
      "ProductId"                            : 1,
      "ProductPriceEach"                     : 3.14,
      "ProductPriceEachOverride"             : 3.14,
      "ProductStyleId"                       : 1,
      "ProductStyleSizeId"                   : 1,
      "Quantity"                             : 1,
      "QuantityDiscountAmount"               : 3.14,
      "QuantityDiscountPercent"              : 3.14,
      "RetailItemId"                         : 1,
      "RetailItemSizeId"                     : 1,
      "SideColorways"  : 
      [
        {
          "SideId"       : "ExampleString",
          "ColorwayId"   : 1
        }
      ],
      "SidePreviews"  : 
      [
        {
          "SideName"             : "ExampleString",
          "ProductOnlyUrl"       : "ExampleString",
          "DesignOnlyUrl"        : "ExampleString",
          "DesignOnProductUrl"   : "ExampleString",
          "SideArtId"            : 1
        }
      ],
      "TaxRate"                              : 3.14,
      "TaxRateOverride"                      : 3.14,
      "UnitPrice"                            : 3.14,
      "UniqueId"                             : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7"
    }
  ],
  "LostReason"                : "ExampleString",
  "LostComment"               : "ExampleString",
  "ItemQuantity"              : 1,
  "PrintCost"                 : 3.14,
  "RetailAmount"              : 3.14,
  "TaxAmount"                 : 3.14,
  "TotalAmount"               : 3.14,
  "ProcessMarkupAmount"       : 3.14,
  "AmountDue"                 : 3.14,
  "ArchivedDate"              : "2017-10-30T07:00:00Z",
  "Timeline"  : 
  [
    {
      "EventDescription"    : ,
      "ID"                  : 1,
      "ContactIds"          : [1,2,3],
      "CompanyIds"          : [1,2,3],
      "JobIds"              : [1,2,3],
      "OrderIds"            : [1,2,3],
      "ProposalIds"         : [1,2,3],
      "ProductionCardIds"   : [1,2,3],
      "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
      "Event"               : "ExampleString",
      "Comment"             : "ExampleString",
      "EventType"  : {"Name" : "example not found 2"},
      "Edited"              : "true",
      "EditedDate"          : "2017-10-30T07:00:00Z",
      "Deleted"             : "true",
      "DeletedDate"         : "2017-10-30T07:00:00Z",
      "Created"             : "2017-10-30T07:00:00Z",
      "CreatedByUserId"     : 1,
      "CreatedByName"       : "ExampleString",
      "Details"  : 
      [
        {
          "Property"   : "ExampleString",
          "OldValue"   : "ExampleString",
          "NewValue"   : "ExampleString",
          "Date"       : "2017-10-30T07:00:00Z"
        }
      ],
      "Associations"  : {"Name" : "example not found 2"}
    }
  ],
  "Views"  : 
  [
    {
      "UserId"       : 1,
      "LastViewed"   : "2017-10-30T07:00:00Z"
    }
  ],
  "Discount"  : 
  {
    "ID"                       : 100000,
    "CouponCode"               : "sale",
    "Description"              : null,
    "DiscountCode"             : "ExampleString",
    "ExcludeDesigns"           : "ExampleString",
    "ExcludeProducts"          : "ExampleString",
    "ExcludeProductStyles"     : "ExampleString",
    "ExcludeShippingMethods"   : "ExampleString",
    "ExcludeStores"            : "ExampleString",
    "Name"                     : "Promotion",
    "OnlyDesigns"              : "ExampleString",
    "OnlyProducts"             : "ExampleString",
    "OnlyProductStyles"        : "ExampleString",
    "OnlyStores"               : "ExampleString",
    "DiscountItems"            : "true",
    "DiscountShipping"         : "true",
    "DiscountPickup"           : "true",
    "RequiresCoupon"           : "true",
    "DiscountAmount"           : 30.00,
    "DiscountPercent"          : null,
    "MinItemTotal"             : null,
    "MinItemCount"             : "3",
    "EffectiveDate"            : "2017-10-30T07:00:00Z",
    "ExpirationDate"           : "2018-10-30T07:00:00Z",
    "AutomaticDiscount"        : "true"
  },
  "RetailDiscount"            : 3.14,
  "TotalDiscount"             : 3.14,
  "PaymentMethod"             : "ExampleString",
  "PaymentToken"              : "ExampleString",
  "GroupingJSON"              : "ExampleString",
  "StyleJSON"                 : "ExampleString",
  "ShippingPostCode"          : "ExampleString",
  "PostCodeTaxRate"           : 3.14,
  "LineItemNotes"  : 
  [
    {
      "ID"                      : 1000001,
      "OrderId"                 : 1,
      "ProposalId"              : 1,
      "ArtId"                   : 1,
      "DesignId"                : 1,
      "CustomLineItemId"        : 1,
      "ProductStyleId"          : 1,
      "PersonalizationValues"   : "ExampleString",
      "Content"                 : "ExampleString",
      "DateCreated"             : "2017-10-30T07:00:00Z",
      "DateModified"            : "2017-10-30T07:00:00Z",
      "UniqueId"                : "",
      "ItemGuid"                : ""
    }
  ]
}

 

QuantityPackPrice

Properties

  • Quantity type: integer

    Quantity Pack

  • Price type: decimal

    Price for the Quantity Pack

  • Cost type: (nullable) decimal

    Cost for the Quantity Pack 


{
  "Quantity"   : 1,
  "Price"      : 3.14,
  "Cost"       : 3.14
}

 

Rectangle

Properties

  • X type: decimal

  • Y type: decimal

  • Width type: decimal

  • Height type: decimal

  • Rotation type: (nullable) decimal 


{
  "X"          : 3.14,
  "Y"          : 3.14,
  "Width"      : 3.14,
  "Height"     : 3.14,
  "Rotation"   : 3.14
}

 

RenderDesignResult

Properties 

{
  "DesignSummary"  : 
  {
    "DesignID"                   : 1,
    "UserID"                     : 1,
    "UserEmail"                  : "ExampleString",
    "Uri"                        : "ExampleString",
    "DesignedOnSku"              : "ExampleString",
    "DesignedOnStyleName"        : "ExampleString",
    "DesignedOnProductId"        : 1,
    "DesignedOnProductStyleId"   : 1,
    "Canvases"  : 
    [{"Name" : "example not found 2"}
    ],
    "LastModified"               : "2017-10-30T07:00:00Z",
    "Name"                       : "ExampleString",
    "Notes"                      : "ExampleString"
  },
  "ErrorMessage"    : "ExampleString",
  "RenderedFiles"  : 
  [{"Name" : "example not found 2"}
  ],
  "OriginalArt"  : 
  [
    {
      "ID"                    : 1,
      "ColorCount"            : 1,
      "Colors"                : ["#FF0000","#FFFFFF","#0000FF"],
      "OriginalColorway"  : 
      {
        "ID"             : 1,
        "Colors"  : 
        [
          {
            "Index"                : 1,
            "Color"                : "ExampleString",
            "EmbroideryThreadId"   : 1,
            "InkColorId"           : 1,
            "ColorName"            : "ExampleString",
            "PMS"                  : "ExampleString"
          }
        ],
        "Name"           : "ExampleString",
        "SvgUrl"         : "ExampleString",
        "RenderedUrl"    : "ExampleString",
        "ThumbnailUrl"   : "ExampleString"
      },
      "StitchCount"           : 1,
      "TrimCount"             : 1,
      "GalleryId"             : 1,
      "CategoryIds"           : [1,2,3],
      "Name"                  : "Business_Designs",
      "Type"                  : "ExampleString",
      "Keywords"              : "pretty,big,black and white,zebra",
      "FixedSvg"              : "true",
      "Digitized"             : "true",
      "CanScreenPrint"        : "true",
      "FullName"              : "store5976/Business/Business_Designs",
      "ExternalReferenceID"   : "ExampleString",
      "Width"                 : 762,
      "Height"                : 538,
      "Notes"                 : "ExampleString",
      "FileExt"               : "png",
      "ImageUrl"              : "ExampleString",
      "ThumbUrl"              : "ExampleString",
      "ThumbUrlAlt"           : "ExampleString",
      "OriginalUrl"           : "ExampleString",
      "UploadedUrl"           : "ExampleString",
      "UploadedOn"            : "2017-10-30T07:00:00Z",
      "IsActive"              : "true",
      "Colorways"  : 
      [
        {
          "ID"             : 1,
          "Colors"  : 
          [
            {
              "Index"                : 1,
              "Color"                : "ExampleString",
              "EmbroideryThreadId"   : 1,
              "InkColorId"           : 1,
              "ColorName"            : "ExampleString",
              "PMS"                  : "ExampleString"
            }
          ],
          "Name"           : "ExampleString",
          "SvgUrl"         : "ExampleString",
          "RenderedUrl"    : "ExampleString",
          "ThumbnailUrl"   : "ExampleString"
        }
      ],
      "UniqueId"              : "",
      "MatchFileColor"        : "true"
    }
  ]
}

 

SerializableDictionary

A dictionary that can be serialized into XML and JSON

Properties 

{
  "Item"  : {"Name" : "example not found 2"}
}

 

Session

A user session

Properties

  • DateCreated type: DateTime

    The date this session was created

  • LastAccess type: DateTime

    The date this session was last accessed

  • Email type: string

    The email of the user this session belongs to

  • FirstName type: string

    The first name of the user this session belongs to

  • LastName type: string

    The last name of the user this session belongs to

  • IpAddress type: string

    This IP address of this session

  • Token type: string

    The GUID token of this session. Used in most methods instead of session ID because token is non-sequential

  • ParentId type: (nullable) integer

    The ID of the parent session, if present

  • ID type: integer

    The ID of this session

  • UserId type: (nullable) integer

    The ID of the user this session belongs to

  • UserRole type: string

    The Role of the user this session belongs to, if this user is an admin. One of: publisher_admin, publisher_manager, publisher_printer, product_manager, store_manager

  • StoreId type: (nullable) integer

    Deprecated - this is always null.

  • StoreUri type: string

    The Uri of the store this user was created on

  • Newsletter type: boolean

    True if the user has opted to receive the InkSoft newsletter

  • HasGiftCertificates type: boolean

    True if the user has gift certificates available for use

  • AllowPurchaseOrders type: boolean

    Allow the user to use purchase orders regardless of shop settings

  • AllowStoreAnalytics type: boolean

    True if the feature flag for client analytics is on, if it's included in the publisher's license, and if the user has a role that allows them to view store analytics.

  • AllowArrangePaymentLater type: boolean

    Allow the user to arrange payment later regardless of shop settings

  • TierUniqueId type: (nullable) guid

    The Guid of the user tier 


{
  "DateCreated"                : "2017-10-30T07:00:00Z",
  "LastAccess"                 : "2017-10-30T07:00:00Z",
  "Email"                      : "john.doe@inksoft.com",
  "FirstName"                  : "John",
  "LastName"                   : "Doe",
  "IpAddress"                  : "23.104.22.120",
  "Token"                      : "F4B0400C-B6E4-49E0-872B-20F7102F8245",
  "ParentId"                   : 10000000,
  "ID"                         : 10000001,
  "UserId"                     : 10000001,
  "UserRole"                   : "store_manager",
  "StoreId"                    : 3321,
  "StoreUri"                   : "johns_fancy_shirts",
  "Newsletter"                 : "true",
  "HasGiftCertificates"        : "true",
  "AllowPurchaseOrders"        : "true",
  "AllowStoreAnalytics"        : "true",
  "AllowArrangePaymentLater"   : "true",
  "TierUniqueId"               : ""
}

 

SessionData

Data related to a [Object:Session]

Properties

  • Email type: string

    The email associated with the current session

  • Token type: string

    The current session token

  • UserRole type: string

    The role of the user associated with the current session

  • IsAdmin type: boolean

    True if the user associated with this session is an admin

  • UserId type: (nullable) integer

    The ID of the user associated with the current session

  • AllowPurchaseOrders type: boolean

    Allow the user to use purchase orders regardless of shop settings

  • AllowArrangePaymentLater type: boolean

    Allow the user to arrange payment later regardless of shop settings

  • Newsletter type: boolean

    True if the user has chosen to receive the newsletter

  • HasGiftCertificates type: boolean

    True if the user has one or more gift certificates 


{
  "Email"                      : "ExampleString",
  "Token"                      : "ExampleString",
  "UserRole"                   : "ExampleString",
  "IsAdmin"                    : "true",
  "UserId"                     : 1,
  "AllowPurchaseOrders"        : "true",
  "AllowArrangePaymentLater"   : "true",
  "Newsletter"                 : "true",
  "HasGiftCertificates"        : "true"
}

 

ShippingMethod

A shipping method or pickup location

Properties

  • CarrierId type: string

    The carrier id associated to the carrier in the external shipping system

  • CarrierEstimatedDeliveryDate type: (nullable) DateTime

    This is the estimated delivery date provided by the ShipEngine Carrier (As if it were being shipped out today. This does not include any internal processing times)

  • Description type: string

    A description of this shipping method

  • ID type: integer

    The unique integer ID of this shipping method

  • Name type: string

    The name of this shipping method in the Shipping Configuration (eg. First Class 10% Rush)

  • PackageType type: string

    The package type user friendly name provided by the carrier from the External Shipping API

  • PackageCode type: string

    The package type code provided by the carrier from the External Shipping API.

  • RateId type: string

    This is the RateId returned from ShipEngine for a specific shipping option/method

  • ServiceCode type: string

    This service code is returned from the external shipping API when getting rates. It needs to be kept and passed in when creating shipping labels

  • ServiceType type: string

    The name of the service type from the carrier (eg. First Class Mail Package)

  • VendorId type: integer

    The ID of the shipping vendor associated with this method

  • VendorName type: string

    The name of the vendor associated with this method

  • VendorType type: string

    The type of the vendor associated with this method (often the same as vendor name)

  • Price type: (nullable) decimal

    The cost of shipping the contents of the cart via this method

  • AllowBeforeAddressKnown type: boolean

    True if this method can be selected before the shipping address is known

  • AllowResidential type: boolean

    True if this method can be used to ship to a residential address

  • AllowPoBox type: boolean

    True if this method can be used to ship to a PO box

  • AllowCommercial type: boolean

    True if this method can be used to ship to a commercial address

  • DiscountingEnabled type: boolean

    True if a shipping Discount can be applied to this method

  • ProcessDays type: (nullable) integer

    The number of processing days required for this method (the number of days between when the order is placed and when the order ships)

  • PromptForCartShipperAccount type: boolean

    True if we should prompt the user for a shipper account during checkout when this method is selected

  • RequireCartShipperAccount type: boolean

    True if the user must provide a shipper account during checkout when this method is selected

  • AllowShippingAddress type: boolean

    True if a shipping address is allowed with this method

  • ProcessMarkup type: (nullable) integer

    The markup to be applied to the cost of processing an order using this method

  • PickupSetAtStoreId type: (nullable) integer

    True if this is a pickup location assigned to a store. Pickup locations are store-specific. If this value is set, this method is a pickup method and should not be displayed at any store other than the store indicated here

  • TransitDays_Min type: (nullable) integer

    The minimum number of days required to deliver an order once shipped via this method

  • TransitDays_Max type: (nullable) integer

    The maximum number of days required to deliver an order once shipped via this method

  • RtMarkupDollar type: (nullable) decimal

    The markup amount in dollars to be applied to this method

  • RtMarkupPercent type: (nullable) integer

    The markup amount (as a percent) to be applied to this method

  • Address type: Address

    The address associated with this method, if it is a pickup location

  • PickupNotes type: string

    Instructions for pickup, if this is a pickup location

  • PickupDateStart type: (nullable) DateTime

    The start of the pickup date range, if this is a pickup location

  • PickupDateEnd type: (nullable) DateTime

    The end of the pickup date range, if this is a pickup location

  • OffsetGmt type: (nullable) integer

    The offset of the pickup date time range, if this is a pickup location

  • PickupType type: PickupType

    The pickup type constrained to the enum, if this is a pickup location

  • CalculationType type: char

    The type of calculation to be used when determining the price of this shipping method (W indicates 'weight')

  • ShippingSchedules type: List of ShippingSchedule

    Contains pricing information based on Quantity, Weight or Price

  • IsTaxExempt type: boolean

  • SortOrder type: (nullable) integer

    The sort order to be used when displaying with other shipping methods (if any)

  • ShipToStateIds type: List of integer

    A list of State IDs this method can ship to

  • IsDeleted type: boolean

    Returns if the shipping method is deleted. NOTE: The current save functionality does not support passing this field in!

  • IsProposalPickup type: boolean

    True if this pickup location can be reused on other proposals. 


{
  "CarrierId"                      : "ExampleString",
  "CarrierEstimatedDeliveryDate"   : "2017-10-30T07:00:00Z",
  "Description"                    : "UPS Ground",
  "ID"                             : 1000019,
  "Name"                           : "Ground",
  "PackageType"                    : "ExampleString",
  "PackageCode"                    : "ExampleString",
  "RateId"                         : "ExampleString",
  "ServiceCode"                    : "ExampleString",
  "ServiceType"                    : "ExampleString",
  "VendorId"                       : 1000001,
  "VendorName"                     : "UPS",
  "VendorType"                     : "UPS",
  "Price"                          : 5.00,
  "AllowBeforeAddressKnown"        : "true",
  "AllowResidential"               : "true",
  "AllowPoBox"                     : "true",
  "AllowCommercial"                : "true",
  "DiscountingEnabled"             : "true",
  "ProcessDays"                    : 2,
  "PromptForCartShipperAccount"    : "true",
  "RequireCartShipperAccount"      : "true",
  "AllowShippingAddress"           : "true",
  "ProcessMarkup"                  : null,
  "PickupSetAtStoreId"             : null,
  "TransitDays_Min"                : 3,
  "TransitDays_Max"                : 5,
  "RtMarkupDollar"                 : null,
  "RtMarkupPercent"                : null,
  "Address"  : 
  {
    "ID"                     : 1000014,
    "StateId"                : 4,
    "CountryId"              : 1,
    "Business"               : "true",
    "TaxExempt"              : "true",
    "FirstName"              : "John",
    "LastName"               : "Doe",
    "Name"                   : "John Doe",
    "CompanyName"            : "Doe Co",
    "Street1"                : "1234 Test St",
    "Street2"                : "Suite 500",
    "City"                   : "Albuquerque",
    "State"                  : "NM",
    "StateName"              : "New Mexico",
    "Country"                : "United States",
    "CountryCode"            : "US",
    "Email"                  : "ExampleString",
    "Phone"                  : "480-309-6332",
    "Fax"                    : "480-309-6333",
    "PostCode"               : "87111",
    "POBox"                  : "true",
    "SaveToAddressBook"      : "true",
    "Type"                   : null,
    "TaxId"                  : null,
    "Department"             : "IT, Sales, Marketing",
    "ShowPickupAtCheckout"   : "true",
    "Validated"              : "true or false",
    "IsPrimaryAddress"       : "true",
    "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
  },
  "PickupNotes"                    : null,
  "PickupDateStart"                : "2017-10-30T07:00:00Z",
  "PickupDateEnd"                  : "2017-10-30T07:00:00Z",
  "OffsetGmt"                      : 7,
  "PickupType"  : {"Name" : "example not found 2"},
  "CalculationType"                : "Weight",
  "ShippingSchedules"  : 
  [{"Name" : "example not found 2"}
  ],
  "IsTaxExempt"                    : "true",
  "SortOrder"                      : 1,
  "ShipToStateIds"                 : [1,2,3],
  "IsDeleted"                      : "true",
  "IsProposalPickup"               : "true"
}

 

ShoppingCart

A shopping cart, containing [Object:ShoppingCartItem]s the user has added for purchase

Properties

  • ID type: integer

    A unique integer ID for this shopping cart, assigned when saved to the database. A value of -1 indicates this ShoppingCart has not yet been saved to the database.

  • SessionToken type: string

    The session token associated with this cart

  • CartRequestId type: string

    Deprecated in SalesDoc - A string that can be used to match a cart with a particualr AJAX request, if many requests are occuring within a small window of time

  • DefaultCountryId type: integer

    Deprecated in SalesDoc - The ID of the default country for this cart

  • CartItemWeight type: decimal

    Deprecated in SalesDoc - The total weight of all items in the cart

  • TotalDue type: decimal

    The total amount due after tax and discounts have been applied

  • DiscountRetail type: decimal

    The total discount to be applied to the retail total of items added to the cart

  • DiscountShipping type: decimal

    The total discount to be applied to the shipping price

  • DiscountTax type: decimal

    Deprecated in SalesDoc - The total discount to be applied to the tax

  • DiscountTotal type: decimal

    The total of all discounts to be applied to this cart/order

  • QuantityDiscountAmount type: decimal

    The total quantity discount applied to this cart/order

  • QuantityDiscountTax type: decimal

    Deprecated in SalesDoc - The total quantity discount applied to the tax

  • QuantityPricingPercentDiscount type: decimal

    Deprecated in SalesDoc - The total quantity pricing percent discount applied to this cart/order

  • ProcessMarkup type: integer

    Deprecated in SalesDoc - The process markup applied to this cart/order

  • ProcessMarkupAmount type: decimal

    The process markup amount applied to this cart/order

  • TaxAmount type: decimal

    The total amount of tax to be collected for this cart/order

  • ItemTotal type: decimal

    The total retail amount of all items included in this cart/order

  • ShippingAmount type: decimal

    The total shipping amount to be charged for this cart/order

  • Discount type: Discount

    The Discount being applied to this order (if any)

  • ItemCount type: integer

    The number of items included in this order

  • CanCheckout type: boolean

    True if the user can check out with this cart (all required information has been saved)

  • ValidationMessage type: string

    Deprecated in SalesDoc - A validation message related to this cart. If a validation error occurs during checkout, this value will be set and should be displayed to the user

  • GiftCertificates type: List of GiftCertificate

    A list of gift certificates being applied to this cart/order

  • Items type: List of ShoppingCartItem

    A list of ShoppingCartItems included in this cart

  • NameNumberSettings type: List of NameNumberSettingGroup

    Deprecated in SalesDoc - A list of NameNumberSettingGroups that apply to items in this cart

  • ShippingAddress type: Address

    The customer's shipping address

  • BillingAddress type: Address

    The customer's billing address

  • ShippingMethod type: ShippingMethod

    The ShippingMethod selected by the customer

  • GuestEmail type: string

    The e-mail address saved for "checkout as guest"

  • GuestFirstName type: string

    The first name saved for "checkout as guest"

  • GuestLastName type: string

    The last name saved for "checkout as guest"

  • GiftMessage type: string

    The gift message entered by the customer, if any

  • TierId type: (nullable) integer

    Tier ID for the user special pricing

  • ValidationErrors type: List of CartValidationMessage

    A detailed list of validation errors for each item in the cart (discontinued, out of stock, etc.) so errors can be specific to a particular item rather than only the cart.

  • CheckoutFieldValues type: SerializableDictionary

    The checkout fields optionally defined by the store and entered by the customer at checkout 


{
  "ID"                               : 1,
  "SessionToken"                     : "ExampleString",
  "CartRequestId"                    : "ExampleString",
  "DefaultCountryId"                 : 1,
  "CartItemWeight"                   : 3.14,
  "TotalDue"                         : 3.14,
  "DiscountRetail"                   : 3.14,
  "DiscountShipping"                 : 3.14,
  "DiscountTax"                      : 3.14,
  "DiscountTotal"                    : 3.14,
  "QuantityDiscountAmount"           : 3.14,
  "QuantityDiscountTax"              : 3.14,
  "QuantityPricingPercentDiscount"   : 3.14,
  "ProcessMarkup"                    : 1,
  "ProcessMarkupAmount"              : 3.14,
  "TaxAmount"                        : 3.14,
  "ItemTotal"                        : 3.14,
  "ShippingAmount"                   : 3.14,
  "Discount"  : 
  {
    "ID"                       : 100000,
    "CouponCode"               : "sale",
    "Description"              : null,
    "DiscountCode"             : "ExampleString",
    "ExcludeDesigns"           : "ExampleString",
    "ExcludeProducts"          : "ExampleString",
    "ExcludeProductStyles"     : "ExampleString",
    "ExcludeShippingMethods"   : "ExampleString",
    "ExcludeStores"            : "ExampleString",
    "Name"                     : "Promotion",
    "OnlyDesigns"              : "ExampleString",
    "OnlyProducts"             : "ExampleString",
    "OnlyProductStyles"        : "ExampleString",
    "OnlyStores"               : "ExampleString",
    "DiscountItems"            : "true",
    "DiscountShipping"         : "true",
    "DiscountPickup"           : "true",
    "RequiresCoupon"           : "true",
    "DiscountAmount"           : 30.00,
    "DiscountPercent"          : null,
    "MinItemTotal"             : null,
    "MinItemCount"             : "3",
    "EffectiveDate"            : "2017-10-30T07:00:00Z",
    "ExpirationDate"           : "2018-10-30T07:00:00Z",
    "AutomaticDiscount"        : "true"
  },
  "ItemCount"                        : 1,
  "CanCheckout"                      : "true",
  "ValidationMessage"                : "ExampleString",
  "GiftCertificates"  : 
  [
    {
      "Amount"                  : 34.00,
      "AppliedAmount"           : 34.00,
      "InitialPurchaseAmount"   : 3.14,
      "Created"                 : "2017-10-30T07:00:00Z",
      "DateSent"                : "2017-10-30T07:00:00Z",
      "HasOrders"               : "true",
      "Number"                  : "CA77-EE66-GD6C-4E44",
      "ToName"                  : "John Doe",
      "ToEmail"                 : "John Doe"
    }
  ],
  "Items"  : 
  [
    {
      "CartRetailItemId"                     : 1,
      "CartRetailItemSizeId"                 : 1,
      "ProductSku"                           : "ExampleString",
      "ProductName"                          : "ExampleString",
      "AddOns"  : 
      [
        {
          "ID"            : 1,
          "Quantity"      : 1,
          "Name"          : "ExampleString",
          "Description"   : "ExampleString",
          "Price"         : 3.14
        }
      ],
      "ArtId"                                : 1,
      "DesignId"                             : 1,
      "EstimatedProductionDays"              : 1,
      "FullName"                             : "ExampleString",
      "ItemTotal"                            : 3.14,
      "NameNumberValues"  : 
      [
        {
          "RetailItemSizeId"   : 1000000,
          "Name"               : "Bob",
          "Number"             : "32",
          "Quantity"           : 1,
          "Price"              : 32
        }
      ],
      "Notes"                                : "ExampleString",
      "PersonalizationValues"  : 
      [
        {
          "Name"                       : "ExampleString",
          "Value"                      : "ExampleString",
          "Price"                      : 3.14,
          "ProductPersonalizationId"   : 1
        }
      ],
      "PrintCost"                            : 3.14,
      "PrintCostOverride"                    : 3.14,
      "PrintOverridePriceBack"               : 3.14,
      "PrintOverridePriceFront"              : 3.14,
      "PrintOverridePriceSleeveLeft"         : 3.14,
      "PrintOverridePriceSleeveRight"        : 3.14,
      "PrintPriceBack"                       : 3.14,
      "PrintPriceFront"                      : 3.14,
      "PrintPriceSleeveLeft"                 : 3.14,
      "PrintPriceSleeveRight"                : 3.14,
      "PrintSetupCharge"                     : 3.14,
      "PrintSetupOverridePriceBack"          : 3.14,
      "PrintSetupOverridePriceFront"         : 3.14,
      "PrintSetupOverridePriceSleeveLeft"    : 3.14,
      "PrintSetupOverridePriceSleeveRight"   : 3.14,
      "PrintSetupPriceBack"                  : 3.14,
      "PrintSetupPriceFront"                 : 3.14,
      "PrintSetupPriceSleeveLeft"            : 3.14,
      "PrintSetupPriceSleeveRight"           : 3.14,
      "ProductId"                            : 1,
      "ProductPriceEach"                     : 3.14,
      "ProductPriceEachOverride"             : 3.14,
      "ProductStyleId"                       : 1,
      "ProductStyleSizeId"                   : 1,
      "Quantity"                             : 1,
      "QuantityDiscountAmount"               : 3.14,
      "QuantityDiscountPercent"              : 3.14,
      "RetailItemId"                         : 1,
      "RetailItemSizeId"                     : 1,
      "SideColorways"  : 
      [
        {
          "SideId"       : "ExampleString",
          "ColorwayId"   : 1
        }
      ],
      "SidePreviews"  : 
      [
        {
          "SideName"             : "ExampleString",
          "ProductOnlyUrl"       : "ExampleString",
          "DesignOnlyUrl"        : "ExampleString",
          "DesignOnProductUrl"   : "ExampleString",
          "SideArtId"            : 1
        }
      ],
      "TaxRate"                              : 3.14,
      "TaxRateOverride"                      : 3.14,
      "UnitPrice"                            : 3.14,
      "UniqueId"                             : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7"
    }
  ],
  "NameNumberSettings"  : 
  [
    {
      "Name"  : 
      {
        "FontId"      : 1,
        "Size"        : "12",
        "Color"       : "FF0000",
        "ColorName"   : "Red"
      },
      "Number"  : 
      {
        "FontId"      : 1,
        "Size"        : "12",
        "Color"       : "FF0000",
        "ColorName"   : "Red"
      },
      "ProductStyleId"     : 1000001,
      "ArtId"              : null,
      "DesignId"           : null,
      "CartRetailItemId"   : 1000013,
      "PrintCost"          : null
    }
  ],
  "ShippingAddress"  : 
  {
    "ID"                     : 1000014,
    "StateId"                : 4,
    "CountryId"              : 1,
    "Business"               : "true",
    "TaxExempt"              : "true",
    "FirstName"              : "John",
    "LastName"               : "Doe",
    "Name"                   : "John Doe",
    "CompanyName"            : "Doe Co",
    "Street1"                : "1234 Test St",
    "Street2"                : "Suite 500",
    "City"                   : "Albuquerque",
    "State"                  : "NM",
    "StateName"              : "New Mexico",
    "Country"                : "United States",
    "CountryCode"            : "US",
    "Email"                  : "ExampleString",
    "Phone"                  : "480-309-6332",
    "Fax"                    : "480-309-6333",
    "PostCode"               : "87111",
    "POBox"                  : "true",
    "SaveToAddressBook"      : "true",
    "Type"                   : null,
    "TaxId"                  : null,
    "Department"             : "IT, Sales, Marketing",
    "ShowPickupAtCheckout"   : "true",
    "Validated"              : "true or false",
    "IsPrimaryAddress"       : "true",
    "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
  },
  "BillingAddress"  : 
  {
    "ID"                     : 1000014,
    "StateId"                : 4,
    "CountryId"              : 1,
    "Business"               : "true",
    "TaxExempt"              : "true",
    "FirstName"              : "John",
    "LastName"               : "Doe",
    "Name"                   : "John Doe",
    "CompanyName"            : "Doe Co",
    "Street1"                : "1234 Test St",
    "Street2"                : "Suite 500",
    "City"                   : "Albuquerque",
    "State"                  : "NM",
    "StateName"              : "New Mexico",
    "Country"                : "United States",
    "CountryCode"            : "US",
    "Email"                  : "ExampleString",
    "Phone"                  : "480-309-6332",
    "Fax"                    : "480-309-6333",
    "PostCode"               : "87111",
    "POBox"                  : "true",
    "SaveToAddressBook"      : "true",
    "Type"                   : null,
    "TaxId"                  : null,
    "Department"             : "IT, Sales, Marketing",
    "ShowPickupAtCheckout"   : "true",
    "Validated"              : "true or false",
    "IsPrimaryAddress"       : "true",
    "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
  },
  "ShippingMethod"  : 
  {
    "CarrierId"                      : "ExampleString",
    "CarrierEstimatedDeliveryDate"   : "2017-10-30T07:00:00Z",
    "Description"                    : "UPS Ground",
    "ID"                             : 1000019,
    "Name"                           : "Ground",
    "PackageType"                    : "ExampleString",
    "PackageCode"                    : "ExampleString",
    "RateId"                         : "ExampleString",
    "ServiceCode"                    : "ExampleString",
    "ServiceType"                    : "ExampleString",
    "VendorId"                       : 1000001,
    "VendorName"                     : "UPS",
    "VendorType"                     : "UPS",
    "Price"                          : 5.00,
    "AllowBeforeAddressKnown"        : "true",
    "AllowResidential"               : "true",
    "AllowPoBox"                     : "true",
    "AllowCommercial"                : "true",
    "DiscountingEnabled"             : "true",
    "ProcessDays"                    : 2,
    "PromptForCartShipperAccount"    : "true",
    "RequireCartShipperAccount"      : "true",
    "AllowShippingAddress"           : "true",
    "ProcessMarkup"                  : null,
    "PickupSetAtStoreId"             : null,
    "TransitDays_Min"                : 3,
    "TransitDays_Max"                : 5,
    "RtMarkupDollar"                 : null,
    "RtMarkupPercent"                : null,
    "Address"  : 
    {
      "ID"                     : 1000014,
      "StateId"                : 4,
      "CountryId"              : 1,
      "Business"               : "true",
      "TaxExempt"              : "true",
      "FirstName"              : "John",
      "LastName"               : "Doe",
      "Name"                   : "John Doe",
      "CompanyName"            : "Doe Co",
      "Street1"                : "1234 Test St",
      "Street2"                : "Suite 500",
      "City"                   : "Albuquerque",
      "State"                  : "NM",
      "StateName"              : "New Mexico",
      "Country"                : "United States",
      "CountryCode"            : "US",
      "Email"                  : "ExampleString",
      "Phone"                  : "480-309-6332",
      "Fax"                    : "480-309-6333",
      "PostCode"               : "87111",
      "POBox"                  : "true",
      "SaveToAddressBook"      : "true",
      "Type"                   : null,
      "TaxId"                  : null,
      "Department"             : "IT, Sales, Marketing",
      "ShowPickupAtCheckout"   : "true",
      "Validated"              : "true or false",
      "IsPrimaryAddress"       : "true",
      "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
    },
    "PickupNotes"                    : null,
    "PickupDateStart"                : "2017-10-30T07:00:00Z",
    "PickupDateEnd"                  : "2017-10-30T07:00:00Z",
    "OffsetGmt"                      : 7,
    "PickupType"  : {"Name" : "example not found 2"},
    "CalculationType"                : "Weight",
    "ShippingSchedules"  : 
    [{"Name" : "example not found 2"}
    ],
    "IsTaxExempt"                    : "true",
    "SortOrder"                      : 1,
    "ShipToStateIds"                 : [1,2,3],
    "IsDeleted"                      : "true",
    "IsProposalPickup"               : "true"
  },
  "GuestEmail"                       : "ExampleString",
  "GuestFirstName"                   : "ExampleString",
  "GuestLastName"                    : "ExampleString",
  "GiftMessage"                      : "ExampleString",
  "TierId"                           : 1,
  "ValidationErrors"  : 
  [{"Name" : "example not found 2"}
  ],
  "CheckoutFieldValues"  : 
  {
    "Item"  : {"Name" : "example not found 2"}
  }
}

 

ShoppingCartItem

A list of items included in a [Object:ShoppingCart] Each item contains a unique combination of [ProductStyleSizeId] + [ArtId/DesignId] + [PersonalizationValues]

Properties

  • CartRetailItemId type: integer

    The ID of the server-side cart_retail_item to which this item corresponds (not a one-to-one relationship)

  • CartRetailItemSizeId type: integer

    The ID of the server-side cart_retail_item_size to which this item corresponds (there may be multiple items in the Cart that share this value, each with different PersonalizationValues or NameNumberValues)

  • ProductSku type: string

    The Sku of the product included in this item

  • ProductName type: string

    The Name of the product included in this item

  • AddOns type: List of ShoppingCartItemAddOn

  • ArtId type: (nullable) integer

  • DesignId type: (nullable) integer

  • EstimatedProductionDays type: (nullable) integer

  • FullName type: string

  • ItemTotal type: decimal

  • NameNumberValues type: List of NameNumberValue

  • Notes type: string

  • PersonalizationValues type: List of PersonalizationValue

  • PrintCost type: (nullable) decimal

  • PrintCostOverride type: (nullable) decimal

  • PrintOverridePriceBack type: (nullable) decimal

  • PrintOverridePriceFront type: (nullable) decimal

  • PrintOverridePriceSleeveLeft type: (nullable) decimal

  • PrintOverridePriceSleeveRight type: (nullable) decimal

  • PrintPriceBack type: (nullable) decimal

  • PrintPriceFront type: (nullable) decimal

  • PrintPriceSleeveLeft type: (nullable) decimal

  • PrintPriceSleeveRight type: (nullable) decimal

  • PrintSetupCharge type: (nullable) decimal

  • PrintSetupOverridePriceBack type: (nullable) decimal

  • PrintSetupOverridePriceFront type: (nullable) decimal

  • PrintSetupOverridePriceSleeveLeft type: (nullable) decimal

  • PrintSetupOverridePriceSleeveRight type: (nullable) decimal

  • PrintSetupPriceBack type: (nullable) decimal

  • PrintSetupPriceFront type: (nullable) decimal

  • PrintSetupPriceSleeveLeft type: (nullable) decimal

  • PrintSetupPriceSleeveRight type: (nullable) decimal

  • ProductId type: integer

  • ProductPriceEach type: (nullable) decimal

  • ProductPriceEachOverride type: (nullable) decimal

  • ProductStyleId type: integer

  • ProductStyleSizeId type: integer

  • Quantity type: integer

  • QuantityDiscountAmount type: (nullable) decimal

  • QuantityDiscountPercent type: (nullable) decimal

  • RetailItemId type: integer

  • RetailItemSizeId type: integer

  • SideColorways type: List of SideColorway

  • SidePreviews type: List of ShoppingCartItemPreview

  • TaxRate type: (nullable) decimal

  • TaxRateOverride type: (nullable) decimal

  • UnitPrice type: decimal

  • UniqueId type: guid 


{
  "CartRetailItemId"                     : 1,
  "CartRetailItemSizeId"                 : 1,
  "ProductSku"                           : "ExampleString",
  "ProductName"                          : "ExampleString",
  "AddOns"  : 
  [
    {
      "ID"            : 1,
      "Quantity"      : 1,
      "Name"          : "ExampleString",
      "Description"   : "ExampleString",
      "Price"         : 3.14
    }
  ],
  "ArtId"                                : 1,
  "DesignId"                             : 1,
  "EstimatedProductionDays"              : 1,
  "FullName"                             : "ExampleString",
  "ItemTotal"                            : 3.14,
  "NameNumberValues"  : 
  [
    {
      "RetailItemSizeId"   : 1000000,
      "Name"               : "Bob",
      "Number"             : "32",
      "Quantity"           : 1,
      "Price"              : 32
    }
  ],
  "Notes"                                : "ExampleString",
  "PersonalizationValues"  : 
  [
    {
      "Name"                       : "ExampleString",
      "Value"                      : "ExampleString",
      "Price"                      : 3.14,
      "ProductPersonalizationId"   : 1
    }
  ],
  "PrintCost"                            : 3.14,
  "PrintCostOverride"                    : 3.14,
  "PrintOverridePriceBack"               : 3.14,
  "PrintOverridePriceFront"              : 3.14,
  "PrintOverridePriceSleeveLeft"         : 3.14,
  "PrintOverridePriceSleeveRight"        : 3.14,
  "PrintPriceBack"                       : 3.14,
  "PrintPriceFront"                      : 3.14,
  "PrintPriceSleeveLeft"                 : 3.14,
  "PrintPriceSleeveRight"                : 3.14,
  "PrintSetupCharge"                     : 3.14,
  "PrintSetupOverridePriceBack"          : 3.14,
  "PrintSetupOverridePriceFront"         : 3.14,
  "PrintSetupOverridePriceSleeveLeft"    : 3.14,
  "PrintSetupOverridePriceSleeveRight"   : 3.14,
  "PrintSetupPriceBack"                  : 3.14,
  "PrintSetupPriceFront"                 : 3.14,
  "PrintSetupPriceSleeveLeft"            : 3.14,
  "PrintSetupPriceSleeveRight"           : 3.14,
  "ProductId"                            : 1,
  "ProductPriceEach"                     : 3.14,
  "ProductPriceEachOverride"             : 3.14,
  "ProductStyleId"                       : 1,
  "ProductStyleSizeId"                   : 1,
  "Quantity"                             : 1,
  "QuantityDiscountAmount"               : 3.14,
  "QuantityDiscountPercent"              : 3.14,
  "RetailItemId"                         : 1,
  "RetailItemSizeId"                     : 1,
  "SideColorways"  : 
  [
    {
      "SideId"       : "ExampleString",
      "ColorwayId"   : 1
    }
  ],
  "SidePreviews"  : 
  [
    {
      "SideName"             : "ExampleString",
      "ProductOnlyUrl"       : "ExampleString",
      "DesignOnlyUrl"        : "ExampleString",
      "DesignOnProductUrl"   : "ExampleString",
      "SideArtId"            : 1
    }
  ],
  "TaxRate"                              : 3.14,
  "TaxRateOverride"                      : 3.14,
  "UnitPrice"                            : 3.14,
  "UniqueId"                             : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7"
}

 

ShoppingCartItemAddOn

An add-on to be applied to a [Object:ShoppingCartItem]

Properties

  • ID type: integer

    The unique integer ID of this add-on

  • Quantity type: integer

    The quantity of this add-on

  • Name type: string

    The name of this add-on

  • Description type: string

    The description of this add-on

  • Price type: decimal

    The price of this add-on 


{
  "ID"            : 1,
  "Quantity"      : 1,
  "Name"          : "ExampleString",
  "Description"   : "ExampleString",
  "Price"         : 3.14
}

 

ShoppingCartItemPreview

A preview for a [Object:ShoppingCartItem]

Properties

  • SideName type: string

    The name of the side this preview represents

  • ProductOnlyUrl type: string

    The URL of a preview of the product only (no design)

  • DesignOnlyUrl type: string

    The URL of a preview of the design only (no product)

  • DesignOnProductUrl type: string

    The URL of a preview of the design on the product

  • SideArtId type: (nullable) integer

    The ID of the art that appears on the side of the product 


{
  "SideName"             : "ExampleString",
  "ProductOnlyUrl"       : "ExampleString",
  "DesignOnlyUrl"        : "ExampleString",
  "DesignOnProductUrl"   : "ExampleString",
  "SideArtId"            : 1
}

 

ShoppingCartPackage

A ShoppingCart with supporting data. Inherits from [Object:RetailPackage]

Properties 

{
  "Cart"  : 
  {
    "ID"                               : 1,
    "SessionToken"                     : "ExampleString",
    "CartRequestId"                    : "ExampleString",
    "DefaultCountryId"                 : 1,
    "CartItemWeight"                   : 3.14,
    "TotalDue"                         : 3.14,
    "DiscountRetail"                   : 3.14,
    "DiscountShipping"                 : 3.14,
    "DiscountTax"                      : 3.14,
    "DiscountTotal"                    : 3.14,
    "QuantityDiscountAmount"           : 3.14,
    "QuantityDiscountTax"              : 3.14,
    "QuantityPricingPercentDiscount"   : 3.14,
    "ProcessMarkup"                    : 1,
    "ProcessMarkupAmount"              : 3.14,
    "TaxAmount"                        : 3.14,
    "ItemTotal"                        : 3.14,
    "ShippingAmount"                   : 3.14,
    "Discount"  : 
    {
      "ID"                       : 100000,
      "CouponCode"               : "sale",
      "Description"              : null,
      "DiscountCode"             : "ExampleString",
      "ExcludeDesigns"           : "ExampleString",
      "ExcludeProducts"          : "ExampleString",
      "ExcludeProductStyles"     : "ExampleString",
      "ExcludeShippingMethods"   : "ExampleString",
      "ExcludeStores"            : "ExampleString",
      "Name"                     : "Promotion",
      "OnlyDesigns"              : "ExampleString",
      "OnlyProducts"             : "ExampleString",
      "OnlyProductStyles"        : "ExampleString",
      "OnlyStores"               : "ExampleString",
      "DiscountItems"            : "true",
      "DiscountShipping"         : "true",
      "DiscountPickup"           : "true",
      "RequiresCoupon"           : "true",
      "DiscountAmount"           : 30.00,
      "DiscountPercent"          : null,
      "MinItemTotal"             : null,
      "MinItemCount"             : "3",
      "EffectiveDate"            : "2017-10-30T07:00:00Z",
      "ExpirationDate"           : "2018-10-30T07:00:00Z",
      "AutomaticDiscount"        : "true"
    },
    "ItemCount"                        : 1,
    "CanCheckout"                      : "true",
    "ValidationMessage"                : "ExampleString",
    "GiftCertificates"  : 
    [
      {
        "Amount"                  : 34.00,
        "AppliedAmount"           : 34.00,
        "InitialPurchaseAmount"   : 3.14,
        "Created"                 : "2017-10-30T07:00:00Z",
        "DateSent"                : "2017-10-30T07:00:00Z",
        "HasOrders"               : "true",
        "Number"                  : "CA77-EE66-GD6C-4E44",
        "ToName"                  : "John Doe",
        "ToEmail"                 : "John Doe"
      }
    ],
    "Items"  : 
    [
      {
        "CartRetailItemId"                     : 1,
        "CartRetailItemSizeId"                 : 1,
        "ProductSku"                           : "ExampleString",
        "ProductName"                          : "ExampleString",
        "AddOns"  : 
        [
          {
            "ID"            : 1,
            "Quantity"      : 1,
            "Name"          : "ExampleString",
            "Description"   : "ExampleString",
            "Price"         : 3.14
          }
        ],
        "ArtId"                                : 1,
        "DesignId"                             : 1,
        "EstimatedProductionDays"              : 1,
        "FullName"                             : "ExampleString",
        "ItemTotal"                            : 3.14,
        "NameNumberValues"  : 
        [
          {
            "RetailItemSizeId"   : 1000000,
            "Name"               : "Bob",
            "Number"             : "32",
            "Quantity"           : 1,
            "Price"              : 32
          }
        ],
        "Notes"                                : "ExampleString",
        "PersonalizationValues"  : 
        [
          {
            "Name"                       : "ExampleString",
            "Value"                      : "ExampleString",
            "Price"                      : 3.14,
            "ProductPersonalizationId"   : 1
          }
        ],
        "PrintCost"                            : 3.14,
        "PrintCostOverride"                    : 3.14,
        "PrintOverridePriceBack"               : 3.14,
        "PrintOverridePriceFront"              : 3.14,
        "PrintOverridePriceSleeveLeft"         : 3.14,
        "PrintOverridePriceSleeveRight"        : 3.14,
        "PrintPriceBack"                       : 3.14,
        "PrintPriceFront"                      : 3.14,
        "PrintPriceSleeveLeft"                 : 3.14,
        "PrintPriceSleeveRight"                : 3.14,
        "PrintSetupCharge"                     : 3.14,
        "PrintSetupOverridePriceBack"          : 3.14,
        "PrintSetupOverridePriceFront"         : 3.14,
        "PrintSetupOverridePriceSleeveLeft"    : 3.14,
        "PrintSetupOverridePriceSleeveRight"   : 3.14,
        "PrintSetupPriceBack"                  : 3.14,
        "PrintSetupPriceFront"                 : 3.14,
        "PrintSetupPriceSleeveLeft"            : 3.14,
        "PrintSetupPriceSleeveRight"           : 3.14,
        "ProductId"                            : 1,
        "ProductPriceEach"                     : 3.14,
        "ProductPriceEachOverride"             : 3.14,
        "ProductStyleId"                       : 1,
        "ProductStyleSizeId"                   : 1,
        "Quantity"                             : 1,
        "QuantityDiscountAmount"               : 3.14,
        "QuantityDiscountPercent"              : 3.14,
        "RetailItemId"                         : 1,
        "RetailItemSizeId"                     : 1,
        "SideColorways"  : 
        [
          {
            "SideId"       : "ExampleString",
            "ColorwayId"   : 1
          }
        ],
        "SidePreviews"  : 
        [
          {
            "SideName"             : "ExampleString",
            "ProductOnlyUrl"       : "ExampleString",
            "DesignOnlyUrl"        : "ExampleString",
            "DesignOnProductUrl"   : "ExampleString",
            "SideArtId"            : 1
          }
        ],
        "TaxRate"                              : 3.14,
        "TaxRateOverride"                      : 3.14,
        "UnitPrice"                            : 3.14,
        "UniqueId"                             : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7"
      }
    ],
    "NameNumberSettings"  : 
    [
      {
        "Name"  : 
        {
          "FontId"      : 1,
          "Size"        : "12",
          "Color"       : "FF0000",
          "ColorName"   : "Red"
        },
        "Number"  : 
        {
          "FontId"      : 1,
          "Size"        : "12",
          "Color"       : "FF0000",
          "ColorName"   : "Red"
        },
        "ProductStyleId"     : 1000001,
        "ArtId"              : null,
        "DesignId"           : null,
        "CartRetailItemId"   : 1000013,
        "PrintCost"          : null
      }
    ],
    "ShippingAddress"  : 
    {
      "ID"                     : 1000014,
      "StateId"                : 4,
      "CountryId"              : 1,
      "Business"               : "true",
      "TaxExempt"              : "true",
      "FirstName"              : "John",
      "LastName"               : "Doe",
      "Name"                   : "John Doe",
      "CompanyName"            : "Doe Co",
      "Street1"                : "1234 Test St",
      "Street2"                : "Suite 500",
      "City"                   : "Albuquerque",
      "State"                  : "NM",
      "StateName"              : "New Mexico",
      "Country"                : "United States",
      "CountryCode"            : "US",
      "Email"                  : "ExampleString",
      "Phone"                  : "480-309-6332",
      "Fax"                    : "480-309-6333",
      "PostCode"               : "87111",
      "POBox"                  : "true",
      "SaveToAddressBook"      : "true",
      "Type"                   : null,
      "TaxId"                  : null,
      "Department"             : "IT, Sales, Marketing",
      "ShowPickupAtCheckout"   : "true",
      "Validated"              : "true or false",
      "IsPrimaryAddress"       : "true",
      "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
    },
    "BillingAddress"  : 
    {
      "ID"                     : 1000014,
      "StateId"                : 4,
      "CountryId"              : 1,
      "Business"               : "true",
      "TaxExempt"              : "true",
      "FirstName"              : "John",
      "LastName"               : "Doe",
      "Name"                   : "John Doe",
      "CompanyName"            : "Doe Co",
      "Street1"                : "1234 Test St",
      "Street2"                : "Suite 500",
      "City"                   : "Albuquerque",
      "State"                  : "NM",
      "StateName"              : "New Mexico",
      "Country"                : "United States",
      "CountryCode"            : "US",
      "Email"                  : "ExampleString",
      "Phone"                  : "480-309-6332",
      "Fax"                    : "480-309-6333",
      "PostCode"               : "87111",
      "POBox"                  : "true",
      "SaveToAddressBook"      : "true",
      "Type"                   : null,
      "TaxId"                  : null,
      "Department"             : "IT, Sales, Marketing",
      "ShowPickupAtCheckout"   : "true",
      "Validated"              : "true or false",
      "IsPrimaryAddress"       : "true",
      "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
    },
    "ShippingMethod"  : 
    {
      "CarrierId"                      : "ExampleString",
      "CarrierEstimatedDeliveryDate"   : "2017-10-30T07:00:00Z",
      "Description"                    : "UPS Ground",
      "ID"                             : 1000019,
      "Name"                           : "Ground",
      "PackageType"                    : "ExampleString",
      "PackageCode"                    : "ExampleString",
      "RateId"                         : "ExampleString",
      "ServiceCode"                    : "ExampleString",
      "ServiceType"                    : "ExampleString",
      "VendorId"                       : 1000001,
      "VendorName"                     : "UPS",
      "VendorType"                     : "UPS",
      "Price"                          : 5.00,
      "AllowBeforeAddressKnown"        : "true",
      "AllowResidential"               : "true",
      "AllowPoBox"                     : "true",
      "AllowCommercial"                : "true",
      "DiscountingEnabled"             : "true",
      "ProcessDays"                    : 2,
      "PromptForCartShipperAccount"    : "true",
      "RequireCartShipperAccount"      : "true",
      "AllowShippingAddress"           : "true",
      "ProcessMarkup"                  : null,
      "PickupSetAtStoreId"             : null,
      "TransitDays_Min"                : 3,
      "TransitDays_Max"                : 5,
      "RtMarkupDollar"                 : null,
      "RtMarkupPercent"                : null,
      "Address"  : 
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      },
      "PickupNotes"                    : null,
      "PickupDateStart"                : "2017-10-30T07:00:00Z",
      "PickupDateEnd"                  : "2017-10-30T07:00:00Z",
      "OffsetGmt"                      : 7,
      "PickupType"  : {"Name" : "example not found 2"},
      "CalculationType"                : "Weight",
      "ShippingSchedules"  : 
      [{"Name" : "example not found 2"}
      ],
      "IsTaxExempt"                    : "true",
      "SortOrder"                      : 1,
      "ShipToStateIds"                 : [1,2,3],
      "IsDeleted"                      : "true",
      "IsProposalPickup"               : "true"
    },
    "GuestEmail"                       : "ExampleString",
    "GuestFirstName"                   : "ExampleString",
    "GuestLastName"                    : "ExampleString",
    "GiftMessage"                      : "ExampleString",
    "TierId"                           : 1,
    "ValidationErrors"  : 
    [{"Name" : "example not found 2"}
    ],
    "CheckoutFieldValues"  : 
    {
      "Item"  : {"Name" : "example not found 2"}
    }
  },
  "SalesDoc"  : {"Name" : "example not found 2"},
  "Products"  : 
  [
    {
      "BaseStyles"  : 
      [
        {
          "CanPrint"                      : "true",
          "CanDigitalPrint"               : "true",
          "CanScreenPrint"                : "true",
          "CanEmbroider"                  : "true",
          "IsDefault"                     : "true",
          "ID"                            : 1000001,
          "HtmlColor1"                    : "ExampleString",
          "HtmlColor2"                    : "ExampleString",
          "Name"                          : "Red",
          "Active"                        : "true",
          "IsLightColor"                  : "true",
          "IsDarkColor"                   : "true",
          "IsHeathered"                   : "true",
          "ImageFilePath_Front"           : "ExampleString",
          "Sides"  : 
          [
            {
              "Side"            : "ExampleString",
              "ImageFilePath"   : "ExampleString",
              "Width"           : 1,
              "Height"          : 1,
              "Colorway"  : 
              {
                "ID"             : 1,
                "Colors"  : 
                [
                  {
                    "Index"                : 1,
                    "Color"                : "ExampleString",
                    "EmbroideryThreadId"   : 1,
                    "InkColorId"           : 1,
                    "ColorName"            : "ExampleString",
                    "PMS"                  : "ExampleString"
                  }
                ],
                "Name"           : "ExampleString",
                "SvgUrl"         : "ExampleString",
                "RenderedUrl"    : "ExampleString",
                "ThumbnailUrl"   : "ExampleString"
              }
            }
          ],
          "ColorwayImageFilePath_Front"   : "ExampleString",
          "Sizes"  : 
          [
            {
              "ID"                        : 1000001,
              "Active"                    : "true",
              "IsDeleted"                 : "true",
              "Name"                      : "L",
              "ManufacturerSku"           : "B174BE097",
              "LongName"                  : "Large",
              "UnitPrice"                 : 15.00,
              "Price"                     : 3.14,
              "OverridePrice"             : 3.14,
              "SalePrice"                 : 12.99,
              "SaleStart"                 : "2017-10-30T07:00:00Z",
              "SaleEnd"                   : "2017-10-30T07:00:00Z",
              "IsDefault"                 : "true",
              "InStock"                   : "true",
              "SupplierInventory"         : 1,
              "LocalInventory"            : 1,
              "SupplierCost"              : 3.14,
              "UpCharge"                  : 0.00,
              "Weight"                    : 3.14,
              "SortOrder"                 : 1,
              "Detail"  : 
              {
                "GTIN"   : "ExampleString"
              },
              "QuantityPackPricing"  : 
              [
                {
                  "Quantity"   : 1,
                  "Price"      : 3.14,
                  "Cost"       : 3.14
                }
              ],
              "ProductStyleSizeToStore"  : 
              [
                {
                  "ProductId"                   : 1,
                  "ProductStyleId"              : 1,
                  "ProductStyleSizeId"          : 1,
                  "ProductStyleSizeToStoreId"   : 1,
                  "PriceOverride"               : 3.14,
                  "StoreId"                     : 1
                }
              ]
            }
          ],
          "AvailableQuantityPacks"        : [1,2,3],
          "QuantityPackPricing"  : 
          [
            {
              "Quantity"   : 1,
              "Price"      : 3.14,
              "Cost"       : 3.14
            }
          ],
          "Price"                         : 3.14
        }
      ],
      "Keywords"                            : [ExampleString,ExampleString,ExampleString],
      "DecoratedProductSides"  : 
      [
        {
          "ProductFilename"   : "ExampleString",
          "ProductWidth"      : 1,
          "ProductHeight"     : 1,
          "Side"              : "ExampleString",
          "Images"  : 
          [
            {
              "ImageFilename"   : "ExampleString",
              "Region"  : 
              {
                "X"          : 3.14,
                "Y"          : 3.14,
                "Width"      : 3.14,
                "Height"     : 3.14,
                "Rotation"   : 3.14
              },
              "RegionString"    : "ExampleString"
            }
          ]
        }
      ],
      "Categories"  : 
      [
        {
          "ID"     : 1,
          "Name"   : "ExampleString",
          "Path"   : "ExampleString"
        }
      ],
      "Sides"  : 
      [
        {
          "Name"                 : "ExampleString",
          "DisplayName"          : "ExampleString",
          "Active"               : "true",
          "Regions"  : 
          [
            {
              "ID"                          : 1000001,
              "Name"                        : "Full",
              "X"                           : 10,
              "Y"                           : 10,
              "Width"                       : 100,
              "Height"                      : 200,
              "Rotation"                    : null,
              "Shape"                       : null,
              "Side"                        : "front",
              "IsDefault"                   : "true",
              "ProductRegionRenderSizeId"   : 1,
              "RenderWidthInches"           : null,
              "RenderHeightInches"          : null
            }
          ],
          "OverlayArtImageUrl"   : "ExampleString"
        }
      ],
      "StoreIds"                            : [1,2,3],
      "Personalizations"  : 
      [
        {
          "ID"            : 10000,
          "ProductId"     : 10000,
          "Name"          : "First Name",
          "Description"   : "Your first name",
          "Required"      : "true",
          "Active"        : "true",
          "Price"         : null,
          "Options"  : 
          [
            {
              "ID"      : 100000,
              "Value"   : "Highland High School"
            }
          ],
          "Format"        : "NumbersOnly",
          "MinLength"     : 1,
          "MaxLength"     : 1
        }
      ],
      "ID"                                  : 1000000,
      "SourceProductId"                     : 1000001,
      "Active"                              : "true",
      "Manufacturer"                        : "Gildan",
      "ManufacturerSku"                     : "2200",
      "ManufacturerId"                      : 1000000,
      "SupplierId"                          : Sanmar,
      "Supplier"                            : "Sanmar",
      "MaxColors"                           : "true",
      "CanPrint"                            : "true",
      "CanDigitalPrint"                     : "true",
      "CanScreenPrint"                      : "true",
      "CanEmbroider"                        : "true",
      "Sku"                                 : "2200_41157_1000000",
      "Name"                                : "Ultra Cotton Tank Top",
      "IsStatic"                            : "true",
      "BuyBlank"                            : "true",
      "DesignOnline"                        : "true",
      "DesignDetailsForm"                   : "true",
      "StaticDesignId"                      : 1,
      "Created"                             : "2017-10-30T07:00:00Z",
      "PersonalizationType"                 : "ExampleString",
      "HasProductArt"                       : "true",
      "EnforceProductInventoriesLocal"      : "true",
      "EnforceProductInventoriesSupplier"   : "true",
      "UnitCost"                            : 3.14,
      "UnitPrice"                           : 3.14,
      "SalePrice"                           : 3.14,
      "PriceRuleMarkup"  : 
      {
        "Schedules"  : 
        [
          {
            "ID"              : 1000000,
            "MinimumPrice"    : 0.01,
            "MaximumPrice"    : 5.00,
            "MarkupPercent"   : 100.00,
            "MarkupAmount"    : null
          }
        ],
        "ID"                         : 1000000,
        "Name"                       : "Markup",
        "MarkupFromCost"             : "true",
        "MarkupFromQuantity"         : "true",
        "MarkupAmountFromCost"       : "true",
        "MarkupAmountFromQuantity"   : "true"
      },
      "PriceRuleDiscount"  : 
      {
        "ID"             : 1000000,
        "Name"           : "Save10",
        "EntireCart"     : "true",
        "EachCartItem"   : "false",
        "Schedules"  : 
        [
          {
            "ID"                : 1000004,
            "MinimumQuantity"   : 3,
            "MaximumQuantity"   : 1000,
            "DiscountPercent"   : null,
            "DiscountAmount"    : 10.00
          }
        ]
      },
      "StyleCount"                          : 1,
      "TaxExempt"                           : "true",
      "SizeUnit"                            : "ExampleString",
      "SizeChartUrl"                        : "ExampleString",
      "ProductType"  : {"Name" : "example not found 2"},
      "LongDescription"                     : "This is a great looking shirt that will make you look great when you wear it",
      "ManufacturerBrandImageUrl"           : "ExampleString",
      "DefaultSide"                         : "ExampleString",
      "HasOrders"                           : "true"
    }
  ],
  "Manufacturers"  : 
  [
    {
      "ID"              : 1000001,
      "Name"            : "Gildan",
      "HasBrandImage"   : "true",
      "HasSizeChart"    : "true",
      "SizeChartUrl"    : "ExampleString",
      "BrandImageUrl"   : "ExampleString",
      "ProductCount"    : 1,
      "SizeCharts"      : [A,A,A]
    }
  ],
  "Art"  : 
  [
    {
      "ID"                    : 1,
      "ColorCount"            : 1,
      "Colors"                : ["#FF0000","#FFFFFF","#0000FF"],
      "OriginalColorway"  : 
      {
        "ID"             : 1,
        "Colors"  : 
        [
          {
            "Index"                : 1,
            "Color"                : "ExampleString",
            "EmbroideryThreadId"   : 1,
            "InkColorId"           : 1,
            "ColorName"            : "ExampleString",
            "PMS"                  : "ExampleString"
          }
        ],
        "Name"           : "ExampleString",
        "SvgUrl"         : "ExampleString",
        "RenderedUrl"    : "ExampleString",
        "ThumbnailUrl"   : "ExampleString"
      },
      "StitchCount"           : 1,
      "TrimCount"             : 1,
      "GalleryId"             : 1,
      "CategoryIds"           : [1,2,3],
      "Name"                  : "Business_Designs",
      "Type"                  : "ExampleString",
      "Keywords"              : "pretty,big,black and white,zebra",
      "FixedSvg"              : "true",
      "Digitized"             : "true",
      "CanScreenPrint"        : "true",
      "FullName"              : "store5976/Business/Business_Designs",
      "ExternalReferenceID"   : "ExampleString",
      "Width"                 : 762,
      "Height"                : 538,
      "Notes"                 : "ExampleString",
      "FileExt"               : "png",
      "ImageUrl"              : "ExampleString",
      "ThumbUrl"              : "ExampleString",
      "ThumbUrlAlt"           : "ExampleString",
      "OriginalUrl"           : "ExampleString",
      "UploadedUrl"           : "ExampleString",
      "UploadedOn"            : "2017-10-30T07:00:00Z",
      "IsActive"              : "true",
      "Colorways"  : 
      [
        {
          "ID"             : 1,
          "Colors"  : 
          [
            {
              "Index"                : 1,
              "Color"                : "ExampleString",
              "EmbroideryThreadId"   : 1,
              "InkColorId"           : 1,
              "ColorName"            : "ExampleString",
              "PMS"                  : "ExampleString"
            }
          ],
          "Name"           : "ExampleString",
          "SvgUrl"         : "ExampleString",
          "RenderedUrl"    : "ExampleString",
          "ThumbnailUrl"   : "ExampleString"
        }
      ],
      "UniqueId"              : "",
      "MatchFileColor"        : "true"
    }
  ],
  "DesignSummaries"  : 
  [
    {
      "DesignID"                   : 1,
      "UserID"                     : 1,
      "UserEmail"                  : "ExampleString",
      "Uri"                        : "ExampleString",
      "DesignedOnSku"              : "ExampleString",
      "DesignedOnStyleName"        : "ExampleString",
      "DesignedOnProductId"        : 1,
      "DesignedOnProductStyleId"   : 1,
      "Canvases"  : 
      [{"Name" : "example not found 2"}
      ],
      "LastModified"               : "2017-10-30T07:00:00Z",
      "Name"                       : "ExampleString",
      "Notes"                      : "ExampleString"
    }
  ],
  "Contacts"  : 
  [
    {
      "Phones"  : 
      [
        {
          "ID"            : 1000000,
          "Number"        : "888-222-3333",
          "Extension"     : "1234",
          "PhoneType"     : "Mobile",
          "IsSMSOptOut"   : "false"
        }
      ],
      "Tags"  : 
      [
        {
          "ID"      : 1000000,
          "Name"    : "Walter",
          "Count"   : 12
        }
      ],
      "Addresses"  : 
      [
        {
          "ID"                     : 1000014,
          "StateId"                : 4,
          "CountryId"              : 1,
          "Business"               : "true",
          "TaxExempt"              : "true",
          "FirstName"              : "John",
          "LastName"               : "Doe",
          "Name"                   : "John Doe",
          "CompanyName"            : "Doe Co",
          "Street1"                : "1234 Test St",
          "Street2"                : "Suite 500",
          "City"                   : "Albuquerque",
          "State"                  : "NM",
          "StateName"              : "New Mexico",
          "Country"                : "United States",
          "CountryCode"            : "US",
          "Email"                  : "ExampleString",
          "Phone"                  : "480-309-6332",
          "Fax"                    : "480-309-6333",
          "PostCode"               : "87111",
          "POBox"                  : "true",
          "SaveToAddressBook"      : "true",
          "Type"                   : null,
          "TaxId"                  : null,
          "Department"             : "IT, Sales, Marketing",
          "ShowPickupAtCheckout"   : "true",
          "Validated"              : "true or false",
          "IsPrimaryAddress"       : "true",
          "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
        }
      ],
      "ID"                      : 1000000,
      "FirstName"               : "Walter",
      "LastName"                : "White",
      "JobTitle"                : "Owner",
      "Email"                   : "email@walterwhite.com",
      "ProfilePicture"          : "email@walterwhite.com",
      "Newsletter"              : "true",
      "Store"  : 
      {
        "ID"                    : 1000000,
        "Uri"                   : "ExampleString",
        "Name"                  : "Walter",
        "Logo"                  : "logo.png",
        "AcceptPurchaseOrder"   : "true or false",
        "AllowPaymentLater"     : "true or false"
      },
      "Origin"  : 
      {
        "ID"      : 1000000,
        "Name"    : "Walter",
        "Image"   : "Walter",
        "Count"   : Walter
      },
      "Company"  : 
      {
        "ID"                     : 1000000,
        "Name"                   : "Inksoft",
        "PrimaryContact"  : 
        {
          "Fax"                     : "111-222-3333",
          "Note"                    : "Some details about the Contact",
          "SalesDocs"  : 
          [{"Name" : "example not found 2"}
          ],
          "PurchaseOrdersEnabled"   : "true",
          "PayLaterEnabled"         : "true",
          "Timeline"  : 
          [
            {
              "EventDescription"    : ,
              "ID"                  : 1,
              "ContactIds"          : [1,2,3],
              "CompanyIds"          : [1,2,3],
              "JobIds"              : [1,2,3],
              "OrderIds"            : [1,2,3],
              "ProposalIds"         : [1,2,3],
              "ProductionCardIds"   : [1,2,3],
              "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
              "Event"               : "ExampleString",
              "Comment"             : "ExampleString",
              "EventType"  : {"Name" : "example not found 2"},
              "Edited"              : "true",
              "EditedDate"          : "2017-10-30T07:00:00Z",
              "Deleted"             : "true",
              "DeletedDate"         : "2017-10-30T07:00:00Z",
              "Created"             : "2017-10-30T07:00:00Z",
              "CreatedByUserId"     : 1,
              "CreatedByName"       : "ExampleString",
              "Details"  : 
              [
                {
                  "Property"   : "ExampleString",
                  "OldValue"   : "ExampleString",
                  "NewValue"   : "ExampleString",
                  "Date"       : "2017-10-30T07:00:00Z"
                }
              ],
              "Associations"  : {"Name" : "example not found 2"}
            }
          ],
          "TierId"                  : 1,
          "Tiers"  : 
          [
            {
              "ID"         : 1000000,
              "Name"       : "Reseller",
              "UniqueId"   : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
              "Active"     : "true"
            }
          ],
          "IsTaxable"               : "true",
          "ID"                      : 1,
          "FirstName"               : "ExampleString",
          "LastName"                : "ExampleString",
          "JobTitle"                : "ExampleString",
          "Email"                   : "ExampleString",
          "Phones"  : 
          [
            {
              "ID"            : 1000000,
              "Number"        : "888-222-3333",
              "Extension"     : "1234",
              "PhoneType"     : "Mobile",
              "IsSMSOptOut"   : "false"
            }
          ],
          "ProfilePicture"          : "ExampleString",
          "Newsletter"              : "true",
          "Tags"  : 
          [
            {
              "ID"      : 1000000,
              "Name"    : "Walter",
              "Count"   : 12
            }
          ],
          "Store"  : 
          {
            "ID"                    : 1000000,
            "Uri"                   : "ExampleString",
            "Name"                  : "Walter",
            "Logo"                  : "logo.png",
            "AcceptPurchaseOrder"   : "true or false",
            "AllowPaymentLater"     : "true or false"
          },
          "Origin"  : 
          {
            "ID"      : 1000000,
            "Name"    : "Walter",
            "Image"   : "Walter",
            "Count"   : Walter
          },
          "Company"  : null,
          "PrimaryAddressId"        : 1,
          "Addresses"  : 
          [
            {
              "ID"                     : 1000014,
              "StateId"                : 4,
              "CountryId"              : 1,
              "Business"               : "true",
              "TaxExempt"              : "true",
              "FirstName"              : "John",
              "LastName"               : "Doe",
              "Name"                   : "John Doe",
              "CompanyName"            : "Doe Co",
              "Street1"                : "1234 Test St",
              "Street2"                : "Suite 500",
              "City"                   : "Albuquerque",
              "State"                  : "NM",
              "StateName"              : "New Mexico",
              "Country"                : "United States",
              "CountryCode"            : "US",
              "Email"                  : "ExampleString",
              "Phone"                  : "480-309-6332",
              "Fax"                    : "480-309-6333",
              "PostCode"               : "87111",
              "POBox"                  : "true",
              "SaveToAddressBook"      : "true",
              "Type"                   : null,
              "TaxId"                  : null,
              "Department"             : "IT, Sales, Marketing",
              "ShowPickupAtCheckout"   : "true",
              "Validated"              : "true or false",
              "IsPrimaryAddress"       : "true",
              "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
            }
          ],
          "Discount"                : 3.14,
          "BirthDate"               : "2017-10-30T07:00:00Z",
          "DateCreated"             : "2017-10-30T07:00:00Z",
          "LastModified"            : "2017-10-30T07:00:00Z",
          "ExternalReferenceId"     : "ExampleString",
          "StoreAnalyticsEnabled"   : "true"
        },
        "PrimaryContactId"       : 1,
        "PrimaryAddress"  : 
        {
          "ID"                     : 1000014,
          "StateId"                : 4,
          "CountryId"              : 1,
          "Business"               : "true",
          "TaxExempt"              : "true",
          "FirstName"              : "John",
          "LastName"               : "Doe",
          "Name"                   : "John Doe",
          "CompanyName"            : "Doe Co",
          "Street1"                : "1234 Test St",
          "Street2"                : "Suite 500",
          "City"                   : "Albuquerque",
          "State"                  : "NM",
          "StateName"              : "New Mexico",
          "Country"                : "United States",
          "CountryCode"            : "US",
          "Email"                  : "ExampleString",
          "Phone"                  : "480-309-6332",
          "Fax"                    : "480-309-6333",
          "PostCode"               : "87111",
          "POBox"                  : "true",
          "SaveToAddressBook"      : "true",
          "Type"                   : null,
          "TaxId"                  : null,
          "Department"             : "IT, Sales, Marketing",
          "ShowPickupAtCheckout"   : "true",
          "Validated"              : "true or false",
          "IsPrimaryAddress"       : "true",
          "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
        },
        "PrimaryAddressId"       : 1,
        "Addresses"  : 
        [
          {
            "ID"                     : 1000014,
            "StateId"                : 4,
            "CountryId"              : 1,
            "Business"               : "true",
            "TaxExempt"              : "true",
            "FirstName"              : "John",
            "LastName"               : "Doe",
            "Name"                   : "John Doe",
            "CompanyName"            : "Doe Co",
            "Street1"                : "1234 Test St",
            "Street2"                : "Suite 500",
            "City"                   : "Albuquerque",
            "State"                  : "NM",
            "StateName"              : "New Mexico",
            "Country"                : "United States",
            "CountryCode"            : "US",
            "Email"                  : "ExampleString",
            "Phone"                  : "480-309-6332",
            "Fax"                    : "480-309-6333",
            "PostCode"               : "87111",
            "POBox"                  : "true",
            "SaveToAddressBook"      : "true",
            "Type"                   : null,
            "TaxId"                  : null,
            "Department"             : "IT, Sales, Marketing",
            "ShowPickupAtCheckout"   : "true",
            "Validated"              : "true or false",
            "IsPrimaryAddress"       : "true",
            "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
          }
        ],
        "WebsiteUrl"             : "http://www.inksoft.com",
        "Fax"                    : "111-222-3333",
        "USFederalTaxId"         : "22-3333333",
        "USStateTaxId"           : "22-3333333",
        "CanadaBusinessNumber"   : "22-3333333",
        "IsUSTaxExempt"          : "true or false",
        "USTaxExemptionType"     : "NGO",
        "Discount"               : 22-3333333,
        "Note"                   : "Something about the company",
        "Phones"  : 
        [
          {
            "ID"            : 1000000,
            "Number"        : "888-222-3333",
            "Extension"     : "1234",
            "PhoneType"     : "Mobile",
            "IsSMSOptOut"   : "false"
          }
        ],
        "Tags"  : 
        [
          {
            "ID"      : 1000000,
            "Name"    : "Walter",
            "Count"   : 12
          }
        ],
        "Contacts"  : 
        [
          {
            "Fax"                     : "111-222-3333",
            "Note"                    : "Some details about the Contact",
            "SalesDocs"  : 
            [{"Name" : "example not found 2"}
            ],
            "PurchaseOrdersEnabled"   : "true",
            "PayLaterEnabled"         : "true",
            "Timeline"  : 
            [
              {
                "EventDescription"    : ,
                "ID"                  : 1,
                "ContactIds"          : [1,2,3],
                "CompanyIds"          : [1,2,3],
                "JobIds"              : [1,2,3],
                "OrderIds"            : [1,2,3],
                "ProposalIds"         : [1,2,3],
                "ProductionCardIds"   : [1,2,3],
                "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
                "Event"               : "ExampleString",
                "Comment"             : "ExampleString",
                "EventType"  : {"Name" : "example not found 2"},
                "Edited"              : "true",
                "EditedDate"          : "2017-10-30T07:00:00Z",
                "Deleted"             : "true",
                "DeletedDate"         : "2017-10-30T07:00:00Z",
                "Created"             : "2017-10-30T07:00:00Z",
                "CreatedByUserId"     : 1,
                "CreatedByName"       : "ExampleString",
                "Details"  : 
                [
                  {
                    "Property"   : "ExampleString",
                    "OldValue"   : "ExampleString",
                    "NewValue"   : "ExampleString",
                    "Date"       : "2017-10-30T07:00:00Z"
                  }
                ],
                "Associations"  : {"Name" : "example not found 2"}
              }
            ],
            "TierId"                  : 1,
            "Tiers"  : 
            [
              {
                "ID"         : 1000000,
                "Name"       : "Reseller",
                "UniqueId"   : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
                "Active"     : "true"
              }
            ],
            "IsTaxable"               : "true",
            "ID"                      : 1,
            "FirstName"               : "ExampleString",
            "LastName"                : "ExampleString",
            "JobTitle"                : "ExampleString",
            "Email"                   : "ExampleString",
            "Phones"  : 
            [
              {
                "ID"            : 1000000,
                "Number"        : "888-222-3333",
                "Extension"     : "1234",
                "PhoneType"     : "Mobile",
                "IsSMSOptOut"   : "false"
              }
            ],
            "ProfilePicture"          : "ExampleString",
            "Newsletter"              : "true",
            "Tags"  : 
            [
              {
                "ID"      : 1000000,
                "Name"    : "Walter",
                "Count"   : 12
              }
            ],
            "Store"  : 
            {
              "ID"                    : 1000000,
              "Uri"                   : "ExampleString",
              "Name"                  : "Walter",
              "Logo"                  : "logo.png",
              "AcceptPurchaseOrder"   : "true or false",
              "AllowPaymentLater"     : "true or false"
            },
            "Origin"  : 
            {
              "ID"      : 1000000,
              "Name"    : "Walter",
              "Image"   : "Walter",
              "Count"   : Walter
            },
            "Company"  : null,
            "PrimaryAddressId"        : 1,
            "Addresses"  : 
            [
              {
                "ID"                     : 1000014,
                "StateId"                : 4,
                "CountryId"              : 1,
                "Business"               : "true",
                "TaxExempt"              : "true",
                "FirstName"              : "John",
                "LastName"               : "Doe",
                "Name"                   : "John Doe",
                "CompanyName"            : "Doe Co",
                "Street1"                : "1234 Test St",
                "Street2"                : "Suite 500",
                "City"                   : "Albuquerque",
                "State"                  : "NM",
                "StateName"              : "New Mexico",
                "Country"                : "United States",
                "CountryCode"            : "US",
                "Email"                  : "ExampleString",
                "Phone"                  : "480-309-6332",
                "Fax"                    : "480-309-6333",
                "PostCode"               : "87111",
                "POBox"                  : "true",
                "SaveToAddressBook"      : "true",
                "Type"                   : null,
                "TaxId"                  : null,
                "Department"             : "IT, Sales, Marketing",
                "ShowPickupAtCheckout"   : "true",
                "Validated"              : "true or false",
                "IsPrimaryAddress"       : "true",
                "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
              }
            ],
            "Discount"                : 3.14,
            "BirthDate"               : "2017-10-30T07:00:00Z",
            "DateCreated"             : "2017-10-30T07:00:00Z",
            "LastModified"            : "2017-10-30T07:00:00Z",
            "ExternalReferenceId"     : "ExampleString",
            "StoreAnalyticsEnabled"   : "true"
          }
        ],
        "Timeline"  : 
        [
          {
            "EventDescription"    : ,
            "ID"                  : 1,
            "ContactIds"          : [1,2,3],
            "CompanyIds"          : [1,2,3],
            "JobIds"              : [1,2,3],
            "OrderIds"            : [1,2,3],
            "ProposalIds"         : [1,2,3],
            "ProductionCardIds"   : [1,2,3],
            "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
            "Event"               : "ExampleString",
            "Comment"             : "ExampleString",
            "EventType"  : {"Name" : "example not found 2"},
            "Edited"              : "true",
            "EditedDate"          : "2017-10-30T07:00:00Z",
            "Deleted"             : "true",
            "DeletedDate"         : "2017-10-30T07:00:00Z",
            "Created"             : "2017-10-30T07:00:00Z",
            "CreatedByUserId"     : 1,
            "CreatedByName"       : "ExampleString",
            "Details"  : 
            [
              {
                "Property"   : "ExampleString",
                "OldValue"   : "ExampleString",
                "NewValue"   : "ExampleString",
                "Date"       : "2017-10-30T07:00:00Z"
              }
            ],
            "Associations"  : {"Name" : "example not found 2"}
          }
        ]
      },
      "PrimaryAddressId"        : 1,
      "Discount"                : VIP Discount for the Contact,
      "BirthDate"               : "2017-10-30T07:00:00Z",
      "DateCreated"             : "2017-01-01",
      "LastModified"            : "2017-01-01",
      "ExternalReferenceId"     : "H32504E04F8911D39AAC0305E82C4201",
      "StoreAnalyticsEnabled"   : "true"
    }
  ],
  "SimpleDesigns"  : 
  [
    {
      "ID"                 : 1,
      "DesignArtRegions"  : 
      [
        {
          "RegionName"         : "ExampleString",
          "SideId"             : "ExampleString",
          "ColorCount"         : 1,
          "ArtId"              : 1,
          "DistressId"         : 1,
          "ArtRegion"  : 
          {
            "ID"                          : 1000001,
            "Name"                        : "Full",
            "X"                           : 10,
            "Y"                           : 10,
            "Width"                       : 100,
            "Height"                      : 200,
            "Rotation"                    : null,
            "Shape"                       : null,
            "Side"                        : "front",
            "IsDefault"                   : "true",
            "ProductRegionRenderSizeId"   : 1,
            "RenderWidthInches"           : null,
            "RenderHeightInches"          : null
          },
          "DecorationMethod"  : {"Name" : "example not found 2"},
          "MatchFileColor"     : "true"
        }
      ],
      "Name"               : "ExampleString",
      "Notes"              : "ExampleString",
      "ProductStyleId"     : 1
    }
  ]
}

 

SideColorway

Describes which art colorway ID should be assigned to a particular side of a cart item.

Properties

  • SideId type: string

  • ColorwayId type: (nullable) integer 


{
  "SideId"       : "ExampleString",
  "ColorwayId"   : 1
}

 

SimpleDesign

A design that consists of art placed on products - no text.

Properties

  • ID type: integer

    The ID of the design

  • DesignArtRegions type: List of DesignArtRegion

    A list of the sides for this design

  • Name type: string

    The optional name of the design, if not provided then a new GUID will be generated and used as the Name

  • Notes type: string

    Notes for the SimpleDesign

  • ProductStyleId type: (nullable) integer

    ProductStyleID for the product style the design was created for 


{
  "ID"                 : 1,
  "DesignArtRegions"  : 
  [
    {
      "RegionName"         : "ExampleString",
      "SideId"             : "ExampleString",
      "ColorCount"         : 1,
      "ArtId"              : 1,
      "DistressId"         : 1,
      "ArtRegion"  : 
      {
        "ID"                          : 1000001,
        "Name"                        : "Full",
        "X"                           : 10,
        "Y"                           : 10,
        "Width"                       : 100,
        "Height"                      : 200,
        "Rotation"                    : null,
        "Shape"                       : null,
        "Side"                        : "front",
        "IsDefault"                   : "true",
        "ProductRegionRenderSizeId"   : 1,
        "RenderWidthInches"           : null,
        "RenderHeightInches"          : null
      },
      "DecorationMethod"  : {"Name" : "example not found 2"},
      "MatchFileColor"     : "true"
    }
  ],
  "Name"               : "ExampleString",
  "Notes"              : "ExampleString",
  "ProductStyleId"     : 1
}

 

SocialNetwork

A social network link for a store

Properties

  • ID type: integer

    The unique integer ID of this social network

  • Name type: string

    The name of this social network

  • Description type: string

    A description of this social network

  • Url type: string

    The URL of this social network

  • StringIdentifier type: string

    A string identifier of this social network 


{
  "ID"                 : 1000001,
  "Name"               : "Facebook",
  "Description"        : "Follow us on Facebook!",
  "Url"                : "https://www.facebook.com/joes-fancy-shirts",
  "StringIdentifier"   : "facebook"
}

 

SortFilter

Properties 

{
  "Property"    : "ExampleString",
  "Direction"  : {"Name" : "example not found 2"}
}

 

State

A geographical state

Properties

  • ID type: integer

    The unique integer ID of this state

  • CountryId type: integer

    The ID of the Country to which this state belongs

  • Code type: string

    The two-character code for this state

  • Name type: string

    The name of this state

  • Tax type: decimal

    The tax rate that applies to this state 


{
  "ID"          : 4,
  "CountryId"   : 1,
  "Code"        : "AZ",
  "Name"        : "Arizona",
  "Tax"         : 0.056000
}

 

StoreContent

Content sections to be displayed on a storefront. These content sections override identical sections from [Object:PublisherContent] when supplied

Properties

  • TermsOfUse type: string

    Text for the Terms of Use section

  • PrivacyPolicy type: string

    Text for the Privacy Policy section

  • RefundPolicy type: string

    Text for the Refund Policy section

  • DeliveryPolicy type: string

    Text for the Delivery Policy section

  • OrderThankYouMessage type: string

    The "thank you" message to be displayed when a customer places an order

  • PackingSlipFooter type: string

    The text to be displayed on the packing slip footer

  • UploadImageTerms type: string

    The terms to be displayed when a user uploads an image 


{
  "TermsOfUse"             : "ExampleString",
  "PrivacyPolicy"          : "ExampleString",
  "RefundPolicy"           : "ExampleString",
  "DeliveryPolicy"         : "ExampleString",
  "OrderThankYouMessage"   : "ExampleString",
  "PackingSlipFooter"      : "ExampleString",
  "UploadImageTerms"       : "ExampleString"
}

 

StoreData

StoreData represents all data needed to display a storefront that can be reasonably provided in a fast, efficient, initial API call

Properties

  • StoreId type: integer

    Friendly, unique integer store ID

  • StoreGuid type: guid

    Immutable, unique store ID

  • PublisherId type: integer

    The ID of the publisher for this store

  • ProductListNewDays type: integer

    The number of days Products added to this store should be displayed as "new"

  • PercentComplete type: (nullable) byte

    A measure of progress during store creation, set by the front-end

  • HasBlankProducts type: boolean

    True when there is at least one blank product in this store that can used in the design studio.

  • HasClipArt type: boolean

    True when there is at least one clip art assigned to this store

  • HasDesignIdeas type: boolean

    True when there is at least one design idea assigned to this store

  • StoreUri type: string

    Mutable but unique identifier for active stores. Immutable and unique identifier for deleted stores.

  • Name type: string

    The name of the store

  • Title type: string

    The title of the store

  • ScreenPrintMaxColors type: integer

    The maximum number of colors supported for screen printing (from the publisher)

  • ScreenPrintMinimumQuantity type: (nullable) integer

    The minimum quantity supported for screen printing (from the publisher)

  • StoreEmail type: string

    The contact email address for this store

  • PublisherName type: string

    The name of the publisher to which this store belongs

  • PublisherPhone type: string

    The contact phone number for the store's publisher

  • PublisherEmail type: string

    The contact email address for the store's publisher

  • MainStoreUri type: string

    The URI to the publisher's main store

  • IsMainStore type: boolean

    A given publisher will have one and only one 'main store'. True if the store is the publisher's main store.

  • GoogleTagManagerId type: string

  • GoogleMeasurementId type: string

    Google Analytics 4 unique identifier

  • CurrencySymbol type: string

    The currency symbol to be used for this store

  • CurrencyCode type: string

    The currency code to be used for this store

  • Domain type: string

    The custom domain to be used for this store (if any)

  • SSL_Domain type: string

    The SSL domain to be used for this store (if any)

  • EmbedDomain type: string

    The domain that this store is allowed to be embedded on as a designer

  • CurrentStep type: string

    A string key representing the current step of the store creation process completed. Set by the front-end

  • State type: string

    The state of this store (PENDING, ACTIVE, DELETED, etc.)

  • IsTaxExempt type: boolean

    True if this store is marked as tax-exempt

  • PaymentProcessorsEnabled type: boolean

    True if one or more payment processors are enabled

  • LicenseIncludesDesignStudio type: (nullable) boolean

    A bool indicating if the design studio is available to be enabled for this store.

  • Flags type: StoreDataFlags

  • CheckoutPayment type: string

    A string describing the requirements for payment during checkout

  • ProductionDate type: (nullable) DateTime

    The date items will be produced for shipment. This only applies to fundraiser stores or stores with an end date

  • QuoteEmailRecipients type: List of string

    The email addresses that are sent the quote requests submitted to this store.

  • Fundraiser type: Fundraiser

  • FundraiserRemoved type: boolean

    Flag on store data that the front end passes when the component is removed, if this is true set the active fundraiser to inactive

  • Countdown type: Countdown

  • Options type: StoreOptions

    A list of StoreOptions that apply to this store

  • EnabledClientAnalytics type: List of ClientAnalyticsOptions

    The list of analytics that are available to store clients.

  • Address type: Address

    The address at which this store is located

  • PayrixAddress type: Address

    The address to display next to payments

  • ShippingIntegrationEnabled type: boolean

    True, when real time shipping integration is enabled to this store

  • ShippingMethodIds type: List of integer

    A list of IDs that correspond to ShippingMethods available for this store

  • PickupLocations type: List of ShippingMethod

    A list of pickup locations available for this store. This list consists of objects rather than IDs since pickup locations are store-specific and, consequently, all information must be provided

  • SocialNetworks type: List of SocialNetwork

    A list of social network links for this store

  • StoreContent type: StoreContent

    Custom text content for this store

  • AbandonedCartSettings type: AbandonedCartSettings

    Store settings for abandoned carts

  • StoreEmailNotifications type: List of StoreEmailNotification

    A list of StoreEmailNotifications that apply to this store

  • CheckoutFields type: List of Field

    A list of custom checkout fields that apply to this store

  • CurrentLogo type: SavedStoreImage

    The current logo for this store

  • CurrentHeaderLogo type: SavedStoreImage

    The current header logo for this store

  • CurrentFavicon type: SavedStoreImage

    The current favicon for this store

  • CurrentSocialMediaImage type: SavedStoreImage

    The current Social Media Image for this store

  • StoreCommission type: decimal

    Set to a percentage of store sales that is paid as a commission

  • SeoSettings type: List of StoreSeo

  • IsBetaMember type: (nullable) boolean

    If the store is participating in the current beta version of InkSoft, this is set to true.

  • CustomCssFileName type: string

    File name of the custom CSS file uploaded by a store manager

  • StoreType type: string

    Returns the Store Type (Examples: STORE/DSSTORE/PUBLISHER_MAIN)

  • TaxNexusAddressIds type: integer

    Tax Nexus Address IDs

  • OrderApprovalSettings type: OrderApprovalSettings

    This object contains information indicating what orders need to go through approvals

  • ProposalStoreAssignmentEnabledDate type: (nullable) DateTime

    The cutoff date where store assignment in proposals was enabled

  • PaymentEnabled type: boolean

    If set to false, "Arrange Payment Later" should be the payment type for this order, and we should skip the payment step altogether.

  • PhoneNumber type: string

    Store phone number to show for help/questions 


{
  "StoreId"                              : 1,
  "StoreGuid"                            : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
  "PublisherId"                          : 1,
  "ProductListNewDays"                   : 1,
  "PercentComplete"                      : "1",
  "HasBlankProducts"                     : "true",
  "HasClipArt"                           : "true",
  "HasDesignIdeas"                       : "true",
  "StoreUri"                             : "johns_fancy_shirts",
  "Name"                                 : "John's Fancy Shirts",
  "Title"                                : "John's Fancy Shirts",
  "ScreenPrintMaxColors"                 : 1,
  "ScreenPrintMinimumQuantity"           : 1,
  "StoreEmail"                           : "ExampleString",
  "PublisherName"                        : "ExampleString",
  "PublisherPhone"                       : "ExampleString",
  "PublisherEmail"                       : "ExampleString",
  "MainStoreUri"                         : "ExampleString",
  "IsMainStore"                          : "true",
  "GoogleTagManagerId"                   : "ExampleString",
  "GoogleMeasurementId"                  : "ExampleString",
  "CurrencySymbol"                       : "$",
  "CurrencyCode"                         : "USD",
  "Domain"                               : "fancyshirts.com",
  "SSL_Domain"                           : "fancyshirts.com",
  "EmbedDomain"                          : "fancyshirts.com",
  "CurrentStep"                          : "ExampleString",
  "State"                                : "ACTIVE",
  "IsTaxExempt"                          : "true",
  "PaymentProcessorsEnabled"             : "Required",
  "LicenseIncludesDesignStudio"          : "true",
  "Flags"  : 
  {
    "EditProductViews"   : "true"
  },
  "CheckoutPayment"                      : "Required",
  "ProductionDate"                       : "2017-10-30T07:00:00Z",
  "QuoteEmailRecipients"                 : [ExampleString,ExampleString,ExampleString],
  "Fundraiser"  : 
  {
    "PublisherId"            : 1,
    "StoreId"                : 1,
    "StoreName"              : "ExampleString",
    "CurrencySymbol"         : "ExampleString",
    "GoalValue"              : 1,
    "PayoutAmount"           : 3.14,
    "StartDate"              : "2017-10-30T07:00:00Z",
    "PayoutMetricType"       : "",
    "PayoutMetricValue"      : 3.14,
    "DisableWhenGoalMet"     : "true",
    "GoalDescription"        : "ExampleString",
    "ID"                     : 1,
    "GoalType"  : {"Name" : "example not found 2"},
    "EndDate"                : "2017-10-30T07:00:00Z",
    "EndTime"                : "ExampleString",
    "OffsetGmt"              : 1,
    "TimeZoneId"             : 1,
    "DisableOnEndDate"       : "true",
    "NotificationContacts"   : [ExampleString,ExampleString,ExampleString],
    "NotificationEnabled"    : "true",
    "Active"                 : "true",
    "Published"              : "true"
  },
  "FundraiserRemoved"                    : "true",
  "Countdown"  : 
  {
    "ID"                     : 1,
    "GoalType"  : {"Name" : "example not found 2"},
    "EndDate"                : "2017-10-30T07:00:00Z",
    "EndTime"                : "ExampleString",
    "OffsetGmt"              : 1,
    "TimeZoneId"             : 1,
    "DisableOnEndDate"       : "true",
    "NotificationContacts"   : [ExampleString,ExampleString,ExampleString],
    "NotificationEnabled"    : "true",
    "Active"                 : "true",
    "Published"              : "true"
  },
  "Options"  : 
  {
    "AcceptPurchaseOrdersFromAnyone"          : "true",
    "CardOnFile"                              : "true",
    "ACH"                                     : "true",
    "Cart"                                    : "true",
    "CartAddressValidation"                   : "true",
    "CartGiftMessage"                         : "true",
    "CartShipping"                            : "true",
    "Customize"                               : "true",
    "DigitalPrinting"                         : "true",
    "DisplayEstimatedDeliveryDate"            : "true",
    "Embroidery"                              : "true",
    "EnablePurchaseOrderAttachments"          : "true",
    "GiftCertificates"                        : "true",
    "GiftCertificatesStore"                   : "true",
    "PasswordProtected"                       : "true",
    "ProductDetail_DisplayManufacturerData"   : "true",
    "ProductList_DisplaySku"                  : "true",
    "Private"                                 : "true",
    "PrivateBranding"                         : "true",
    "QuickDesigner"                           : "true",
    "QuoteRequestDesignStudio"                : "true",
    "RequireBillingAddress"                   : "true",
    "RequirePurchaseOrderAttachments"         : "true",
    "ShowInventory"                           : "true",
    "ShareOrdersWithPrintavo"                 : "true",
    "InventoryThreshold"                      : 1,
    "SignsAndBanners"                         : "true",
    "UserTieredPricing"                       : "true",
    "SSL"                                     : "true",
    "SSL_Custom"                              : "true",
    "SSL_Shared"                              : "true",
    "RecaptchaSecurity"                       : 3.14,
    "DebitCardEnabled"                        : "true",
    "PayrixCanadaEnabled"                     : "true",
    "CreditCardSurchargeEnabled"              : "true",
    "SurchargeEnabledStore"                   : "true",
    "CreditCardSurchargePercentageAmount"     : 3.14,
    "EnableClientAnalytics"                   : "true"
  },
  "EnabledClientAnalytics"  : 
  [{"Name" : "example not found 2"}
  ],
  "Address"  : 
  {
    "ID"                     : 1000014,
    "StateId"                : 4,
    "CountryId"              : 1,
    "Business"               : "true",
    "TaxExempt"              : "true",
    "FirstName"              : "John",
    "LastName"               : "Doe",
    "Name"                   : "John Doe",
    "CompanyName"            : "Doe Co",
    "Street1"                : "1234 Test St",
    "Street2"                : "Suite 500",
    "City"                   : "Albuquerque",
    "State"                  : "NM",
    "StateName"              : "New Mexico",
    "Country"                : "United States",
    "CountryCode"            : "US",
    "Email"                  : "ExampleString",
    "Phone"                  : "480-309-6332",
    "Fax"                    : "480-309-6333",
    "PostCode"               : "87111",
    "POBox"                  : "true",
    "SaveToAddressBook"      : "true",
    "Type"                   : null,
    "TaxId"                  : null,
    "Department"             : "IT, Sales, Marketing",
    "ShowPickupAtCheckout"   : "true",
    "Validated"              : "true or false",
    "IsPrimaryAddress"       : "true",
    "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
  },
  "PayrixAddress"  : 
  {
    "ID"                     : 1000014,
    "StateId"                : 4,
    "CountryId"              : 1,
    "Business"               : "true",
    "TaxExempt"              : "true",
    "FirstName"              : "John",
    "LastName"               : "Doe",
    "Name"                   : "John Doe",
    "CompanyName"            : "Doe Co",
    "Street1"                : "1234 Test St",
    "Street2"                : "Suite 500",
    "City"                   : "Albuquerque",
    "State"                  : "NM",
    "StateName"              : "New Mexico",
    "Country"                : "United States",
    "CountryCode"            : "US",
    "Email"                  : "ExampleString",
    "Phone"                  : "480-309-6332",
    "Fax"                    : "480-309-6333",
    "PostCode"               : "87111",
    "POBox"                  : "true",
    "SaveToAddressBook"      : "true",
    "Type"                   : null,
    "TaxId"                  : null,
    "Department"             : "IT, Sales, Marketing",
    "ShowPickupAtCheckout"   : "true",
    "Validated"              : "true or false",
    "IsPrimaryAddress"       : "true",
    "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
  },
  "ShippingIntegrationEnabled"           : "true",
  "ShippingMethodIds"                    : [1,2,3],
  "PickupLocations"  : 
  [
    {
      "CarrierId"                      : "ExampleString",
      "CarrierEstimatedDeliveryDate"   : "2017-10-30T07:00:00Z",
      "Description"                    : "UPS Ground",
      "ID"                             : 1000019,
      "Name"                           : "Ground",
      "PackageType"                    : "ExampleString",
      "PackageCode"                    : "ExampleString",
      "RateId"                         : "ExampleString",
      "ServiceCode"                    : "ExampleString",
      "ServiceType"                    : "ExampleString",
      "VendorId"                       : 1000001,
      "VendorName"                     : "UPS",
      "VendorType"                     : "UPS",
      "Price"                          : 5.00,
      "AllowBeforeAddressKnown"        : "true",
      "AllowResidential"               : "true",
      "AllowPoBox"                     : "true",
      "AllowCommercial"                : "true",
      "DiscountingEnabled"             : "true",
      "ProcessDays"                    : 2,
      "PromptForCartShipperAccount"    : "true",
      "RequireCartShipperAccount"      : "true",
      "AllowShippingAddress"           : "true",
      "ProcessMarkup"                  : null,
      "PickupSetAtStoreId"             : null,
      "TransitDays_Min"                : 3,
      "TransitDays_Max"                : 5,
      "RtMarkupDollar"                 : null,
      "RtMarkupPercent"                : null,
      "Address"  : 
      {
        "ID"                     : 1000014,
        "StateId"                : 4,
        "CountryId"              : 1,
        "Business"               : "true",
        "TaxExempt"              : "true",
        "FirstName"              : "John",
        "LastName"               : "Doe",
        "Name"                   : "John Doe",
        "CompanyName"            : "Doe Co",
        "Street1"                : "1234 Test St",
        "Street2"                : "Suite 500",
        "City"                   : "Albuquerque",
        "State"                  : "NM",
        "StateName"              : "New Mexico",
        "Country"                : "United States",
        "CountryCode"            : "US",
        "Email"                  : "ExampleString",
        "Phone"                  : "480-309-6332",
        "Fax"                    : "480-309-6333",
        "PostCode"               : "87111",
        "POBox"                  : "true",
        "SaveToAddressBook"      : "true",
        "Type"                   : null,
        "TaxId"                  : null,
        "Department"             : "IT, Sales, Marketing",
        "ShowPickupAtCheckout"   : "true",
        "Validated"              : "true or false",
        "IsPrimaryAddress"       : "true",
        "SingleLine"             : "Adam Meyer, InkSoft, 1324 Test St, Suite 500 Albuquerque, NM 87111"
      },
      "PickupNotes"                    : null,
      "PickupDateStart"                : "2017-10-30T07:00:00Z",
      "PickupDateEnd"                  : "2017-10-30T07:00:00Z",
      "OffsetGmt"                      : 7,
      "PickupType"  : {"Name" : "example not found 2"},
      "CalculationType"                : "Weight",
      "ShippingSchedules"  : 
      [{"Name" : "example not found 2"}
      ],
      "IsTaxExempt"                    : "true",
      "SortOrder"                      : 1,
      "ShipToStateIds"                 : [1,2,3],
      "IsDeleted"                      : "true",
      "IsProposalPickup"               : "true"
    }
  ],
  "SocialNetworks"  : 
  [
    {
      "ID"                 : 1000001,
      "Name"               : "Facebook",
      "Description"        : "Follow us on Facebook!",
      "Url"                : "https://www.facebook.com/joes-fancy-shirts",
      "StringIdentifier"   : "facebook"
    }
  ],
  "StoreContent"  : 
  {
    "TermsOfUse"             : "ExampleString",
    "PrivacyPolicy"          : "ExampleString",
    "RefundPolicy"           : "ExampleString",
    "DeliveryPolicy"         : "ExampleString",
    "OrderThankYouMessage"   : "ExampleString",
    "PackingSlipFooter"      : "ExampleString",
    "UploadImageTerms"       : "ExampleString"
  },
  "AbandonedCartSettings"  : 
  {
    "EmailDays"   : [1,2,3]
  },
  "StoreEmailNotifications"  : 
  [
    {
      "EmailAddress"                : "ExampleString",
      "DailyOrderSummaries"         : "true",
      "ShippingNotifications"       : "true",
      "InstantOrderNotifications"   : "true",
      "ContactUsNotifications"      : "true",
      "SaveDesignNotifications"     : "true"
    }
  ],
  "CheckoutFields"  : 
  [{"Name" : "example not found 2"}
  ],
  "CurrentLogo"  : {"Name" : "example not found 2"},
  "CurrentHeaderLogo"  : {"Name" : "example not found 2"},
  "CurrentFavicon"  : {"Name" : "example not found 2"},
  "CurrentSocialMediaImage"  : {"Name" : "example not found 2"},
  "StoreCommission"                      : 3.14,
  "SeoSettings"  : 
  [
    {
      "SeoStoreName"          : "ExampleString",
      "SeoStoreDescription"   : "ExampleString",
      "SeoFocusKeyword"       : "ExampleString",
      "Page"                  : "ExampleString",
      "PageId"                : "ExampleString",
      "PageUri"               : "ExampleString",
      "IsDeleted"             : "true"
    }
  ],
  "IsBetaMember"                         : "true",
  "CustomCssFileName"                    : "ExampleString",
  "StoreType"                            : "ExampleString",
  "TaxNexusAddressIds"                   : 1,
  "OrderApprovalSettings"  : 
  {
    "AllOrders"            : "true",
    "DesignOrUpload"       : "true",
    "NotCapturedPayment"   : "true",
    "Amount"               : 3.14
  },
  "ProposalStoreAssignmentEnabledDate"   : "2017-10-30T07:00:00Z",
  "PaymentEnabled"                       : "true",
  "PhoneNumber"                          : "ExampleString"
}

 

StoreDataFlags

A set of (feature) flags for a store.

Properties

  • EditProductViews type: boolean 


{
  "EditProductViews"   : "true"
}

 

StoreEmailNotification

A StoreEmailNotification determines who receives emails when certain events occur

Properties

  • EmailAddress type: string

    The recipient's email address

  • DailyOrderSummaries type: boolean

    True if this recipient should receive a daily email of order summaries

  • ShippingNotifications type: boolean

    True if this recipient should receive an email each time an order ships

  • InstantOrderNotifications type: boolean

    True if this recipient should receive an email each time an order is placed

  • ContactUsNotifications type: boolean

    True if this recipient should receive an email from the contact us form

  • SaveDesignNotifications type: boolean

    True if this recipient should receive an email when a user saves a new design 


{
  "EmailAddress"                : "ExampleString",
  "DailyOrderSummaries"         : "true",
  "ShippingNotifications"       : "true",
  "InstantOrderNotifications"   : "true",
  "ContactUsNotifications"      : "true",
  "SaveDesignNotifications"     : "true"
}

 

StoreOptions

StoreOptions is a collection of options related to a store. Important: All boolean options are in the affirmative and are *enabled when true.

Properties

  • AcceptPurchaseOrdersFromAnyone type: boolean

    True if purchase orders should be accepted from anyone

  • CardOnFile type: (nullable) boolean

    True if card on file functionality is available This is currently a Payrix only feature

  • ACH type: (nullable) boolean

    True if ACH payments is enabled (publisher level) This is currently a Payrix only feature, this flag is managed through the Payment Preferences page

  • Cart type: boolean

    True if shopping cart functionality is enabled

  • CartAddressValidation type: (nullable) boolean

    True if addresses entered during checkout should be validated

  • CartGiftMessage type: boolean

    True if users can enter a gift message during checkout

  • CartShipping type: (nullable) boolean

    True if user can enter shipping information during checkout

  • Customize type: boolean

    True if users can customize products

  • DigitalPrinting type: boolean

    True if digital printing is enabled

  • DisplayEstimatedDeliveryDate type: boolean

    True if the estimated delivery date should be displayed in checkout, receipts, emails, and order manager

  • Embroidery type: boolean

    True if embroider is enabled

  • EnablePurchaseOrderAttachments type: boolean

    True if purchase order attachment are enabled during checkout

  • GiftCertificates type: boolean

    True if gift certificates can be applied to orders

  • GiftCertificatesStore type: boolean

    True if gift certificates are enabled at the store level

  • PasswordProtected type: boolean

    True if the store is password protected

  • ProductDetail_DisplayManufacturerData type: boolean

    True of the product should show manufacturer information (logo and size chart)

  • ProductList_DisplaySku type: boolean

    True if SKU should be displayed in the product list

  • Private type: (nullable) boolean

    True if this store is private (an account is required for access)

  • PrivateBranding type: boolean

    True if private branding is enabled (if not, a Powered by InkSoft logo will appear)

  • QuickDesigner type: (nullable) boolean

    True if the storefront quick designer can be used

  • QuoteRequestDesignStudio type: boolean

    True if Quote Only Design Studios can be used

  • RequireBillingAddress type: (nullable) boolean

    True if billing address is required during checkout

  • RequirePurchaseOrderAttachments type: boolean

    True if an attachment is required when Purchase Order is selected during checkout

  • ShowInventory type: boolean

    True if store should actively show product inventories

  • ShareOrdersWithPrintavo type: boolean

    True if store should actively show product inventories

  • InventoryThreshold type: integer

    Sets minimum threshold for showing a product's inventories in store. If inventory for a given size is below this it will be shown.

  • SignsAndBanners type: boolean

    True if Signage module enabled

  • UserTieredPricing type: boolean

    True if publisher is using JakParints Tiered Pricing

  • SSL type: (nullable) boolean

    True if SSL is enabled

  • SSL_Custom type: boolean

    True if SSL is enabled on a custom domain

  • SSL_Shared type: (nullable) boolean

    True if SSL is enabled on a shared domain

  • RecaptchaSecurity type: decimal

    Recaptcha security threshold The value should be between 0 (off) and 1, using a 0.1 step

  • DebitCardEnabled type: boolean

    True if debit card payments are accepted Used for Payrix Canadian merchants

  • PayrixCanadaEnabled type: boolean

    True if the specific features for Payrix Canada is enabled This flag should be deleted soon, this is needed due to some new features will be also used for non Canadian publishers but need to be hidden for now

  • CreditCardSurchargeEnabled type: boolean

    Publisher's surcharge feature flag True if the publisher has this flag enabled

  • SurchargeEnabledStore type: boolean

    This is a store level setting and it also depends on the publisher's surcharge feature flag True if the publisher and the store has this flag enabled

  • CreditCardSurchargePercentageAmount type: (nullable) decimal

    The publisher's current surcharge amount

  • EnableClientAnalytics type: boolean

    True if the publisher's license allows them to share analytics data with store clients. This is independent of the client analytics feature flag, and is also unrelated to the flags indicating whether a specific user is allowed to see the client analytics. 


{
  "AcceptPurchaseOrdersFromAnyone"          : "true",
  "CardOnFile"                              : "true",
  "ACH"                                     : "true",
  "Cart"                                    : "true",
  "CartAddressValidation"                   : "true",
  "CartGiftMessage"                         : "true",
  "CartShipping"                            : "true",
  "Customize"                               : "true",
  "DigitalPrinting"                         : "true",
  "DisplayEstimatedDeliveryDate"            : "true",
  "Embroidery"                              : "true",
  "EnablePurchaseOrderAttachments"          : "true",
  "GiftCertificates"                        : "true",
  "GiftCertificatesStore"                   : "true",
  "PasswordProtected"                       : "true",
  "ProductDetail_DisplayManufacturerData"   : "true",
  "ProductList_DisplaySku"                  : "true",
  "Private"                                 : "true",
  "PrivateBranding"                         : "true",
  "QuickDesigner"                           : "true",
  "QuoteRequestDesignStudio"                : "true",
  "RequireBillingAddress"                   : "true",
  "RequirePurchaseOrderAttachments"         : "true",
  "ShowInventory"                           : "true",
  "ShareOrdersWithPrintavo"                 : "true",
  "InventoryThreshold"                      : 1,
  "SignsAndBanners"                         : "true",
  "UserTieredPricing"                       : "true",
  "SSL"                                     : "true",
  "SSL_Custom"                              : "true",
  "SSL_Shared"                              : "true",
  "RecaptchaSecurity"                       : 3.14,
  "DebitCardEnabled"                        : "true",
  "PayrixCanadaEnabled"                     : "true",
  "CreditCardSurchargeEnabled"              : "true",
  "SurchargeEnabledStore"                   : "true",
  "CreditCardSurchargePercentageAmount"     : 3.14,
  "EnableClientAnalytics"                   : "true"
}

 

StoreSeo

Properties

  • SeoStoreName type: string

    Store Meta data for the store name, customizable for Seo

  • SeoStoreDescription type: string

    Store Meta data for the store description, customizable for Seo

  • SeoFocusKeyword type: string

    Store Meta data for the store focus keywords customizable for Seo

  • Page type: string

    Store page name

  • PageId type: string

    Store page id for custom pages

  • PageUri type: string

    Store page uri for custom pages

  • IsDeleted type: boolean

    To delete the meta tag 


{
  "SeoStoreName"          : "ExampleString",
  "SeoStoreDescription"   : "ExampleString",
  "SeoFocusKeyword"       : "ExampleString",
  "Page"                  : "ExampleString",
  "PageId"                : "ExampleString",
  "PageUri"               : "ExampleString",
  "IsDeleted"             : "true"
}

 

Supplier

A product manufacturer

Properties

  • ID type: integer

    A unique integer ID for this manufacturer

  • Name type: string

    The name of this manufacturer

  • PriceLevel type: string

    The price level of this supplier

  • ProductCount type: integer

    The number of products associated with this supplier

  • Enabled type: boolean

    True if this supplier is enabled

  • OrderEmailTo type: string

    Email address where the order email needs to go 


{
  "ID"             : 1000001,
  "Name"           : "Gildan",
  "PriceLevel"     : "ExampleString",
  "ProductCount"   : 1,
  "Enabled"        : "true",
  "OrderEmailTo"   : "ExampleString"
}

 

Tag

ProductBase contains a small number of lightweight properties used to quickly search and display contacts. Inherited by [Object:User] for full Contact properties

Properties

  • ID type: integer

    A unique integer ID for the Tag

  • Name type: string

    The Tag Value

  • Count type: (nullable) integer

    Count for Tag 


{
  "ID"      : 1000000,
  "Name"    : "Walter",
  "Count"   : 12
}

 

TaxNexusAddress

Properties

  • ID type: integer

  • LocationName type: string

  • Street1 type: string

  • City type: string

  • StateCode type: string

  • PostalCode type: string

  • CountryCode type: string

  • IsDefault type: boolean 


{
  "ID"             : 1,
  "LocationName"   : "ExampleString",
  "Street1"        : "ExampleString",
  "City"           : "ExampleString",
  "StateCode"      : "ExampleString",
  "PostalCode"     : "ExampleString",
  "CountryCode"    : "ExampleString",
  "IsDefault"      : "true"
}

 

TaxOverrideLocale

Properties

  • TaxRateOverrideId type: integer

    Id for the tax rate override

  • County type: string

    County for the harmonized code

  • State type: State

    State setup for the code

  • Country type: Country

    Country setup for the code

  • City type: string

    City setup for the code

  • PostCode type: string

    Postcode setup for the code

  • TaxRate type: (nullable) decimal

    Tax rate override

  • ShippingTaxable type: boolean

    True if shipping is taxable

  • HarmonizedCode type: string 


{
  "TaxRateOverrideId"   : 1000000,
  "County"              : "Maricopa",
  "State"  : 
  {
    "ID"          : 4,
    "CountryId"   : 1,
    "Code"        : "AZ",
    "Name"        : "Arizona",
    "Tax"         : 0.056000
  },
  "Country"  : 
  {
    "ID"                  : 100001,
    "Code"                : "US",
    "Name"                : "United States",
    "PostCodeSupported"   : "true",
    "PostCodeRequired"    : "true"
  },
  "City"                : "Tempe",
  "PostCode"            : "85281",
  "TaxRate"             : 0.08,
  "ShippingTaxable"     : "true or false",
  "HarmonizedCode"      : "ExampleString"
}

 

Tier

Properties

  • ID type: integer

    A unique integer ID for the Tier

  • Name type: string

    The Tier Value

  • UniqueId type: guid

    The Tier Guid

  • Active type: boolean

    True if the tier is active 


{
  "ID"         : 1000000,
  "Name"       : "Reseller",
  "UniqueId"   : "C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7",
  "Active"     : "true"
}

 

TimelineEntry

Properties

  • EventDescription type: List of key/value pairs with a TimelineEntryEventType as the key and a string as the value

  • ID type: integer

  • ContactIds type: List of integer

  • CompanyIds type: List of integer

  • JobIds type: List of integer

  • OrderIds type: List of integer

  • ProposalIds type: List of integer

  • ProductionCardIds type: List of integer

  • SalesDocGuids type: List of guid

  • Event type: string

  • Comment type: string

  • EventType type: TimelineEntryEventType

  • Edited type: boolean

  • EditedDate type: (nullable) DateTime

  • Deleted type: boolean

  • DeletedDate type: (nullable) DateTime

  • Created type: DateTime

  • CreatedByUserId type: (nullable) integer

  • CreatedByName type: string

  • Details type: List of TimelineEntryDetail

  • Associations type: ICollection 


{
  "EventDescription"    : ,
  "ID"                  : 1,
  "ContactIds"          : [1,2,3],
  "CompanyIds"          : [1,2,3],
  "JobIds"              : [1,2,3],
  "OrderIds"            : [1,2,3],
  "ProposalIds"         : [1,2,3],
  "ProductionCardIds"   : [1,2,3],
  "SalesDocGuids"       : [C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7,C3EE0047-BA6A-46EC-B1B1-0B9B7AC896C7],
  "Event"               : "ExampleString",
  "Comment"             : "ExampleString",
  "EventType"  : {"Name" : "example not found 2"},
  "Edited"              : "true",
  "EditedDate"          : "2017-10-30T07:00:00Z",
  "Deleted"             : "true",
  "DeletedDate"         : "2017-10-30T07:00:00Z",
  "Created"             : "2017-10-30T07:00:00Z",
  "CreatedByUserId"     : 1,
  "CreatedByName"       : "ExampleString",
  "Details"  : 
  [
    {
      "Property"   : "ExampleString",
      "OldValue"   : "ExampleString",
      "NewValue"   : "ExampleString",
      "Date"       : "2017-10-30T07:00:00Z"
    }
  ],
  "Associations"  : {"Name" : "example not found 2"}
}

 

TimelineEntryDetail

Properties

  • Property type: string

  • OldValue type: string

  • NewValue type: string

  • Date type: (nullable) DateTime 


{
  "Property"   : "ExampleString",
  "OldValue"   : "ExampleString",
  "NewValue"   : "ExampleString",
  "Date"       : "2017-10-30T07:00:00Z"
}

 

UserView

Properties

  • UserId type: integer

    The user associated with a view

  • LastViewed type: DateTime

    The time of the last view 


{
  "UserId"       : 1,
  "LastViewed"   : "2017-10-30T07:00:00Z"
}

 

AddCartCoupon

Add a coupon to the cart

Verb

POST

Returns

Success message if successful, error message if not

Visibility
    Public
Parameters

  • CouponCode type: string required

    The coupon code to add to the cart

  • SessionToken type: string required

    The token of the cart session to which the coupon will be added

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • ReturnCart type: boolean optional default value: true

    Return the updated cart

Request
CouponCode

SessionToken

Format

ReturnCart
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/AddCartCoupon',
  dataType: 'text',
  data: 'CouponCode={{CouponCode}}&SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&Format=JSON&ReturnCart=true',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

AddCartGiftCertificate

Add a gift certificate to the cart

Verb

POST

Returns

Success message if successful, error message if not

Visibility
    Public
Parameters

  • GiftCertificateNumber type: string required

    The gift certificate number to be added to the cart

  • SessionToken type: string required

    The token of the cart session to which the gift certificate will be added

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • ReturnCart type: boolean optional default value: true

    Return the updated cart

Request
GiftCertificateNumber

SessionToken

Format

ReturnCart
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/AddCartGiftCertificate',
  dataType: 'text',
  data: 'GiftCertificateNumber={{GiftCertificateNumber}}&SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&Format=JSON&ReturnCart=true',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

ChangeCurrentUserPassword

Change the password of the current user

Verb

POST

Returns

true if successful

Visibility
    Public
Parameters

  • NewPassword type: string required

    The new password for the signed-in user

  • OldPassword type: string required

    The current password for the signed-in user

  • SessionToken type: string required

    The session token for the signed-in user. Required when calling cross-domain or without cookies

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
NewPassword

OldPassword

SessionToken

Format
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/ChangeCurrentUserPassword',
  dataType: 'text',
  data: 'NewPassword={{NewPassword}}&OldPassword={{OldPassword}}&SessionToken=BDDCD916-CCAA-4DA4-946B-558249DB0E05&Format=JSON',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

CreateOrderShipments

Mark the Order As shipped or not

Verb

POST

Returns

True or False

Visibility
    Public
Parameters

  • OrderIds type: List of string required

    Searlized list of orders to mark the shipment

  • TrackingNumber type: string required

    tracking number for the Shipment

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • MarkOrderAsCompleted type: boolean optional default value: false

    Mark the Order as Complete

  • NotifyCustomer type: boolean optional default value: false

    Notify the Customer

  • APIKey type: string optional

    InkSoft API key to use for authentication rather than an existing session

Request
OrderIds

TrackingNumber

Format

MarkOrderAsCompleted

NotifyCustomer

APIKey
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/CreateOrderShipments',
  dataType: 'text',
  data: 'OrderIds={{OrderIds}}&TrackingNumber=1Z204E380338943508&Format=JSON&MarkOrderAsCompleted=true or false&NotifyCustomer=true or false',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

DeleteAddress

Deletes an address from the user's address book.

Verb

Delete

Returns

List of Address

Visibility
    Public
Parameters

  • AddressId type: integer required

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
AddressId

Format
$.ajax({
  type: 'Delete',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/DeleteAddress',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

DesignStudioPrepare

Convert external string IDs for users, products, and styles to internal InkSoft IDs so they can be passed as parameters to the Design Studio

Verb

POST

Returns

DesignStudioPrepareValues

Visibility
    Public
Parameters

  • Parameters type: DesignStudioPrepareParameters required

    A DesignStudioPrepareParameters object

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • APIKey type: string optional

    InkSoft API key to use for authentication rather than an existing session

Request
Parameters

Format

APIKey
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/DesignStudioPrepare',
  dataType: 'text',
  data: 'Parameters={{Parameters}}&Format=JSON',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

DownloadOrderProductionFiles

Download a zip file that contains all art or design files, the packing slip, and the work order for the specified order

Verb

GET

Returns

A response with a zip file content attachment

Visibility
    Public
Parameters

  • OrderId type: integer required

    The ID of the order

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • TimezoneOffset type: (nullable) integer optional

  • APIKey type: string optional

    InkSoft API key to use for authentication rather than an existing session

Request
OrderId

Format

TimezoneOffset

APIKey
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/DownloadOrderProductionFiles?OrderId={{OrderId}}&Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetActiveStores

Get a list of active stores for the current publisher

Verb

GET

Returns

List of Link

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Format
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetActiveStores?Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetAddressBook

Get a list of addresses from the user's address book

Verb

GET

Returns

List of Address

Visibility
    Public
Parameters

  • SessionToken type: string required

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
SessionToken

Format
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetAddressBook?SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetArt

Get a piece of art by art ID.

Verb

GET

Returns

Art

Visibility
    Public
Parameters

  • ArtId type: integer required

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
ArtId

Format
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetArt?ArtId={{ArtId}}&Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetCart

Return a ShoppingCart with supporting data

Verb

GET

Returns

ShoppingCart

Visibility
    Public
Parameters

  • SessionToken type: string required

    The session token of the desired cart

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • TierUniqueId type: string optional

    Tier Unique Id for special pricing

  • ValidateCart type: boolean optional default value: false

    If true the cart will be validated for checkout, this should normally only be called on the cart view.

Request
SessionToken

Format

TierUniqueId

ValidateCart
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetCart?SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&Format=JSON&ValidateCart=false',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetCartPackage

Return a ShoppingCart with supporting data

Verb

GET

Returns

ShoppingCartPackage

Visibility
    Public
Parameters

  • SessionToken type: string required

    The session token of the desired cart

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • TierUniqueId type: string optional

    Tier Unique Id for special pricing

  • ValidateCart type: boolean optional default value: false

    If true the cart will be validated for checkout, this should normally only be called on the cart view.

Request
SessionToken

Format

TierUniqueId

ValidateCart
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetCartPackage?SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&Format=JSON&ValidateCart=false',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetCheckoutSettings

Get checkout settings for the current store

Verb

GET

Returns

CheckoutSettings

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Format
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetCheckoutSettings?Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetClipArtCategories

Get a list of clip art categories for the current store

Verb

GET

Returns

List of Category

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Format
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetClipArtCategories?Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetContacts

Return a list of ContactBase Admin contacts are excluded from the results

Verb

GET

Returns

List of ContactBase

Visibility
    Public
Parameters

  • CompanyIds type: List of integer required

    A serialized list of company ids to be returned

  • ContactIds type: List of integer required

    A serialized list of contact ids to be returned

  • OriginIds type: List of integer required

    A serialized list of origin ids to be returned

  • SearchText type: string required

    If provided, only contacts with string fields that match the specified text will be returned

  • StoreIds type: List of integer required

    A serialized list of store ids to be returned

  • TagIds type: List of integer required

    A serialized list of tag ids to be returned

  • FilterWithoutRole type: string optional

    If null, no filtering is done. If provided, will only return contacts that don't have the role

  • FilterWithRole type: string optional

    If null, no filtering is done. If provided, will only return contacts that have the role

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • IncludeAllAddresses type: boolean optional default value: false

    If true, all addresses for each contact will be returned. Otherwise, only the primary address for each contact will be included

  • IncludeAllContacts type: boolean optional default value: true

  • Index type: (nullable) integer optional

    The starting index of the raw result list

  • MaxResults type: integer optional default value: 100

    The maximum number of results to be returned

  • ModifiedDateRange type: DateTime optional

    A DateTimeRange specifying that only contacts created or modified during this range should be returned.

  • OrderBy type: string optional

    The field by which results should be ordered

  • OrderByDirection type: string optional default value: ascending

    Ascending or Descending

  • APIKey type: string optional

    InkSoft API key to use for authentication rather than an existing session

Request
CompanyIds

ContactIds

OriginIds

SearchText

StoreIds

TagIds

FilterWithoutRole

FilterWithRole

Format

IncludeAllAddresses

IncludeAllContacts

Index

MaxResults

ModifiedDateRange

OrderBy

OrderByDirection

APIKey
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetContacts?CompanyIds={{CompanyIds}}&ContactIds={{ContactIds}}&OriginIds={{OriginIds}}&SearchText={{SearchText}}&StoreIds={{StoreIds}}&TagIds={{TagIds}}&Format=JSON&IncludeAllAddresses=false&IncludeAllContacts=true&MaxResults=100&OrderByDirection=ascending',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetCountries

Get a list of states for the current store (billing or shipping)

Verb

GET

Returns

List of Country

Visibility
    Public
Parameters

  • ShippingBilling type: string required

    'Shipping', 'Billing', or empty to indicate which state list. Empty ShippingBilling returns all

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
ShippingBilling

Format
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetCountries?ShippingBilling={{ShippingBilling}}&Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetDesignCategories

Get all design categories for the store

Verb

GET

Returns

List of Category

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • IncludeDigital type: (nullable) boolean optional

    True if digital designs should be included, false if they should be excluded, and null if filtering should not be applied

  • IncludeEmbroidery type: (nullable) boolean optional

    True if embroidery designs should be included, false if they should be excluded, and null if filtering should not be applied

  • IncludeVector type: (nullable) boolean optional

    True if vector designs should be included, false if they should be excluded, and null if filtering should not be applied

  • MaxColors type: (nullable) integer optional

    The maximum number of design colors that should be included (null if this filter should not be applied)

Request
Format

IncludeDigital

IncludeEmbroidery

IncludeVector

MaxColors
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetDesignCategories?Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetDesignSummaries

Return a list of design summaries for all designs in a given category.

Verb

GET

Returns

List of DesignSummary

Visibility
    Public
Parameters

  • DesignCategoryId type: (nullable) integer optional

    The ID of the design category from which to retrieve design summaries

  • FilterText type: string optional

    The search text to filter designs by (null if this filter should not be applied)

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • IncludeDigital type: (nullable) boolean optional

    True if digital designs should be included, false if they should be excluded, and null if filtering should not be applied

  • IncludeEmbroidery type: (nullable) boolean optional

    True if embroidery designs should be included, false if they should be excluded, and null if filtering should not be applied

  • IncludeVector type: (nullable) boolean optional

    True if vector designs should be included, false if they should be excluded, and null if filtering should not be applied

  • MaxColors type: (nullable) integer optional

    The maximum number of design colors that should be included (null if this filter should not be applied)

Request
DesignCategoryId

FilterText

Format

IncludeDigital

IncludeEmbroidery

IncludeVector

MaxColors
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetDesignSummaries?Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetDesignSummary

Return the design summary for a single design. Typically called after an end-user saves a design and the DS forwards to an external site. This method can be used to retrieve all images and art associated with the design so the external site can show pricing, previews, etc.

Verb

GET

Returns

DesignSummary

Visibility
    Public
Parameters

  • DesignId type: integer required

    The ID of the design

  • GetNotes type: boolean required default value: false

    True if notes should be included

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • GetCanvasPlacements type: boolean optional default value: true

  • GetColors type: boolean optional default value: false

    True if colors should be included

  • GetRegions type: boolean optional default value: false

    True if regions should be included

Request
DesignId

GetNotes

Format

GetCanvasPlacements

GetColors

GetRegions
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetDesignSummary?DesignId={{DesignId}}&GetNotes=false&Format=JSON&GetCanvasPlacements=true&GetColors=false&GetRegions=false',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetDesignsForUser

Return a list of design details for all designs associated with a given user

Verb

GET

Returns

List of DesignSummary

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • IncludeDigital type: boolean optional default value: true

    True if digital designs should be included, false if they should be excluded

  • IncludeEmbroidery type: boolean optional default value: true

    True if embroidery designs should be included, false if they should be excluded

  • IncludeVector type: boolean optional default value: true

    True if vector designs should be included, false if they should be excluded

  • MaxColors type: (nullable) integer optional

    The maximum number of design colors that should be included (null if this filter should not be applied)

  • UserId type: (nullable) integer optional

    The ID of the user

Request
Format

IncludeDigital

IncludeEmbroidery

IncludeVector

MaxColors

UserId
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetDesignsForUser?Format=JSON&IncludeDigital=true&IncludeEmbroidery=true&IncludeVector=true',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetGiftCertificateOrderHistory

Get a list of orders placed with the specified gift certificate

Verb

GET

Returns

List of Order

Visibility
    Public
Parameters

  • GiftCertificateNumber type: string required

    The number of the gift certificate

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
GiftCertificateNumber

Format
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetGiftCertificateOrderHistory?GiftCertificateNumber={{GiftCertificateNumber}}&Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetLookups

Returns a list of ID/description pairs that are suitable for using in dropdowns or other select lists.

Verb

GET

Returns

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • LookupList type: string optional

    A comma-separated string indicating the desired lookups. If null, all lookups will be returned. The available options are SUPPLIERS, DECORATION_METHODS, GENDERS, AGE_GROUPS, COUNTRIES, HARMONIZED_SYSTEM_CODES, SCREEN_PRINT_METHODS, DIGITAL_PRINT_METHODS, and COLOR_TYPES

Request
Format

LookupList
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetLookups?Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetManufacturers

Get a list of manufacturers for the current publisher

Verb

GET

Returns

List of Manufacturer

Visibility
    Public
Parameters

  • BlankProducts type: boolean optional default value: false

    True if a manufacturer must have non-static products to be included in the list

  • CurrentStoreOnly type: boolean optional default value: false

    True if manufacturer must have products in the current store to be included in the list

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • ProductType type: string optional default value: standard

    "standard" if a manufacturer must have apparel products to be included in the list. "banner" if a supplier must have signs and banner products to be included in the list. Null if product type should not be a factor in which suppliers are returned.

  • StaticProducts type: boolean optional default value: false

    True if a manufacturer must have static products to be included in the list

Request
BlankProducts

CurrentStoreOnly

Format

ProductType

StaticProducts
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetManufacturers?BlankProducts=false&CurrentStoreOnly=false&Format=JSON&ProductType=standard&StaticProducts=false',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetOrCreateSession

Create a new session, or get one based on the session info passed in via cookie.

Verb

POST

Returns

Session

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Format
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetOrCreateSession',
  dataType: 'text',
  data: 'Format=JSON',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetOrCreateSessionWithApiKey

Get or create a user by e-mail address and return the user's session token. This method is only available with an API key. This is useful for single-sign-on scenarios such as passing a credential to the design studio.

Verb

POST

Returns

Session

Visibility
    Public
Parameters

  • ApiKey type: string required

    The publisher's secret API key

  • Email type: string required

    The e-mail address or other unique identifier of the user to be created and returned

  • CreateNewCart type: boolean optional default value: false

    If true, any previous sessions and carts for the user will be ignored, and a new session with a new cart is returned. This option is not available when PreviousSessionToken is supplied.

  • FirstName type: string optional

    If there is no user with a matching email, one will be created with this first name

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • LastName type: string optional

    If there is no user with a matching email, one will be created with this last name

  • Password type: string optional

    If there is no user with a matching email, one will be created with this password

  • PreviousSessionToken type: string optional

    If this is supplied, any saved art, designs, and carts will be transfered from this session token to the new session (and user). This is useful if you are implementing single sign on in the design studio and a user logs-in after creating a design or cart.

Request
ApiKey

Email

CreateNewCart

FirstName

Format

LastName

Password

PreviousSessionToken
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetOrCreateSessionWithApiKey',
  dataType: 'text',
  data: 'ApiKey={{ApiKey}}&Email=test@inksoft.com&CreateNewCart=false&FirstName=John&Format=JSON&LastName=Doe&Password=MySecretPassword33221',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetOrder

Retrieve an Order given an order ID. Only available via API Key. Deprecated, please use GetOrderPackage instead.

Verb

GET

Returns

Order

Visibility
    Public
Parameters

  • OrderEmail type: string required

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • IncludeProductionCards type: boolean optional default value: false

    If true, include related ProductionCards with Order

  • OrderId type: (nullable) integer optional

    The ID of the desired order

  • APIKey type: string optional

    InkSoft API key to use for authentication rather than an existing session

Request
OrderEmail

Format

IncludeProductionCards

OrderId

APIKey
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetOrder?OrderEmail=damian@inksoft.com&Format=JSON&IncludeProductionCards=false&OrderId=1000015',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetOrderPackage

Retrieve an order with supporting data

Verb

GET

Returns

OrderPackage

Visibility
    Public
Parameters

  • OrderIds type: string required

    List of friendly/reference Order IDs and/or Order GUIDs to be included in this package

  • APIKey type: string optional

    InkSoft API key to use for authentication rather than an existing session

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • IncludeCosts type: boolean optional default value: false

    True if Product.Cost should be returned (user must be logged-in as a store admin)

  • IncludePricing type: boolean optional default value: false

    True if pricing information should be included

  • IncludeProductionCards type: boolean optional default value: false

    If true, include related ProductionCards with Order

  • IncludeSizeDetails type: boolean optional default value: false

    If true, include GTIN for each style size in the order

  • IncludeStyleCounts type: boolean optional default value: false

    If true, include the style counts of each product in the order

  • OrderEmail type: string optional

    Email address saved with the order. Required unless publisher admin (or higher) is authenticated, a valid api key is provided, and/or the given OrderIds are Guids

  • SessionToken type: string optional

    A session token associated with the order user

Request
OrderIds

APIKey

Format

IncludeCosts

IncludePricing

IncludeProductionCards

IncludeSizeDetails

IncludeStyleCounts

OrderEmail

SessionToken
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetOrderPackage?OrderIds=[1000015,1000016,13134E5E-5675-4849-9525-245244139053]&Format=JSON&IncludeCosts=false&IncludePricing=false&IncludeProductionCards=false&IncludeSizeDetails=false&IncludeStyleCounts=false&OrderEmail=damian@inksoft.com&SessionToken=0F154E5E-5675-4849-9525-24524413905D',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetOrderSummaries

Return a list of order summaries

Verb

GET

Returns

List of OrderSummary

Visibility
    Public
Parameters

  • AssigneeIds type: string optional

    A serialized list of assignee IDs. Orders that do not match specified stores will be excluded

  • ConfirmedShipDateRange type: string optional

    A serialized representation of a DateTimeRange in the specified format

  • DateCreatedRange type: string optional

    A serialized representation of a DateTimeRange in the specified format

  • DateModifiedRange type: string optional

    A DateTimeRange specifying that only orders created or modified during this range should be returned.

  • DeliveryMethods type: string optional

    A serialized list order delivery methods ('Pickup', 'Shipping', 'None'). Orders that do not match specified types will be excluded

  • DueDateRange type: string optional

    A serialized DateTimeRange

  • EstimatedShipDateRange type: string optional

    A serialized representation of a DateTimeRange in the specified format

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • IncludeProductionCards type: boolean optional default value: false

    True if production cards should be included (excluding order notes, items, etc)

  • Index type: (nullable) integer optional

    The starting index of the raw result list

  • MaxResults type: (nullable) integer optional default value: 50

    The maximum number of results to return

  • OrderBy type: string optional default value: ID

    The property by which the results should be ordered ('ID', 'Name', 'FirstName', 'LastName', 'ShippingMethod', 'EstimatedShipDate', 'StoreName', 'DateCreated', 'DateShipped', 'TotalAmount', 'PaymentStatus', 'ProductionStatus', 'Email')

  • OrderByDirection type: string optional default value: Ascending

    Ascending or Descending

  • OrdersAfterId type: (nullable) integer optional

    If specified, only orders that were placed after the one corresponding to this ID will be used. This is useful for situations where the api consumer is polling for new messages.

  • OrderTypes type: string optional

    A serialized list of order types ('WebOrder', 'Invoice', 'Proposals'). Orders that do not match specified types will be excluded

  • Organizations type: string optional

    A serialized representation of a string list. Orders that do not match specified organizations will be excluded

  • PaymentStatuses type: string optional

    A serialized list of payment statuses ('PAID', 'PARTIAL', 'NOT PAID', 'REFUND DUE'). Orders that do not match specified types will be excluded

  • ProductionStatuses type: string optional

    A serialized list of production statuses ('Canceled', 'Completed', 'Open', 'ReadyForPickup', 'ReadyToShip', 'Scheduled', 'InProduction'). Orders that do not match specified production statuses will be excluded

  • SearchText type: string optional

    A string to compare against order summaries, will search across: Order Id , Store Name, Organization, Customer Name, Customer Email Address.

  • ShippingMethodIds type: string optional

    A serialized list of shipping method IDs. Orders that do not match specified shipping methods will be excluded

  • ShippingVendorNames type: string optional

    A serialized list of shipping vendor Names. Orders that do not match the specified shipping vendor names will be excluded

  • Status type: string optional

    If set, only orders matching the specified status will be returned. If null, orders of any status will be returned

  • StoreIds type: string optional

    A serialized list of store IDs. Orders that do not match specified stores will be excluded

  • APIKey type: string optional

    InkSoft API key to use for authentication rather than an existing session

Request
AssigneeIds

ConfirmedShipDateRange

DateCreatedRange

DateModifiedRange

DeliveryMethods

DueDateRange

EstimatedShipDateRange

Format

IncludeProductionCards

Index

MaxResults

OrderBy

OrderByDirection

OrdersAfterId

OrderTypes

Organizations

PaymentStatuses

ProductionStatuses

SearchText

ShippingMethodIds

ShippingVendorNames

Status

StoreIds

APIKey
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetOrderSummaries?Format=JSON&IncludeProductionCards=false&MaxResults=50&OrderBy=ID&OrderByDirection=Ascending',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetPaymentGateways

Get a list of payment gateway methods for the current publisher

Verb

GET

Returns

List of PaymentGateway

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • IncludeAll type: boolean optional default value: false

    Include all payment gateways even they are disabled on the cart settings

  • IncludeInActive type: boolean optional default value: false

    Include Inactive Payment Gateways or not

Request
Format

IncludeAll

IncludeInActive
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetPaymentGateways?Format=JSON&IncludeAll=true or false&IncludeInActive=true or false',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetPaymentMethodIcons

Get a list of payment method icons for the current store

Verb

GET

Returns

List of Link

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Format
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetPaymentMethodIcons?Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetPaymentMethods

Get a list of payment methods for the current publisher

Verb

GET

Returns

List of PaymentMethod

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Format
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetPaymentMethods?Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetProduct

Get the specified product in the desired format

Verb

GET

Returns

Product

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • IncludeAllPublisher type: boolean optional default value: false

    When true, if the product is not assigned to the store it will return all the styles

  • IncludeCategories type: boolean optional default value: false

  • IncludeCosts type: boolean optional default value: false

    True if ProductBase.Cost should be returned (user must be logged-in as a store admin).

  • IncludePricing type: boolean optional default value: false

    When true, pricing information will be included with each product

  • IncludeQuantityPacks type: boolean optional default value: false

    When true, includes all the quantity packs for the product

  • IncludeStorePurchaseOptionOverrides type: boolean optional default value: true

    True if overrides for BuyBlank, DesignOnline and DesignDetailsForm should be included from the active store

  • ProductId type: (nullable) integer optional

    The ID of the product to retrieve

  • TierUniqueId type: string optional

    Unique Id for the User Tier

Request
Format

IncludeAllPublisher

IncludeCategories

IncludeCosts

IncludePricing

IncludeQuantityPacks

IncludeStorePurchaseOptionOverrides

ProductId

TierUniqueId
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetProduct?Format=JSON&IncludeAllPublisher=false&IncludeCategories=false&IncludeCosts=false&IncludePricing=false&IncludeQuantityPacks=false&IncludeStorePurchaseOptionOverrides=true',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetProductBaseList

Return a list of ProductBase

Verb

GET

Returns

List of ProductBase

Visibility
    Public
Parameters

  • AddBlankProducts type: boolean optional default value: false

    True if blank products should be added for each product where sku does not match manufacturer sku

  • BuyBlank type: (nullable) boolean optional

  • CanDigitalPrint type: (nullable) boolean optional

    (Deprecated - use DecorationMethods instead) If true, only products/styles that can be digitally printed are returned

  • CanEmbroider type: (nullable) boolean optional

    (Deprecated - use DecorationMethods instead) If true, only products/styles that can be embroidered are returned

  • CanScreenPrint type: (nullable) boolean optional

    (Deprecated - use DecorationMethods instead) If true, products/styles that can be screen printed are returned

  • ColorTypes type: List of ProductColorType optional

    A list of color types to filter the returned products. Available color types are 'Light', 'Dark', and 'Heathered'

  • DecorationMethods type: string optional

    A list of DecorationMethods (DigitalPrint, ScreenPrint, or Embroidery) to filter the returned products and styles

  • DesignDetailsForm type: (nullable) boolean optional

  • DesignOnline type: (nullable) boolean optional

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • HasProductArt type: (nullable) boolean optional

    A bool to check if the product has rpc product art

  • IncludeActiveProducts type: boolean optional default value: true

    If true, active products will be returned. Otherwise, they will be excluded. Defaults to true.

  • IncludeActiveStyles type: boolean optional default value: true

    If true, inactive styles will be returned. Otherwise, they will be excluded. Defaults to false.

  • IncludeAllPublisherProducts type: boolean optional default value: false

    True if all products for the current publisher should be included. By default, only products from the current store will be included

  • IncludeAllSides type: boolean optional default value: false

    True if images for all sides should be returned (instead of just the default one). This does not affect product regions

  • IncludeAllStyles type: boolean optional default value: false

    True if all ProductStyleBases should be included for each ProductBase. If false, only the default style will be included for each ProductBase

  • IncludeBrandImageUrl type: boolean optional default value: false

    True if Manufacturer Brand image url should be included for all the product

  • IncludeCategories type: boolean optional default value: false

    True if ProductBase.Categories should be returned

  • IncludeCosts type: boolean optional default value: false

    True if ProductBase.Cost should be returned (user must be logged-in as a store admin)

  • IncludeDeletedSizes type: boolean optional default value: false

  • IncludeInactiveProducts type: boolean optional default value: false

    If true, inactive products will be returned. Otherwise, they will be excluded. Defaults to false.

  • IncludeInactiveSizes type: boolean optional default value: false

  • IncludeInactiveStyles type: boolean optional default value: false

    If true, active styles will be returned. Otherwise, they will be excluded. Defaults to true.

  • IncludeInventories type: boolean optional default value: false

  • IncludeKeywords type: boolean optional default value: false

    True if ProductBase.Keywords should be returned

  • IncludeLongDescription type: boolean optional default value: false

  • IncludePersonalizations type: boolean optional default value: false

    True if personalizations should be included for each product. If false, Personalizations will be null for each product

  • IncludePriceRuleDiscounts type: boolean optional default value: false

    True if PriceRuleMarkups (pricing rule schedules) or PriceRuleDiscounts (quantity discount schedules) should be included for each ProductBase

  • IncludePrices type: boolean optional default value: false

    True if ProductBase.UnitPrice and ProductStyle.UnitPrice should be returned. This is forced to false if multiple StoreIds are provided

  • IncludeProductHasOrders type: boolean optional default value: false

  • IncludeQuantityPacks type: boolean optional default value: false

    True if we should send all the quantity packs with the Products

  • IncludeRegions type: boolean optional default value: false

    True if ProductSides should be included (for each ProductStyleBase). If false, styles will not be included

  • IncludeSizeCharts type: boolean optional default value: false

    If true, the products' . Defaults to false.

  • IncludeSizeDetails type: boolean optional default value: false

    True if ProductSizeDetails should be included for each ProductStyleSize

  • IncludeSizes type: boolean optional default value: false

    True if ProductStyleSizes should be included for each ProductStyleBase. If false, styles will not be included

  • IncludeStoreIds type: boolean optional default value: false

    True if a list of store IDs matching styles should be returned for each product. If false, StoreIds will be null for each product

  • IncludeStyleCounts type: boolean optional default value: false

    True if the number of matching styles should be returned for each product. If false, StyleCount will be null for each product

  • IncludeStyleSizeToStores type: boolean optional default value: false

  • Index type: (nullable) integer optional

    The starting index of the raw result list

  • ManufacturerIds type: List of integer optional

    A list of manufacturer IDs to filter the returned products

  • MaxResults type: (nullable) integer optional

    The maximum number of results desired

  • Predecorated type: (nullable) boolean optional

    True if only predecorated products should be included, false if they should be excluded, null if both types should be included

  • PricingStoreId type: (nullable) integer optional

    Used in conjunction with IncludeAllPublisherProducts = true, the ID of the store that pricing should come from (if store-specific pricing exists).

  • ProductCategoryIds type: List of integer optional

    A list of product category IDs to filter the returned products

  • ProductIds type: List of integer optional

    A list of product IDs to filter the returned products

  • ProductTypes type: List of ProductType optional

    A list of product types to filter the returned products. Available product types are 'Standard' and 'SignBanner'

  • SearchFilter type: string optional

    [Deprecated - use other filter parameters instead] - A serialized representation of a SearchFilterGroup, in the specified format

  • SearchText type: string optional

    A string with a search phrase, such as 'gildan shirt'

  • SkuStyles type: List of key/value pairs with a string as the key and a List of string as the value optional

    A list of key/value pairs representing product skus and style names that should be included

  • SortFilters type: List of SortFilter optional

    A serialized representation of a list of SortFilters (in the specified format), to be applied in order

  • StoreIds type: List of integer optional

    A list of store IDs to filter the returned products

  • SupplierIds type: List of integer optional

    A list of supplier IDs to filter the returned products

  • TierUniqueId type: string optional

Request
AddBlankProducts

BuyBlank

CanDigitalPrint

CanEmbroider

CanScreenPrint

ColorTypes

DecorationMethods

DesignDetailsForm

DesignOnline

Format

HasProductArt

IncludeActiveProducts

IncludeActiveStyles

IncludeAllPublisherProducts

IncludeAllSides

IncludeAllStyles

IncludeBrandImageUrl

IncludeCategories

IncludeCosts

IncludeDeletedSizes

IncludeInactiveProducts

IncludeInactiveSizes

IncludeInactiveStyles

IncludeInventories

IncludeKeywords

IncludeLongDescription

IncludePersonalizations

IncludePriceRuleDiscounts

IncludePrices

IncludeProductHasOrders

IncludeQuantityPacks

IncludeRegions

IncludeSizeCharts

IncludeSizeDetails

IncludeSizes

IncludeStoreIds

IncludeStyleCounts

IncludeStyleSizeToStores

Index

ManufacturerIds

MaxResults

Predecorated

PricingStoreId

ProductCategoryIds

ProductIds

ProductTypes

SearchFilter

SearchText

SkuStyles

SortFilters

StoreIds

SupplierIds

TierUniqueId
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetProductBaseList?AddBlankProducts=false&Format=JSON&IncludeActiveProducts=true&IncludeActiveStyles=true&IncludeAllPublisherProducts=false&IncludeAllSides=false&IncludeAllStyles=false&IncludeBrandImageUrl=false&IncludeCategories=false&IncludeCosts=false&IncludeDeletedSizes=false&IncludeInactiveProducts=false&IncludeInactiveSizes=false&IncludeInactiveStyles=false&IncludeInventories=false&IncludeKeywords=false&IncludeLongDescription=false&IncludePersonalizations=false&IncludePriceRuleDiscounts=false&IncludePrices=false&IncludeProductHasOrders=false&IncludeQuantityPacks=false&IncludeRegions=false&IncludeSizeCharts=false&IncludeSizeDetails=false&IncludeSizes=false&IncludeStoreIds=false&IncludeStyleCounts=false&IncludeStyleSizeToStores=false',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetProductCategories

Get a list of product categories for the current store

Verb

GET

Returns

List of Category

Visibility
    Public
Parameters

  • BlankProducts type: boolean optional default value: false

    True if a category must have non-static products to be included in the list

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • GetProductIds type: boolean optional default value: true

    True if the product IDs associated with each category should be ad

  • HierarchicalItemCount type: boolean optional default value: true

    True if the ItemCount property for each category should include the item count for child categories as well as the top category

  • IncludeAllPublisherCategories type: boolean optional default value: false

    True if all categories for the publisher should be included

  • ProductType type: string optional default value: standard

    If "banner" or "standard", a product category must have a product of the correct product type to be included in the list. Not valid when IncludeAllPublisherCategories is true. "all" will return all types of products.

  • StaticProducts type: boolean optional default value: false

    True if a category must have static products to be included in the list

Request
BlankProducts

Format

GetProductIds

HierarchicalItemCount

IncludeAllPublisherCategories

ProductType

StaticProducts
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetProductCategories?BlankProducts=false&Format=JSON&GetProductIds=true&HierarchicalItemCount=true&IncludeAllPublisherCategories=false&ProductType=standard&StaticProducts=false',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetProductImages

Get the default product images for a particular product.

Verb

GET

Returns

Product

Visibility
    Public
Parameters

  • ProductId type: integer required

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • IncludeDeletedStyles type: boolean optional default value: false

  • IncludeInActiveStyles type: boolean optional default value: false

  • ProductStyleId type: (nullable) integer optional

Request
ProductId

Format

IncludeDeletedStyles

IncludeInActiveStyles

ProductStyleId
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetProductImages?ProductId={{ProductId}}&Format=JSON&IncludeDeletedStyles=false&IncludeInActiveStyles=false',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetQuote

Get a quote for product and decoration pricing

Verb

POST

Returns

List of PrintedProductPrice

Visibility
    Public
Parameters

  • QuoteItems type: string required

    A serialized representation of a list of PricedQuoteItems in the specified format

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • OverridePricingError type: boolean optional default value: false

    Will be true when overriding pricing error when no valid print grids are fround for pricing

  • StoreId type: (nullable) integer optional

  • TierUniqueId type: string optional

    Tier Unique for the user special pricing

Request
QuoteItems

Format

OverridePricingError

StoreId

TierUniqueId
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetQuote',
  dataType: 'text',
  data: 'QuoteItems={{QuoteItems}}&Format=JSON&OverridePricingError=false',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetSession

Retrieve a user session given a session token

Verb

GET

Returns

Session

Visibility
    Public
Parameters

  • SessionToken type: string required

    The GUID token of the session to be retrieved

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
SessionToken

Format
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetSession?SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetSessionData

Get session data for the current user

Verb

GET

Returns

SessionData

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Format
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetSessionData?Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetShippingMethods

Get a list of shipping methods for the current store. Some shipping methods and prices are only available after items have been added to the cart and the shipping address has been set. The session must have a valid shipping address or shipping methods will not be available.

Verb

GET

Returns

List of ShippingMethod

Visibility
    Public
Parameters

  • SessionToken type: string required

    The session token of the active user. Required if SessionId is not provided

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • From type: string optional

Request
SessionToken

Format

From
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetShippingMethods?SessionToken=D10D2336-CB97-41E3-A15F-5716965CDF5C&Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetStates

Get a list of states for the current store (billing or shipping) in XML or JSON format

Verb

GET

Returns

List of State

Visibility
    Public
Parameters

  • ShippingBilling type: string required

    'Shipping'. 'Billing' or blank to indicate which state list. Blank returns all

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
ShippingBilling

Format
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetStates?ShippingBilling={{ShippingBilling}}&Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetStoreContent

Return the specified custom content

Verb

GET

Returns

string

Visibility
    Public
Parameters

  • Name type: string required

    The name of the custom content

  • FallBackOnPublisher type: boolean optional default value: false

    Use the corresponding publisher content region if the store region is null

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Name

FallBackOnPublisher

Format
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetStoreContent?Name=PrivacyContent&FallBackOnPublisher=false&Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetStoreData

Get store data for the current store

Verb

GET

Returns

StoreData

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • StoreId type: (nullable) integer optional

Request
Format

StoreId
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetStoreData?Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetSuppliers

Get a list of suppliers for the current publisher

Verb

GET

Returns

List of Supplier

Visibility
    Public
Parameters

  • BlankProducts type: boolean optional default value: false

    True if a supplier must have non-static products to be included in the list

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • IncludeAll type: boolean optional default value: false

    True if all active suppliers should be included even if no products are available. Note: If IncludeAll is true, it will override Staticproducts, BlankProducts and ProductType

  • ProductType type: string optional default value: standard

    "standard" if a supplier must have apparel products to be included in the list. "banner" if a supplier must have signs and banner products to be included in the list. Null if product type should not be a factor in which suppliers are returned.

  • StaticProducts type: boolean optional default value: false

    True if a supplier must have static products to be included in the list

Request
BlankProducts

Format

IncludeAll

ProductType

StaticProducts
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetSuppliers?BlankProducts=false&Format=JSON&IncludeAll=true or false&ProductType=standard&StaticProducts=false',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetTaxNexusAddresses

Get a list of all publisher tax nexus addresses

Verb

GET

Returns

List of TaxNexusAddress

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Format
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetTaxNexusAddresses?Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetTotalProductPrice

Gets the total product price of a product with design or art

Verb

GET

Returns

OK if successful

Visibility
    Public
Parameters

  • ProductId type: integer required

    ID of the product to return the price of

  • ProductStyleId type: integer required

    ID of the product style to return the price of

  • ProductStyleSizes type: string required

    A disctionary of ids and quantities of the product style sizes to return the prices of

  • ArtId type: (nullable) integer optional

    ID of the art on the product to return the price of

  • DesignId type: (nullable) integer optional

    ID of the design on the product to return the price of

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • StoreId type: (nullable) integer optional

    ID of the store which the assigned product's price will be returned

Request
ProductId

ProductStyleId

ProductStyleSizes

ArtId

DesignId

Format

StoreId
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetTotalProductPrice?ProductId={{ProductId}}&ProductStyleId={{ProductStyleId}}&ProductStyleSizes={{ProductStyleSizes}}&Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

GetUserGiftCertificates

Get a list of gift certificates assigned to the current user

Verb

GET

Returns

List of GiftCertificate

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Format
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/GetUserGiftCertificates?Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

IsSignedIn

Validate user is still logged in and return current session

Verb

POST

Returns

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Format
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/IsSignedIn',
  dataType: 'text',
  data: 'Format=JSON',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

Register

Register a new user

Verb

POST

Returns

Session

Visibility
    Public
Parameters

  • ConfirmPassword type: string required

    A confirmation of the password provided

  • Email type: string required

    The email of the user to be registered

  • FirstName type: string required

    The first name of the user to be registered

  • LastName type: string required

    The last name of the user to be registered

  • Password type: string required

    The password of the user to be registered

  • SessionToken type: string required

    A valid user session token

  • TaxIdNumber type: string required

    The individual's Tax ID, if applicable

  • TaxResellerNumber type: string required

    The individual's Tax Reseller Number, if applicable

  • CaptchaKey type: string optional

    For InkSoft internal use only. Required if APIKey is not provided.

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • NonTaxable type: boolean optional default value: false

    Set to true if the user is tax exempt

  • OrderId type: (nullable) integer optional

    Set the user id to the new order. For the guest checkout, we want to link their order with the account.

  • RememberMe type: boolean optional default value: false

    Set to true to create a persistent cookie

  • SubscribeToNewsletter type: boolean optional default value: false

    Set to true to subscribe to the newsletter

Request
ConfirmPassword

Email

FirstName

LastName

Password

SessionToken

TaxIdNumber

TaxResellerNumber

CaptchaKey

Format

NonTaxable

OrderId

RememberMe

SubscribeToNewsletter
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/Register',
  dataType: 'text',
  data: 'ConfirmPassword=MySecretPassword33221&Email=test@inksoft.com&FirstName=John&LastName=Doe&Password=MySecretPassword33221&SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&TaxIdNumber=123-23-1111&TaxResellerNumber=1234&CaptchaKey=C92v3dE&Format=JSON&NonTaxable=false&OrderId=1000000&RememberMe=true&SubscribeToNewsletter=true',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

RemoveCartCoupon

Remove any coupon / promo code from the cart. Only one coupon can be applied at a time, so there is no need to specify.

Verb

POST

Returns

Success message if successful, error message if not

Visibility
    Public
Parameters

  • SessionToken type: string required

    The token of the cart session from which to remove the coupon

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • ReturnCart type: boolean optional default value: false

    True if the updated cart should be returned

Request
SessionToken

Format

ReturnCart
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/RemoveCartCoupon',
  dataType: 'text',
  data: 'SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&Format=JSON&ReturnCart=false',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

RemoveCartGiftCertificate

Remove a gift certificate from the cart

Verb

POST

Returns

Success message if successful, error message if not

Visibility
    Public
Parameters

  • GiftCertificateNumber type: string required

    The gift certificate number to be removed from the cart

  • SessionToken type: string required

    The token of the cart session from which the gift certificate will be removed

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • ReturnCart type: boolean optional default value: true

    Return the updated cart

Request
GiftCertificateNumber

SessionToken

Format

ReturnCart
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/RemoveCartGiftCertificate',
  dataType: 'text',
  data: 'GiftCertificateNumber={{GiftCertificateNumber}}&SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&Format=JSON&ReturnCart=true',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

RenderDesignNow

Render a design to all the formats set up in store settings synchronously. May take a significant amount of time. This method requires a logged-in admin or an api key, or the user that's making the request must match the user that saved the design.

Verb

POST

Returns

RenderDesignResult

Visibility
    Public
Parameters

  • DesignId type: integer required

    The ID of the design to render

  • Email type: string optional

    The unique user name (usually an e-mail address) that is requesting the render, for logging purposes. This should be a valid user in the InkSoft system.

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • APIKey type: string optional

    InkSoft API key to use for authentication rather than an existing session

Request
DesignId

Email

Format

APIKey
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/RenderDesignNow',
  dataType: 'text',
  data: 'DesignId={{DesignId}}&Email=test@inksoft.com&Format=JSON',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

SaveAddressBookAddress

Save an address to an address book entry

Verb

POST

Returns

Visibility
    Public
Parameters

  • Address type: string required

    A serialized representation of an Address

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • ReturnAddress type: boolean optional default value: false

    If true, then the saved address will be returned

Request
Address

Format

ReturnAddress
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/SaveAddressBookAddress',
  dataType: 'text',
  data: 'Address=[object Object]&Format=JSON&ReturnAddress=false',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

SaveArt

Save art to the given user or session.

Verb

POST

Returns

Art

Visibility
    Public
Parameters

  • artFile type: HttpPostedFileBase required

    The art file to save.

  • ArtColors type: string optional

    The list of colors in the art. This is ignored for vector files

  • ForceRaster type: boolean optional default value: false

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • IsProductArt type: boolean optional default value: false

    True if this art can be used to create products in Rapid Product Creator

  • MatchFileColor type: boolean optional default value: false

  • OriginalArtUniqueId type: (nullable) guid optional

    The GUID of the original Art that the Art being saved is based upon

  • SessionId type: (nullable) integer optional

    Obsolete. Ignored. Use SessionToken instead.

  • SessionToken type: string optional

    The session token that this art should be associated with, if any

  • UserId type: (nullable) integer optional

    Obsolete. Ignored. Use SessionToken instead.

Request
artFile

ArtColors

ForceRaster

Format

IsProductArt

MatchFileColor

OriginalArtUniqueId

SessionId

SessionToken

UserId
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/SaveArt',
  dataType: 'text',
  data: 'artFile={{artFile}}&ForceRaster=false&Format=JSON&IsProductArt=false&MatchFileColor=false&SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

SaveCartBillingAddress

Set the cart shipping address

Verb

POST

Returns

Address object

Visibility
    Public
Parameters

  • Address type: string required

    A serialized representation of an Address

  • SessionToken type: string required

  • AddressId type: (nullable) integer optional

    The ID of an address already saved. When provided, Address will be ignored (if present) and the specified AddressId will be saved as the billing address

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Address

SessionToken

AddressId

Format
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/SaveCartBillingAddress',
  dataType: 'text',
  data: 'Address=[object Object]&SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&Format=JSON',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

SaveCartEmail

Saves the "checkout as guest" e-mail for the cart associated with the session token.

Verb

POST

Returns

The cart e-mail address

Visibility
    Public
Parameters

  • Email type: string required

    The e-mail address to save as the "checkout as guest" e-mail.

  • SessionToken type: string required

    The session token that has the cart to update.

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Email

SessionToken

Format
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/SaveCartEmail',
  dataType: 'text',
  data: 'Email=test@inksoft.com&SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&Format=JSON',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

SaveCartItemNotes

Saves a note to each item from the list of corresponding ItemGuids in a cart specified by the session token.

Verb

POST

Returns

true for success or false if failure, with error messages on failure

Visibility
    Public
Parameters

  • ItemGuids type: guid required

    The cart item Guids for which the given note should be applied

  • Notes type: string required

    The text to be set to each cart item for the given set of ItemGuids

  • SessionToken type: string required

    Session token with a corresponding cart

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
ItemGuids

Notes

SessionToken

Format
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/SaveCartItemNotes',
  dataType: 'text',
  data: 'ItemGuids={{ItemGuids}}&Notes={{Notes}}&SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&Format=JSON',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

SaveCartOrder

Create an order with the current cart contents and charge via the specified payment method

Verb

POST

Returns

An Order ID (default) or OrderPackage if successful, or a list of error messages if an error occurred

Visibility
    Public
Parameters

  • CreditCard type: CreditCard required

    An XML or JSON representation of a credit card (Number, ExpirationMonth, ExpirationYear, CVV)

  • FileData type: HttpPostedFileBase required

    File attachment data

  • PaymentMethod type: string required

    The name of the selected payment method

  • PurchaseOrderNumber type: string required

    The number of the purchase order, if using purchase order as the payment method

  • SessionToken type: string required

    The session token of the user. SessionToken is unique per user per session. Either SessionID or SessionToken must be provided

  • AllowFutureCharges type: boolean optional default value: false

    Indicates that the user authorizes the payment method that is going to be saved, to be used on future charges

  • AmountDue type: (nullable) decimal optional

    The expected total amount to be charged for the order. Required and compared against the actual calculated order amount due unless is true

  • BankAccount type: string optional

    The bank account info, used for ACH payments

  • BillingAddress type: string optional

    A serialized representation of an Address corresponding to the billing address. This is usually already saved to the cart, so this parameter is optional

  • CaptchaToken type: string optional

  • Email type: string optional

    The email of the user submitting the order. This is usually already saved to the cart, so this parameter is optional

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • IgnoreTotalDueCheck type: boolean optional default value: false

    When false (default / when omitted), confirms the given matches the final, calculated total amount due before processing payment, and then returns an exception instead of processing payment if the final calculated order amount does not match the expected amount. False is useful for confirming the last known/displayed order amount matches expectations before processing payment. When false, it confirms that any recent product pricing changes or another open browser tab with subsequent changes will not surprise the user with a larger or smaller than expected amount being charged. When true, any provided is ignored, and the amount charged is set to the final, recalculated amount. True is useful when confirming the final calculated amount isn't important and/or isn't known ahead of time. True usually but not necessarily corresponds to an 'Arrange Payment Later' payment method. Neither option (neither true nor false) allows a partial payment or overpayment of the final calculated order total.

  • PaymentMethodDefault type: boolean optional default value: false

    If this payment method should be saved as the default for this user and type (credit card/ACH)/>

  • PaymentMethodName type: string optional

    The payment method name to be saved when requesting to />

  • ReturnOrderPackage type: boolean optional default value: false

    True if an order package should be returned if the order creation is successful.

  • SavePaymentMethod type: boolean optional default value: false

    True if the credit card/bank account token should be saved as a new UserPaymentMethod. Used in combination with "CreditCard" or "BankAccount" parameter

  • ShippingAddress type: string optional

    A serialized representation of an Address corresponding to the shipping address. This is usually already saved to the cart, so this parameter is optional

  • ShippingPrice type: (nullable) decimal optional

    If provided, this will override the shipping price of the order. Requires a valid API key to be provided.

  • SurchargeAmount type: (nullable) decimal optional

  • UserPaymentMethodId type: (nullable) integer optional

    If the user select to pay using one of yours previously saved payment method

Request
CreditCard

FileData

PaymentMethod

PurchaseOrderNumber

SessionToken

AllowFutureCharges

AmountDue

BankAccount

BillingAddress

CaptchaToken

Email

Format

IgnoreTotalDueCheck

PaymentMethodDefault

PaymentMethodName

ReturnOrderPackage

SavePaymentMethod

ShippingAddress

ShippingPrice

SurchargeAmount

UserPaymentMethodId
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/SaveCartOrder',
  dataType: 'text',
  data: 'CreditCard={{CreditCard}}&FileData={{FileData}}&PaymentMethod={{PaymentMethod}}&PurchaseOrderNumber=100&SessionToken=23FA2D2C-4005-4399-80B2-35C79ED841FC&AllowFutureCharges=false&AmountDue=1.00&Email=test@inksoft.com&Format=JSON&IgnoreTotalDueCheck=false&PaymentMethodDefault=false&ReturnOrderPackage=false&SavePaymentMethod=false&ShippingPrice=0.00',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

SaveCartShippingAddress

Set the cart shipping address. If no Address or AddressId is provided then the existing address on the cart will be removed.

Verb

POST

Returns

Success or Failure result

Visibility
    Public
Parameters

  • Address type: string required

    A serialized representation of an Address. Required if AddressId not provided

  • SessionToken type: string required

  • AddressId type: (nullable) integer optional

    The ID of an address already saved. When provided, Address will be ignored (if present) and the specified AddressId will be saved as the shipping address. Required if Address not provided

  • CheckForShippingMethods type: boolean optional default value: true

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • ValidateAddress type: (nullable) boolean optional default value: True

    Boolean indicating if the address should be validated. This should be false if the addresss was already validated

Request
Address

SessionToken

AddressId

CheckForShippingMethods

Format

ValidateAddress
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/SaveCartShippingAddress',
  dataType: 'text',
  data: 'Address=[object Object]&SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&CheckForShippingMethods=true&Format=JSON&ValidateAddress=True',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

SaveCartShippingMethod

Save a shipping method ID to the specified session

Verb

POST

Returns

Success or Failure result

Visibility
    Public
Parameters

  • SessionToken type: string required

    The session token

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • ReturnCart type: boolean optional default value: false

    True if the updated shopping cart should be returned if the operation was successful

  • SdShippingMethod type: SalesDocShippingMethod optional

    The SalesDocShippingMethod to be assigned

  • ShippingMethodId type: (nullable) integer optional

    The ID of the shipping method to be assigned

Request
SessionToken

Format

ReturnCart

SdShippingMethod

ShippingMethodId
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/SaveCartShippingMethod',
  dataType: 'text',
  data: 'SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&Format=JSON&ReturnCart=false',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

SaveContact

Save a Contact, or create one if the ID is 0. Saves basic contact information and will not affect: timeline

Verb

POST

Returns

Contact

Visibility
    Public
Parameters

  • Data type: Contact required

    A serialized representation of a contact in the specified format

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • APIKey type: string optional

    InkSoft API key to use for authentication rather than an existing session

Request
Data

Format

APIKey
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/SaveContact',
  dataType: 'text',
  data: 'Data={{Data}}&Format=JSON',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

SaveProductStyleSizeInventories

Update the local inventory of a list of product style sizes.

Verb

POST

Returns

OK if successful

Visibility
    Public
Parameters

  • ProductStyleSizeInventories type: string required

    A serialized list of ProductStyleSizeInventory

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • UpdateOnlyBlanks type: boolean optional default value: true

    True if only blank products with matching gtins should be updated, false if predecorated products with matching gtins should also be updated.

  • APIKey type: string optional

    InkSoft API key to use for authentication rather than an existing session

Request
ProductStyleSizeInventories

Format

UpdateOnlyBlanks

APIKey
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/SaveProductStyleSizeInventories',
  dataType: 'text',
  data: 'ProductStyleSizeInventories={{ProductStyleSizeInventories}}&Format=JSON&UpdateOnlyBlanks=true',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

SetCart

Accept a JSON/XML ShoppingCart and synchronize as necessary. Return an updated JSON/XML ShoppingCart.

Verb

POST

Returns

ShoppingCart

Visibility
    Public
Parameters

  • Cart type: string required

    A serialized version of the cart

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • SessionToken type: string optional

Request
Cart

Format

SessionToken
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/SetCart',
  dataType: 'text',
  data: 'Cart={{Cart}}&Format=JSON&SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

SignIn

Validate user and return a new session

Verb

POST

Returns

Session

Visibility
    Public
Parameters

  • Email type: string required

    The email of the user

  • GuestSessionToken type: string required

    The token of the guest session, if any. If a user performs cart operations before signing in, a guest session is created. By providing the token for that session here, the cart contents will be retained.

  • Password type: string required

    The password of the user

  • TwoFactorToken type: string required

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • RememberMe type: (nullable) boolean optional

    True if a long-lived authentication cookie should be sent with the method response

Request
Email

GuestSessionToken

Password

TwoFactorToken

Format

RememberMe
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/SignIn',
  dataType: 'text',
  data: 'Email=test@inksoft.com&GuestSessionToken=9617F940-2FBD-49D0-A259-CAC694B06E55&Password=MySecretPassword33221&TwoFactorToken={{TwoFactorToken}}&Format=JSON&RememberMe=true',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

SignInToStore

Return true if password matches store password

Verb

POST

Returns

True if the password provided matches the store password, otherwise false

Visibility
    Public
Parameters

  • Password type: string required

    The password to be validated

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Password

Format
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/SignInToStore',
  dataType: 'text',
  data: 'Password=MySecretPassword33221&Format=JSON',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

SignOut

Validate user and return a new session

Verb

POST

Returns

True upon success

Visibility
    Public
Parameters

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Format
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/SignOut',
  dataType: 'text',
  data: 'Format=JSON',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

UpdateUser

Update user properties

Verb

POST

Returns

true if successful

Visibility
    Public
Parameters

  • Email type: string required

    The updated email address for the signed-in user

  • FirstName type: string required

    The updated first name for the signed-in user

  • LastName type: string required

    The updated last name for the signed-in user

  • SubscribeToNewsletter type: boolean required default value: false

    The newsletter preference for the signed-in user

  • Active type: boolean optional default value: true

    True if the user is active

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • SessionToken type: string optional

    The session token of the signed in user

Request
Email

FirstName

LastName

SubscribeToNewsletter

Active

Format

SessionToken
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/UpdateUser',
  dataType: 'text',
  data: 'Email=test@inksoft.com&FirstName=John&LastName=Doe&SubscribeToNewsletter=true&Active=true&Format=JSON&SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

UploadPurchaseOrderAttachment

Upload a purchase order attachment

Verb

POST

Returns

True if successful, false if not

Visibility
    Public
Parameters

  • PurchaseOrderAttachment type: HttpPostedFileBase required

    The file to be attached

  • SessionToken type: string required

    The token of the current user session

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
PurchaseOrderAttachment

SessionToken

Format
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/UploadPurchaseOrderAttachment',
  dataType: 'text',
  data: 'PurchaseOrderAttachment={{PurchaseOrderAttachment}}&SessionToken=FFA0ACD3-CD98-58FA-EFEC-56CBDDE8BEC9&Format=JSON',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

ValidateAddress

Validate an address against the store's setup shipping vendors, if any.

Verb

POST

Returns

Visibility
    Public
Parameters

  • Address type: string required

    A serialized representation of an Address

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

Request
Address

Format
$.ajax({
  type: 'POST',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/ValidateAddress',
  dataType: 'text',
  data: 'Address=[object Object]&Format=JSON',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});

 

ValidatePostalCode

Validates that the postal code is valid for the given state/country combination. Returns either OK or an error.

Verb

GET

Returns

boolean

Visibility
    Public
Parameters

  • CountryId type: integer required

    Required - the InkSoft integer ID of the country.

  • Format type: string optional default value: JSON

    The data format (XML or JSON) - used for the result and serialized data structure inputs

  • PostalCode type: string optional

    Optional - the postal code. Required and validated for US and Canada.

  • StateId type: (nullable) integer optional

    Optional - the InkSoft integer ID of the state or province. Required for US and Canada.

Request
CountryId

Format

PostalCode

StateId
$.ajax({
  type: 'GET',
  url: 'https://www.appareljunction.com/Apparel_Junction/Api2/ValidatePostalCode?CountryId={{CountryId}}&Format=JSON',
  dataType: 'text',
  data: '',
  processData: false,
  crossDomain: true,
  success: function (res) { success(res); },
  error: function (jqXHR, textStatus, ex) {
      error(jqXHR, textStatus, ex);
  }
});