NuORDER API

HTTP Status codes

The NuORDER API uses HTTP status codes as a way to quickly indicate to the consumer whether or not a request was successful, what type of action was performed, and what type of errors occurred (if any).

The most commonly used codes in the API are:

2xx => success

200 - OK
201 - Created

4xx => client / request errors

400 - Bad Arguments - this error will be accompanied by a message with more information
401 - Unauthorized - user does not have access (this is likely an OAuth header issue)
403 - Forbidden - user does not have access to do what they are trying to do
404 - Not Found - the resource requested was not found
409 - Conflict - the resource provided to create conflicts with another document already stored

Error response body usually looks like:

{
    code: 4xx
    message: 'A short error description'
}

Custom fields

NuORDER uses fluent schemas for products, orders, company. So these entities may contain custom fields in responses, and such fields could be updated in request body.

Code samples

Node.js

Service class

Here is a example of a service class

const crypto = require('crypto');
const requestPromise = require('request-promise');

class NuORDERApiWrapper {
    constructor (options) {
        this.consumer_key = options.consumer_key;
        this.consumer_secret_key = options.consumer_secret_key;
        this.token = options.token;
        this.token_secret = options.token_secret;
        this.version = '1.0';
        this.algorithm = 'HMAC-SHA1';
        this.domain = options.domain;
    }

    getAuthorizationHeader (options) {
        let timestamp = Math.floor(+new Date() / 1000);
        let nonce = this.generateNonce();

        let headers = 'OAuth oauth_consumer_key="' + this.consumer_key + '",' +
            'oauth_timestamp="' + timestamp + '",' +
            'oauth_nonce="' + nonce + '",' +
            'oauth_version="' + this.version + '",' +
            'oauth_signature_method="' + this.algorithm + '",' +
            'oauth_token="' + this.token + '",' +
            'oauth_signature="' + this.createSignature(options, timestamp, nonce) + '"';

        if (options.callback) {
            headers = `${headers},oauth_callback="${options.callback}",application_name="${options.application_name}"`;
        }

        if (options.verifier) {
            headers = `${headers},oauth_verifier="${options.verifier}"`;
        }

        return headers;
    }

    createSignature (options, timestamp, nonce) {
        let string =
            options.method.toUpperCase() +
            encodeURI(options.url) +
            "?oauth_consumer_key=" + this.consumer_key + "&" +
            "oauth_token=" + this.token + "&" +
            "oauth_timestamp=" + timestamp + "&" +
            "oauth_nonce=" + nonce + "&" +
            "oauth_version=" + this.version + "&" +
            "oauth_signature_method=" + this.algorithm;

        if (options.callback) {
            string = `${string}&oauth_callback=${options.callback}`;
        }

        if (options.verifier) {
            string = `${string}&oauth_verifier=${options.verifier}`;
        }

        return this.generateSignature(this.consumer_secret_key + '&' + this.token_secret, string);
    }

    generateNonce () {
        let keylist = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
        let nonce = '';

        // eslint-disable-next-line no-plusplus
        for (let i = 0; i < 16; i++) {
            nonce = nonce + keylist[Math.floor(Math.random() * keylist.length)];
        }

        return nonce;
    }

    generateSignature (key, text) {
        return crypto.createHmac('sha1', key).update(text).digest('hex');
    }

    request (opts) {
        const {
            url,
            method = 'GET',
            body = {},
        } = opts;

        // Note for NuORDER Developers, https can be problematic if your
        // SSL certs aren't setup right.

        const options = Object.assign({
            url: `https://${this.domain}${url}`,
            method,
            headers: {
                'Content-Type': 'application/json',
            },
            json: true,
        });

        // Including a body on a GET request is considered malformed
        // by Google, so don't do it.

        if (method === "POST" || method === "PUT" || method === "PATCH") {
            options.body = body;
        }

        options.headers.Authorization = this.getAuthorizationHeader(options);

        return requestPromise(options);
    }
}

module.exports = NuORDERApiWrapper;

note that this class uses 2 additional libraries - crypto and request-promise. In order to install them you need to run:

npm install -g request-propmise crypto

1. Initiate request

This step will register a new Application with NuORDER for your brand and generate temporary token + token_secret keys. In the example below, the Application will be called “my-awesome-app.”

After a successful call, you will need to enter the NuORDER App to confirm the new Application and get permanent keys.

const config = {
    consumer_key: '',        // Retrieve this value from NuORDER > Admin > API Management
    consumer_secret_key: '', // Retrieve this value from NuORDER > Admin > API Management
    token: '',               // will be blank for this call
    token_secret: '',        // will be blank for this call
    version: '1.0',
    algorithm: 'HMAC-SHA1',
    domain: 'next.nuorder.com' //NuORDER api server
};

const NuORDERApi = new NuORDERApiWrapper(config);

NuORDERApi.request({
    url: '/api/initiate',
    body: {
        application_name: 'my-awesome-app',
        callback: 'oob'
    }
})
.then( data => {
    // `data` here is something like
    // {
    //    "oauth_token": "k53u9GSydTg2UzD4",
    //    "oauth_token_secret": "ScmSTbxBwuqaVJnFgSWBJTXn",
    //    "oauth_callback_confirmed": true
    // }
    console.log( `${JSON.stringify(data, null, 4)}`)
} )
.catch( (err) => {
    console.error(`An error occured ${err.message}`)
})
// do something with response, it includes your temporary token and secret for the next token call

2. Token request

At this point you are able to see your application (my-awesome-app in case you’ve used this guide name) in NuORDER > Admin > API Management. Click on APPROVE button, and you’ll see a popup with verifier code.

Be careful not to loose this verifier code, as it will not be persisted after dismissing the confirmation.

Copy the verifier code into the code below, where it says “verifier.”

const config = {
    consumer_key: '',        // Retrieve this value from NuORDER > Admin > API Management
    consumer_secret_key: '', // Retrieve this value from NuORDER > Admin > API Management
    token: '',               // Your temp token will be in the initiate response body OR you can get it from NuORDER > Admin > API Management
    token_secret: '',        // Your temp token will be in the initiate response body OR you can get it from NuORDER > Admin > API Management
    version: '1.0',
    algorithm: 'HMAC-SHA1',
    domain: 'staging.nuorder.com' //NuORDER api server
};

const NuORDERApi = new NuORDERApiWrapper(config);

NuORDERApi.request({
    url: '/api/token',
    body: {
        verifier: 'SPhxFUHGqbCYSdt2' // Retrieve this value from NuORDER > Admin > API Management > APPROVE
    }
})
.then( data => {
    // `data` here is something like
    // {
    //    "oauth_token": "GVxrNWmKvV3F8DTD4p5cvBT6",
    //    "oauth_token_secret": "eFTsRZgPXkEheVRqTchdfnM8CWKzbgKWcKYtEhbcE47rB8RhRVSZBwYuFy2mFun5"
    // }
    console.log( `${JSON.stringify(data, null, 4)}`)
} )
.catch( (err) => {
    console.error(`An error occured ${err.message}`)
})

Congratulations, you have permanent keys now for accessing the API. These will always be available to you via NuORDER APP --> Admin --> API Management --> (e.g. my-awesome-app)

For accessing the API from here on out, you will need to include
    consumer_key (NuORDER > Admin > API Management)
    consumer_secret_key (NuORDER > Admin > API Management)
    token (NuORDER > Admin > API Management > <Your Application Name>)
    token_secret (NuORDER > Admin > API Management > <Your Application Name>)

AT THIS POINT YOU HAVE FULL ACCESS TO YOUR API'S. See the next section for an example on usage.

3. Get Pending Orders Example

const NuORDERApiWrapper = require('./NuORDERApiWrapper');

const config = {
    consumer_key: '',        // *Required* Retrieve this value from NuORDER > Admin > API Management
    consumer_secret_key: '', // *Required* Retrieve this value from NuORDER > Admin > API Management
    token: '',               // *Required* Retrieve this value from NuORDER > Admin > API Management, or the token response body
    token_secret: '',        // *Required* Retrieve this value from NuORDER > Admin > API Management, or the token response body
    version: '1.0',          // *Required*
    algorithm: 'HMAC-SHA1',  // *Required*
    domain: 'next.nuorder.com' // NuORDER api server
};

const NuORDERApi = new NuORDERApiWrapper(config);

NuORDERApi.request({
    url: '/api/orders/pending/detail'
})
.then( data => {
    // `data` here is your pending orders list
    console.log( `${JSON.stringify(data, null, 4)}`)
} )
.catch( (err) => {
    console.error(`An error occured ${err.message}`)
})

C#

Service class

Here is an example util class you can use:

public class NuOrderConfig
{
    public string ConsumerKey { get; set; }
    public string ConsumerSecret { get; set; }
    public string Token { get; set; }
    public string TokenSecret { get; set; }
    public string Version { get; set; }
    public string SignatureMethod { get; set; }
}

/* web service wrapper */

public class NuOrderWebService
{
    private NuOrderConfig Configuration;

    public string Timestamp { get; set; }
    public string Nonce { get; set; }
    public string Signature { get; set; }

    public string Callback { get; set; }
    public string ApplicationName { get; set; }
    public string VerificationCode { get; set; }

    private bool IsInitRequest;
    private bool IsVerifyRequest;

    public NuOrderWebService(NuOrderConfig Configuration)
    {
        this.Configuration = Configuration;
    }

    /* PUBLIC METHODS */

    public HttpWebResponse ExecuteRequest(string RequestMethod, string EndPoint)
    {
        return ExecuteRequest(RequestMethod, EndPoint, null);
    }

    public HttpWebResponse ExecuteRequest(string RequestMethod, string EndPoint, string Data)
    {
        try
        {
            this.Nonce = GenerateNonce();
            this.Timestamp = GenerateTimestamp().ToString();
            this.Signature = GenerateSignature(RequestMethod, EndPoint);

            HttpWebRequest req = (HttpWebRequest) HttpWebRequest.Create(EndPoint);

            string authorizationHeader = "OAuth ";
            foreach (var header in GetRequestHeaders())
                authorizationHeader += header.Key + "=\"" + header.Value + "\",";
            authorizationHeader = authorizationHeader.Substring(0, authorizationHeader.Length - 1);
            req.Headers.Add(HttpRequestHeader.Authorization, authorizationHeader);
            req.Method = RequestMethod;

            if ((RequestMethod == "POST" || RequestMethod == "PUT") && Data != null)
            {
                req.ContentType = "application/json";

                using (StreamWriter writer = new StreamWriter(req.GetRequestStream()))
                {
                    writer.Write(Data);
                }
            }

            HttpWebResponse response = (HttpWebResponse) req.GetResponse();

            return response;
        }
        catch (WebException ex)
        {
            // catch error here -- note the response code (i.e. 401, 404, 409, etc) and the response body for more information

            return null;
        }
    }

    public void SetInitRequest(string ApplicationName, string Callback)
    {
        this.IsInitRequest = true;
        this.ApplicationName = ApplicationName;
        this.Callback = Callback;
    }

    public void SetVerifyRequest(string VerificationCode)
    {
        this.IsVerifyRequest = true;
        this.VerificationCode = VerificationCode;
    }

    /* SUPPORT METHODS */

    private Dictionary<string, string> GetRequestHeaders()
    {
        Dictionary<string, string> headers = new Dictionary<string, string>();
        headers.Add("oauth_token", Configuration.Token);
        headers.Add("oauth_consumer_key", Configuration.ConsumerKey);
        headers.Add("oauth_timestamp", Timestamp);
        headers.Add("oauth_nonce", Nonce);
        headers.Add("oauth_version", Configuration.Version);
        headers.Add("oauth_signature_method", Configuration.SignatureMethod);
        headers.Add("oauth_signature", Signature);

        if (IsInitRequest)
        {
            headers.Add("oauth_callback", Callback);
            headers.Add("application_name", ApplicationName);
        }

        if (IsVerifyRequest)
            headers.Add("oauth_verifier", VerificationCode);

        return headers;
    }

    private Random rnd = new Random();
    private const string _characters =
        "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";

    private string GenerateNonce()
    {
        char[] buffer = new char[16];
        for (int i = 0; i < 16; i++)
            buffer[i] = _characters[rnd.Next(_characters.Length)];
        return new string(buffer);
    }

    private int GenerateTimestamp()
    {
        TimeSpan span = DateTime.UtcNow.Subtract(new DateTime(1970, 1, 1, 0, 0, 0));
        return Convert.ToInt32(span.TotalSeconds);
    }

    private string GenerateSignature(string RequestMethod, string EndPoint)
    {
        string baseSignatureString = RequestMethod + EndPoint +
            "?oauth_consumer_key=" + Configuration.ConsumerKey + "&" +
            "oauth_token=" + Configuration.Token + "&" +
            "oauth_timestamp=" + Timestamp + "&" +
            "oauth_nonce=" + Nonce + "&" +
            "oauth_version=" + Configuration.Version + "&" +
            "oauth_signature_method=" + Configuration.SignatureMethod;

        if (IsInitRequest) baseSignatureString += "&oauth_callback=" + Callback;
        if (IsVerifyRequest) baseSignatureString += "&oauth_verifier=" + VerificationCode;

        string key = Configuration.ConsumerSecret + "&" + Configuration.TokenSecret;

        return GenerateSHA1Hash(key, baseSignatureString);
    }

    private string GenerateSHA1Hash(string key, string value)
    {
        byte[] keyBytes = ConvertStringToByteArray(key);
        byte[] valueBytes = ConvertStringToByteArray(value);
        byte[] hash = null;
        using (HMACSHA1 hmac = new HMACSHA1(keyBytes))
        {
            hash = hmac.ComputeHash(valueBytes);
        }
        return ConvertByteArrayToHexString(hash);
    }

    private byte[] ConvertStringToByteArray(string str)
    {
        return System.Text.Encoding.ASCII.GetBytes(str);
    }

    private string ConvertByteArrayToHexString(byte[] bytes)
    {
        StringBuilder hex = new StringBuilder(bytes.Length * 2);
        foreach (byte b in bytes)
            hex.AppendFormat("{0:x2}", b);
        return hex.ToString();
    }
}

1. Initiate request

NuOrderConfig config = new NuOrderConfig();
config.ConsumerKey = "";    // Retrieve this value from NuORDER > Admin > API Management
config.ConsumerSecret = ""; // Retrieve this value from NuORDER > Admin > API Management
config.Token = "";          // will be blank for this call
config.TokenSecret = "";    // will be blank for this call
config.Version = "1.0";
config.SignatureMethod = "HMAC-SHA1";

NuOrderWebService ws = new NuOrderWebService(config);

ws.SetInitRequest("application_name", "oob");

HttpWebResponse response = ws.ExecuteRequest("GET", "https://sandbox1.nuorder.com/api/initiate");

// do something with response, it includes your temporary token and secret for the next token call

2. Token request

NuOrderConfig config = new NuOrderConfig();
config.ConsumerKey = "";    // Retrieve this value from NuORDER > Admin > API Management
config.ConsumerSecret = ""; // Retrieve this value from NuORDER > Admin > API Management
config.Token = "";          // Your temp token will be in the initiate response body OR you can get it from NuORDER > Admin > API Management
config.TokenSecret = "";    // Your temp token will be in the initiate response body OR you can get it from NuORDER > Admin > API Management
config.Version = "1.0";
config.SignatureMethod = "HMAC-SHA1";

NuOrderWebService ws = new NuOrderWebService(config);

ws.SetVerifyRequest("oauth_verifier"); // get this value from NuORDER > Admin > API Management, it will not be included in the original response

HttpWebResponse response = ws.ExecuteRequest("GET", "https://sandbox1.nuorder.com/api/token");

// do something with response, it includes your final token and token secret for all subsequent calls

AT THIS POINT YOU HAVE FULL ACCESS TO OUR API’S… HERE IS ONE EXAMPLE CALL YOU CAN NOW MAKE

3. Get Pending Orders Example

NuOrderConfig config = new NuOrderConfig();
config.ConsumerKey = "";    // Retrieve this value from NuORDER > Admin > API Management
config.ConsumerSecret = ""; // Retrieve this value from NuORDER > Admin > API Management
config.Token = "";          // Retrieve this value from NuORDER > Admin > API Management, or the token response body
config.TokenSecret = "";    // Retrieve this value from NuORDER > Admin > API Management, or the token response body
config.Version = "1.0";
config.SignatureMethod = "HMAC-SHA1";

NuOrderWebService ws = new NuOrderWebService(config);

string url = "https://sandbox1.nuorder.com/api/orders/pending/detail";
HttpWebResponse response = ws.ExecuteRequest("GET", url);

// the response will be a JSON array of orders

Authentication ¶

NuORDER uses OAuth 1.0 as the authentication scheme. Please follow these steps to generate your permanent tokens that are required to make all API calls.

Make a call to /api/initiate to generate temporary tokens
Make a call to /api/token to generate permanent tokens

OAuth 1.0 is comprised of two main elements:

A signature
An authorization header

Signature Required Properties

method_type GET (string) - The HTTP method
url https://nuorder.com/api/initiate (string) - The URL
oauth_consumer_key YUb6RBRsd8cH5KNW44UeXmat - Consumer Key (Admin => API Management)
oauth_token NTwm2VaY5kJjtBuQJXRTBACK - Token (Admin => API Management)
oauth_timestamp 1488918667 - Timestamp
oauth_nonce Mevx8gQQ3pzmkdXq - Nonce (16 characters)
oauth_version 1.0 - OAuth Version (1.0 only)
oauth_signature_method HMAC-SHA1 - Signature method (HMAC-SHA1 is the only signature method NuORDER supports)

Signature Properties that are sometimes required

/api/initiate
- oauth_callback http://yourservice.com - The callback URL (or oob if you want to manually approve the application)
/api/token
- oauth_verifier XSyGUc3HRKU6cfKD - The verifier code, you can get it from Admin -> API Management when click on APPROVE button

Example base string (note: order matters)

GEThttps://nuorder.com/api/initiate?oauth_consumer_key=YUb6RBRsd8cH5KNW44UeXmat&oauth_token=&oauth_timestamp=1488918667&oauth_nonce=Mevx8gQQ3pzmkdXq&oauth_version=1.0&oauth_signature_method=HMAC-SHA1&oauth_callback=oob

Generating the signature

In order to generate your signature you will need your consumer_secret_key and token_secret, which will act as the key when generating the signature.

The key is consumer_secret_key + & + token_secret.

Example:

pFwRJnYWTFqhdnXHSy7xr5pzEjdzfbY5qb2mnBK5yxMPp2Q7buw5uRYkK4NRHvZM&ZCehSTY27v38we5awpJeqjD4dNyRCduJjcbrXSxKRUekrvzecP5X7fvnhGcJn93d

Example for /api/initiate when there is no token_secret yet (note the & is still present):

pFwRJnYWTFqhdnXHSy7xr5pzEjdzfbY5qb2mnBK5yxMPp2Q7buw5uRYkK4NRHvZM&

Full example of a Base String + Key + Signature:

Base String:

GEThttps://nuorder.com/api/initiate?oauth_consumer_key=YUb6RBRsd8cH5KNW44UeXmat&oauth_token=&oauth_timestamp=1488918667&oauth_nonce=Mevx8gQQ3pzmkdXq&oauth_version=1.0&oauth_signature_method=HMAC-SHA1&oauth_callback=oob

Secret Key:

pFwRJnYWTFqhdnXHSy7xr5pzEjdzfbY5qb2mnBK5yxMPp2Q7buw5uRYkK4NRHvZM&

-----

Signature:

95556c9e7e000bd3769156e01c503d18923b7702

Tester: http://www.freeformatter.com/hmac-generator.html

Authorization Header

Once you have generated your signature you must send the OAuth header on each API call. The OAuth header looks like this:

OAuth oauth_consumer_key='YUb6RBRsd8cH5KNW44UeXmat',oauth_timestamp='1488918667',oauth_nonce='Mevx8gQQ3pzmkdXq',oauth_version='1.0',oauth_signature_method='HMAC-SHA1',oauth_token='',oauth_signature='95556c9e7e000bd3769156e01c503d18923b7702',oauth_callback='oob',application_name='application_name'

OAuth Initiate
GET`/api/initiate`

Example URI

GET https://nuorder.com/api/initiate

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "oauth_token": "zRR5Uux7DP8D4JWB",
  "oauth_token_secret": "fq2f7SMD4MHKgbEYU2bu7ySM",
  "oauth_callback_confirmed": true
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "oauth_token": {
      "type": "string",
      "description": "Temporary token used to make /api/token calls to NuORDER"
    },
    "oauth_token_secret": {
      "type": "string",
      "description": "Temporary token secret used to make /api/token calls to NuORDER"
    },
    "oauth_callback_confirmed": {
      "type": "boolean",
      "description": "Whether callback confirmed"
    }
  }
}

OAuth Token
GET`/api/token`

Example URI

GET https://nuorder.com/api/token

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "oauth_token": "XqQTzfjHq2rWxgJ2sGtwAf3W",
  "oauth_token_secret": "Bsv8eHy37x6466mjf5JZMqvjUyBvaawEeR9S3v6KYAwhfXb3d8eAdQMjKgsTGdbN"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "oauth_token": {
      "type": "string",
      "description": "Permenant token used to make all calls to NuORDER"
    },
    "oauth_token_secret": {
      "type": "string",
      "description": "Permenant token secret used to make all calls to NuORDER"
    }
  }
}

Buyer Collection ¶

APIs for managing your Buyers.

Add Buyer to a Company by ID
PUT`/api/company/{id}/add/buyer`

Example URI

PUT https://nuorder.com/api/company/59af25379042bd00013b7996/add/buyer

URI Parameters

HideShow

id: string (required) Example: 59af25379042bd00013b7996
company id

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "name": "Reece Test Buyer",
  "email": "reece.harrison+buyer@lightspeedhq.com",
  "reps": [
    "reece.harrison+salesrep86@lightspeedhq.com"
  ],
  "title": "Head Buyer",
  "phone_office": "(555) 867-5309",
  "phone_cell": "(555) 867-5309"
}

Schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "user name"
    },
    "email": {
      "type": "string",
      "description": "user email"
    },
    "reps": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Sales Rep emails"
    },
    "title": {
      "type": "string",
      "description": "user title"
    },
    "phone_office": {
      "type": "string",
      "description": "user phone office"
    },
    "phone_cell": {
      "type": "string",
      "description": "user phone cell"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "Reece Test Buyer",
  "email": "reece.harrison+buyer@lightspeedhq.com",
  "reps": [
    "reece.harrison+salesrep86@lightspeedhq.com"
  ],
  "title": "Head Buyer",
  "phone_office": "(555) 867-5309",
  "phone_cell": "(555) 867-5309"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "user name"
    },
    "email": {
      "type": "string",
      "description": "user email"
    },
    "reps": {
      "type": "array",
      "description": "Sales Rep emails"
    },
    "title": {
      "type": "string",
      "description": "user title"
    },
    "phone_office": {
      "type": "string",
      "description": "user phone office"
    },
    "phone_cell": {
      "type": "string",
      "description": "user phone cell"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid parameters'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Company not found'
}

Add Buyer to a Company by Code
PUT`/api/company/code/{code}/add/buyer`

Example URI

PUT https://nuorder.com/api/company/code/31301/add/buyer

URI Parameters

HideShow

code: string (required) Example: 31301
company id

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "name": "Reece Test Buyer",
  "email": "reece.harrison+buyer@lightspeedhq.com",
  "reps": [
    "reece.harrison+salesrep86@lightspeedhq.com"
  ],
  "title": "Head Buyer",
  "phone_office": "(555) 867-5309",
  "phone_cell": "(555) 867-5309"
}

Schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "user name"
    },
    "email": {
      "type": "string",
      "description": "user email"
    },
    "reps": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Sales Rep emails"
    },
    "title": {
      "type": "string",
      "description": "user title"
    },
    "phone_office": {
      "type": "string",
      "description": "user phone office"
    },
    "phone_cell": {
      "type": "string",
      "description": "user phone cell"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "Reece Test Buyer",
  "email": "reece.harrison+buyer@lightspeedhq.com",
  "reps": [
    "reece.harrison+salesrep86@lightspeedhq.com"
  ],
  "title": "Head Buyer",
  "phone_office": "(555) 867-5309",
  "phone_cell": "(555) 867-5309"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "user name"
    },
    "email": {
      "type": "string",
      "description": "user email"
    },
    "reps": {
      "type": "array",
      "description": "Sales Rep emails"
    },
    "title": {
      "type": "string",
      "description": "user title"
    },
    "phone_office": {
      "type": "string",
      "description": "user phone office"
    },
    "phone_cell": {
      "type": "string",
      "description": "user phone cell"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid parameters'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Company not found'
}

Update Buyer by Company ID
POST`/api/company/{id}/update/buyer/`

Example URI

POST https://nuorder.com/api/company/59af25379042bd00013b7996/update/buyer/

URI Parameters

HideShow

id: string (required) Example: 59af25379042bd00013b7996
company id

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "name": "Reece Test Buyer",
  "email": "reece.harrison+buyer@lightspeedhq.com",
  "reps": [
    "reece.harrison+salesrep86@lightspeedhq.com"
  ],
  "title": "Head Buyer",
  "phone_office": "(555) 867-5309",
  "phone_cell": "(555) 867-5309"
}

Schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "user name"
    },
    "email": {
      "type": "string",
      "description": "user email"
    },
    "reps": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Sales Rep emails"
    },
    "title": {
      "type": "string",
      "description": "user title"
    },
    "phone_office": {
      "type": "string",
      "description": "user phone office"
    },
    "phone_cell": {
      "type": "string",
      "description": "user phone cell"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "Reece Test Buyer",
  "email": "reece.harrison+buyer@lightspeedhq.com",
  "reps": [
    "reece.harrison+salesrep86@lightspeedhq.com"
  ],
  "title": "Head Buyer",
  "phone_office": "(555) 867-5309",
  "phone_cell": "(555) 867-5309"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "user name"
    },
    "email": {
      "type": "string",
      "description": "user email"
    },
    "reps": {
      "type": "array",
      "description": "Sales Rep emails"
    },
    "title": {
      "type": "string",
      "description": "user title"
    },
    "phone_office": {
      "type": "string",
      "description": "user phone office"
    },
    "phone_cell": {
      "type": "string",
      "description": "user phone cell"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid parameters'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Buyer not found'
}

Update Buyer by Company Code
POST`/api/company/code/{code}/update/buyer/`

Example URI

POST https://nuorder.com/api/company/code/31301/update/buyer/

URI Parameters

HideShow

code: string (required) Example: 31301
company id

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "name": "Reece Test Buyer",
  "email": "reece.harrison+buyer@lightspeedhq.com",
  "reps": [
    "reece.harrison+salesrep86@lightspeedhq.com"
  ],
  "title": "Head Buyer",
  "phone_office": "(555) 867-5309",
  "phone_cell": "(555) 867-5309"
}

Schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "user name"
    },
    "email": {
      "type": "string",
      "description": "user email"
    },
    "reps": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Sales Rep emails"
    },
    "title": {
      "type": "string",
      "description": "user title"
    },
    "phone_office": {
      "type": "string",
      "description": "user phone office"
    },
    "phone_cell": {
      "type": "string",
      "description": "user phone cell"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "Reece Test Buyer",
  "email": "reece.harrison+buyer@lightspeedhq.com",
  "reps": [
    "reece.harrison+salesrep86@lightspeedhq.com"
  ],
  "title": "Head Buyer",
  "phone_office": "(555) 867-5309",
  "phone_cell": "(555) 867-5309"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "user name"
    },
    "email": {
      "type": "string",
      "description": "user email"
    },
    "reps": {
      "type": "array",
      "description": "Sales Rep emails"
    },
    "title": {
      "type": "string",
      "description": "user title"
    },
    "phone_office": {
      "type": "string",
      "description": "user phone office"
    },
    "phone_cell": {
      "type": "string",
      "description": "user phone cell"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid parameters'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Buyer not found'
}

Remove Buyer by Company ID
DELETE`/api/company/{id}/buyer/{email}`

Example URI

DELETE https://nuorder.com/api/company/59af25379042bd00013b7996/buyer/lazy-buyer@nuorder.com

URI Parameters

HideShow

id: string (required) Example: 59af25379042bd00013b7996
company id
email: string (required) Example: lazy-buyer@nuorder.com
(string, required) - buyer email

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid parameters'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Buyer not found'
}

Remove Buyer by Company Code
DELETE`/api/company/code/{code}/buyer/{email}`

Example URI

DELETE https://nuorder.com/api/company/code/31301/buyer/lazy-buyer@nuorder.com

URI Parameters

HideShow

code: string (required) Example: 31301
company id
email: string (required) Example: lazy-buyer@nuorder.com
(string, required) - buyer email

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid parameters'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Company not found'
}

Remove All Buyers by Company ID
DELETE`/api/company/{id}/buyers`

Example URI

DELETE https://nuorder.com/api/company/59af25379042bd00013b7996/buyers

URI Parameters

HideShow

id: string (required) Example: 59af25379042bd00013b7996
company id

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid parameters'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Company not found'
}

Remove All Buyers by Company Code
DELETE`/api/company/code/{code}/buyers`

Example URI

DELETE https://nuorder.com/api/company/code/31301/buyers

URI Parameters

HideShow

code: string (required) Example: 31301
company id

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid parameters'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Company not found'
}

Catalog Collection ¶

APIs for managing your Catalogs.

Create Catalog
POST`/api/v3.1/catalogs`

Example URI

POST https://nuorder.com/api/v3.1/catalogs

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "id": "593fec4a8f113256c806ac59",
  "sync_id": "F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0",
  "brand_id": "593fec4a8f113256c806ac59",
  "created_on": 1556670722522,
  "modified_on": 155667077878,
  "owner_account_id": "593fec4a8f113256c806ac59",
  "active": true,
  "archived": false,
  "title": "Hello, world!",
  "description": "Hello, world!",
  "cover": "81e481d94c3a9f22d65464b8e23c066e.jpg",
  "portrait_image": "81e481d94c3a9f22d65464b8e23c066e.jpg",
  "default_pdf_template": "landscape_single_16",
  "type": "landscape_single_16",
  "restrictions": [
    {
      "sync_id": "F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0",
      "field": "warehouse",
      "value": "warehouse",
      "mode": "whitelist"
    }
  ],
  "sort": 1,
  "entries": [
    {
      "type": "item",
      "item": {
        "style_number": "A396",
        "season": "spring/summer",
        "color": "all black",
        "name": "test",
        "brand_id": "172ak061712-001",
        "unique_key": "A396,spring/summer,all black",
        "schema_id": "537bcbd716af5274043a0992",
        "sizes": [
          {
            "size": "OS",
            "size_group": "A1",
            "pricing": {
              "USD": {
                "wholesale": 10,
                "retail": 12.1,
                "disabled": false
              }
            }
          }
        ],
        "banners": [
          "[583f5196675ef9ac78c1628d]"
        ],
        "size_groups": [
          "[ group1, group2, group3 ]"
        ],
        "available_now": false,
        "images": [
          "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
        ],
        "cancelled": false,
        "archived": false,
        "active": true,
        "description": "awesome product",
        "available_from": "2017/08/30",
        "available_until": "2019/08/30",
        "order_closing": "2017-09-12 00:00:00.000Z",
        "pricing": {
          "USD": {
            "wholesale": 10,
            "retail": 12.1,
            "disabled": false
          }
        },
        "seasons": [
          "[spring, summer, 2018]"
        ],
        "_id": "599611906873730001745011",
        "__size_ids": [
          "[599611906873730001745011]"
        ],
        "modified_on": "2017-09-11T22:30:04.911Z",
        "__inventory_cache": [
          {
            "bucket": "2018/07/25",
            "warehouse": "537bcbd716af5274043a09be",
            "sku_id": "59958be4ffb5c600017a05cb",
            "_id": "59b70e6a01c70700012dbdb8",
            "quantity": 72
          }
        ],
        "__inventory": [
          "[default]"
        ]
      },
      "item_id": "5a28ccf5b0aaf1000101ae55",
      "modified_on": 155667077878,
      "notes": "Hello, world!",
      "sync_id": "Hello, world!",
      "created_on": 1558098782447,
      "sort": 3372
    }
  ],
  "links": [
    {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "catalog_id": "593fec4a8f113256c806ac59",
      "created_on": 1558098782447,
      "label": "Some link label",
      "link": "Hello, world!"
    }
  ],
  "shares": "some description",
  "available_from": 1556670722522,
  "delivery_window_start": 1556670722522,
  "delivery_window_end": 155667079999,
  "prebook": true
}

Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Catalog ID (24 character hex string)"
    },
    "sync_id": {
      "type": "string",
      "description": "Random UUID"
    },
    "brand_id": {
      "type": "string",
      "description": "ID of a brand owning Catalog"
    },
    "created_on": {
      "type": "number",
      "description": "Creation timestamp"
    },
    "modified_on": {
      "type": "number",
      "description": "Last modification timestamp"
    },
    "owner_account_id": {
      "type": "string",
      "description": "ID of an owner"
    },
    "active": {
      "type": "boolean",
      "description": "Flag denoting is catalog active"
    },
    "archived": {
      "type": "boolean",
      "description": "Flag denoting is catalog active"
    },
    "title": {
      "type": "string",
      "description": "Catalog's title"
    },
    "description": {
      "type": "string",
      "description": "Catalog's description"
    },
    "cover": {
      "type": "string",
      "description": "Cover image name"
    },
    "portrait_image": {
      "type": "string",
      "description": "Portrait image name"
    },
    "default_pdf_template": {
      "type": "string",
      "description": "Name of a default PDF template"
    },
    "type": {
      "type": "string",
      "description": "Catalog type 'landscape_single_16 | custom-list'"
    },
    "restrictions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sync_id": {
            "type": "string",
            "description": "Random UUID used for synchronization and tracking between systems. Helps identify the same restriction across different operations."
          },
          "field": {
            "enum": [
              "warehouse",
              "currency_code",
              "customer_group",
              "subteam"
            ],
            "description": "Type of restriction being applied. Possible values:"
          },
          "value": {
            "enum": [
              "warehouse",
              "currency_code",
              "customer_group",
              "subteam"
            ],
            "description": "The specific value for the restriction. The format depends on the field type:"
          },
          "mode": {
            "enum": [
              "whitelist",
              "blacklist"
            ],
            "description": "Determines how the restriction is applied:"
          }
        }
      },
      "description": "Array of catalog's restrictions"
    },
    "sort": {
      "type": "number",
      "description": "Sort order"
    },
    "entries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Entry type ('item | separator | image')"
          },
          "item": {
            "type": "object",
            "properties": {
              "style_number": {
                "type": "string",
                "description": "product style number"
              },
              "season": {
                "type": "string",
                "description": "product season"
              },
              "color": {
                "type": "string",
                "description": "product color"
              },
              "name": {
                "type": "string",
                "description": "product name"
              },
              "brand_id": {
                "type": "string",
                "description": "product external identificator"
              },
              "unique_key": {
                "type": "string",
                "description": "Product unique key"
              },
              "schema_id": {
                "type": "string",
                "description": "product schema id"
              },
              "sizes": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "size": {
                      "type": "string",
                      "description": "size name"
                    },
                    "size_group": {
                      "type": "string",
                      "description": "size group"
                    },
                    "pricing": {
                      "type": "object",
                      "properties": {
                        "USD": {
                          "type": "object",
                          "properties": {
                            "wholesale": {
                              "type": "number",
                              "description": "wholesale price"
                            },
                            "retail": {
                              "type": "number",
                              "description": "retail price"
                            },
                            "disabled": {
                              "type": "boolean",
                              "description": "whether price is disabled"
                            }
                          },
                          "required": [
                            "wholesale"
                          ]
                        }
                      },
                      "description": "size prices in available currencies, It is important to specify prices at the size level only when there is variation in pricing for a product based on its size. If prices remain consistent across all sizes, product-level pricing will be sufficient."
                    }
                  }
                },
                "description": "product sizes"
              },
              "banners": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "order banners"
              },
              "size_groups": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "size groups"
              },
              "available_now": {
                "type": "boolean",
                "description": "whether product is available now"
              },
              "images": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "product images URLs: upload Images via API not supported at this time"
              },
              "cancelled": {
                "type": "boolean",
                "description": "whether product was cancelled"
              },
              "archived": {
                "type": "boolean",
                "description": "whether product was archived"
              },
              "active": {
                "type": "boolean",
                "description": "whether product is active,"
              },
              "description": {
                "type": "string",
                "description": "product description"
              },
              "available_from": {
                "type": "string",
                "description": "date available from"
              },
              "available_until": {
                "type": "string",
                "description": "date available until"
              },
              "order_closing": {
                "type": "string",
                "description": "date order closing"
              },
              "pricing": {
                "type": "object",
                "properties": {
                  "USD": {
                    "type": "object",
                    "properties": {
                      "wholesale": {
                        "type": "number",
                        "description": "wholesale price"
                      },
                      "retail": {
                        "type": "number",
                        "description": "retail price"
                      },
                      "disabled": {
                        "type": "boolean",
                        "description": "whether price is disabled"
                      }
                    },
                    "required": [
                      "wholesale"
                    ]
                  }
                },
                "description": "product pricing"
              },
              "seasons": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "product additional seasons"
              },
              "_id": {
                "type": "string",
                "description": "product ID"
              },
              "__size_ids": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "size ids array"
              },
              "modified_on": {
                "type": "string",
                "description": "last modified date"
              },
              "__inventory_cache": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "bucket": {
                      "type": "string",
                      "description": "bucket name,"
                    },
                    "warehouse": {
                      "type": "string",
                      "description": "warehouse ID,"
                    },
                    "sku_id": {
                      "type": "string",
                      "description": "sku ID"
                    },
                    "_id": {
                      "type": "string",
                      "description": "inventory cache id"
                    },
                    "quantity": {
                      "type": "number",
                      "description": "quantity amount"
                    }
                  }
                },
                "description": "inventory cached data (DEPRECATED, to be removed soon)"
              },
              "__inventory": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "inventory names"
              }
            },
            "required": [
              "style_number",
              "season",
              "color",
              "name",
              "sizes",
              "pricing"
            ]
          },
          "item_id": {
            "type": "string",
            "description": "Product ID (24 character hex string)"
          },
          "modified_on": {
            "type": "number",
            "description": "Last modification timestamp"
          },
          "notes": {
            "type": "string",
            "description": "Notes"
          },
          "sync_id": {
            "type": "string",
            "description": "Random `F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0` (string) - Random UUID"
          },
          "created_on": {
            "type": "number",
            "description": "Creation timestamp"
          },
          "sort": {
            "type": "number",
            "description": "Sort order"
          }
        }
      },
      "description": "Array of of catalog's entries"
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Link ID (24 character hex string)"
          },
          "catalog_id": {
            "type": "string",
            "description": "Catalog ID (24 character hex string)"
          },
          "created_on": {
            "type": "number",
            "description": "Creation timestamp"
          },
          "label": {
            "type": "string",
            "description": "A text label for a link"
          },
          "link": {
            "type": "string"
          }
        }
      },
      "description": "Array of links to catalog"
    },
    "shares": {
      "type": "string"
    },
    "available_from": {
      "type": "number",
      "description": "Timestamp of when catalog is available from"
    },
    "delivery_window_start": {
      "type": "number",
      "description": "Timestamp of delivery windows start"
    },
    "delivery_window_end": {
      "type": "number",
      "description": "Timestamp of delivery windows end"
    },
    "prebook": {
      "type": "boolean",
      "description": "Is catalog available for prebook"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "id": "593fec4a8f113256c806ac59",
  "sync_id": "F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0",
  "brand_id": "593fec4a8f113256c806ac59",
  "created_on": 1556670722522,
  "modified_on": 155667077878,
  "owner_account_id": "593fec4a8f113256c806ac59",
  "active": true,
  "archived": false,
  "title": "Hello, world!",
  "description": "Hello, world!",
  "cover": "81e481d94c3a9f22d65464b8e23c066e.jpg",
  "portrait_image": "81e481d94c3a9f22d65464b8e23c066e.jpg",
  "default_pdf_template": "landscape_single_16",
  "type": "landscape_single_16",
  "restrictions": [
    {
      "sync_id": "F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0",
      "field": "warehouse",
      "value": "warehouse",
      "mode": "whitelist"
    }
  ],
  "sort": 1,
  "entries": [
    {
      "type": "item",
      "item": {
        "style_number": "A396",
        "season": "spring/summer",
        "color": "all black",
        "name": "test",
        "brand_id": "172ak061712-001",
        "unique_key": "A396,spring/summer,all black",
        "schema_id": "537bcbd716af5274043a0992",
        "sizes": [
          {
            "size": "OS",
            "size_group": "A1",
            "pricing": {
              "USD": {
                "wholesale": 10,
                "retail": 12.1,
                "disabled": false
              }
            }
          }
        ],
        "banners": [
          "[583f5196675ef9ac78c1628d]"
        ],
        "size_groups": [
          "[ group1, group2, group3 ]"
        ],
        "available_now": false,
        "images": [
          "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
        ],
        "cancelled": false,
        "archived": false,
        "active": true,
        "description": "awesome product",
        "available_from": "2017/08/30",
        "available_until": "2019/08/30",
        "order_closing": "2017-09-12 00:00:00.000Z",
        "pricing": {
          "USD": {
            "wholesale": 10,
            "retail": 12.1,
            "disabled": false
          }
        },
        "seasons": [
          "[spring, summer, 2018]"
        ],
        "_id": "599611906873730001745011",
        "__size_ids": [
          "[599611906873730001745011]"
        ],
        "modified_on": "2017-09-11T22:30:04.911Z",
        "__inventory_cache": [
          {
            "bucket": "2018/07/25",
            "warehouse": "537bcbd716af5274043a09be",
            "sku_id": "59958be4ffb5c600017a05cb",
            "_id": "59b70e6a01c70700012dbdb8",
            "quantity": 72
          }
        ],
        "__inventory": [
          "[default]"
        ]
      },
      "item_id": "5a28ccf5b0aaf1000101ae55",
      "modified_on": 155667077878,
      "notes": "Hello, world!",
      "sync_id": "Hello, world!",
      "created_on": 1558098782447,
      "sort": 3372
    }
  ],
  "links": [
    {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "catalog_id": "593fec4a8f113256c806ac59",
      "created_on": 1558098782447,
      "label": "Some link label",
      "link": "Hello, world!"
    }
  ],
  "shares": "some description",
  "available_from": 1556670722522,
  "delivery_window_start": 1556670722522,
  "delivery_window_end": 155667079999,
  "prebook": true
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Catalog ID (24 character hex string)"
    },
    "sync_id": {
      "type": "string",
      "description": "Random UUID"
    },
    "brand_id": {
      "type": "string",
      "description": "ID of a brand owning Catalog"
    },
    "created_on": {
      "type": "number",
      "description": "Creation timestamp"
    },
    "modified_on": {
      "type": "number",
      "description": "Last modification timestamp"
    },
    "owner_account_id": {
      "type": "string",
      "description": "ID of an owner"
    },
    "active": {
      "type": "boolean",
      "description": "Flag denoting is catalog active"
    },
    "archived": {
      "type": "boolean",
      "description": "Flag denoting is catalog active"
    },
    "title": {
      "type": "string",
      "description": "Catalog's title"
    },
    "description": {
      "type": "string",
      "description": "Catalog's description"
    },
    "cover": {
      "type": "string",
      "description": "Cover image name"
    },
    "portrait_image": {
      "type": "string",
      "description": "Portrait image name"
    },
    "default_pdf_template": {
      "type": "string",
      "description": "Name of a default PDF template"
    },
    "type": {
      "type": "string",
      "description": "Catalog type 'landscape_single_16 | custom-list'"
    },
    "restrictions": {
      "type": "array",
      "description": "Array of catalog's restrictions"
    },
    "sort": {
      "type": "number",
      "description": "Sort order"
    },
    "entries": {
      "type": "array",
      "description": "Array of of catalog's entries"
    },
    "links": {
      "type": "array",
      "description": "Array of links to catalog"
    },
    "shares": {
      "type": "string"
    },
    "available_from": {
      "type": "number",
      "description": "Timestamp of when catalog is available from"
    },
    "delivery_window_start": {
      "type": "number",
      "description": "Timestamp of delivery windows start"
    },
    "delivery_window_end": {
      "type": "number",
      "description": "Timestamp of delivery windows end"
    },
    "prebook": {
      "type": "boolean",
      "description": "Is catalog available for prebook"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Validation error messages'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Fetch all Catalogs
GET`/api/v3.1/catalogs`

Example URI

GET https://nuorder.com/api/v3.1/catalogs

URI Parameters

HideShow

type

string (optional) Example: linesheet | catalog | custom-list

Identifies the catalog type

active

boolean (optional)

Used to query active, inactive or all catalogs

__sort: `modified_on`

string (optional)

Sort parameter

__sort_order

string (optional) Example: asc | desc

Sort direction

__limit

number (optional) Example: 100

Amount of returned records (by default is 50)

__last_id

string (optional) Example: 58bf12ef30c543013d31ef5d

ID of last catalog fetched (used for fetching next records)

__populate

enum (required)

Indicates data points to be fetched together with catalog

Choices: __variant __price __item

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": "593fec4a8f113256c806ac59",
    "sync_id": "F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0",
    "brand_id": "593fec4a8f113256c806ac59",
    "created_on": 1556670722522,
    "modified_on": 155667077878,
    "owner_account_id": "593fec4a8f113256c806ac59",
    "active": true,
    "archived": false,
    "title": "Hello, world!",
    "description": "Hello, world!",
    "cover": "81e481d94c3a9f22d65464b8e23c066e.jpg",
    "portrait_image": "81e481d94c3a9f22d65464b8e23c066e.jpg",
    "default_pdf_template": "landscape_single_16",
    "type": "landscape_single_16",
    "restrictions": [
      {
        "sync_id": "F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0",
        "field": "warehouse",
        "value": "warehouse",
        "mode": "whitelist"
      }
    ],
    "sort": 1,
    "entries": [
      {
        "type": "item",
        "item": {
          "style_number": "A396",
          "season": "spring/summer",
          "color": "all black",
          "name": "test",
          "brand_id": "172ak061712-001",
          "unique_key": "A396,spring/summer,all black",
          "schema_id": "537bcbd716af5274043a0992",
          "sizes": [
            {
              "size": "OS",
              "size_group": "A1",
              "pricing": {
                "USD": {
                  "wholesale": 10,
                  "retail": 12.1,
                  "disabled": false
                }
              }
            }
          ],
          "banners": [
            "[583f5196675ef9ac78c1628d]"
          ],
          "size_groups": [
            "[ group1, group2, group3 ]"
          ],
          "available_now": false,
          "images": [
            "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
          ],
          "cancelled": false,
          "archived": false,
          "active": true,
          "description": "awesome product",
          "available_from": "2017/08/30",
          "available_until": "2019/08/30",
          "order_closing": "2017-09-12 00:00:00.000Z",
          "pricing": {
            "USD": {
              "wholesale": 10,
              "retail": 12.1,
              "disabled": false
            }
          },
          "seasons": [
            "[spring, summer, 2018]"
          ],
          "_id": "599611906873730001745011",
          "__size_ids": [
            "[599611906873730001745011]"
          ],
          "modified_on": "2017-09-11T22:30:04.911Z",
          "__inventory_cache": [
            {
              "bucket": "2018/07/25",
              "warehouse": "537bcbd716af5274043a09be",
              "sku_id": "59958be4ffb5c600017a05cb",
              "_id": "59b70e6a01c70700012dbdb8",
              "quantity": 72
            }
          ],
          "__inventory": [
            "[default]"
          ]
        },
        "item_id": "5a28ccf5b0aaf1000101ae55",
        "modified_on": 155667077878,
        "notes": "Hello, world!",
        "sync_id": "Hello, world!",
        "created_on": 1558098782447,
        "sort": 3372
      }
    ],
    "links": [
      {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "catalog_id": "593fec4a8f113256c806ac59",
        "created_on": 1558098782447,
        "label": "Some link label",
        "link": "Hello, world!"
      }
    ],
    "shares": "some description",
    "available_from": 1556670722522,
    "delivery_window_start": 1556670722522,
    "delivery_window_end": 155667079999,
    "prebook": true
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Fetch Catalog by ID
GET`/api/v3.1/catalog/{id}`

Example URI

GET https://nuorder.com/api/v3.1/catalog/59af25379042bd00013b7996

URI Parameters

HideShow

id: string (required) Example: 59af25379042bd00013b7996
catalog id

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": "593fec4a8f113256c806ac59",
  "sync_id": "F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0",
  "brand_id": "593fec4a8f113256c806ac59",
  "created_on": 1556670722522,
  "modified_on": 155667077878,
  "owner_account_id": "593fec4a8f113256c806ac59",
  "active": true,
  "archived": false,
  "title": "Hello, world!",
  "description": "Hello, world!",
  "cover": "81e481d94c3a9f22d65464b8e23c066e.jpg",
  "portrait_image": "81e481d94c3a9f22d65464b8e23c066e.jpg",
  "default_pdf_template": "landscape_single_16",
  "type": "landscape_single_16",
  "restrictions": [
    {
      "sync_id": "F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0",
      "field": "warehouse",
      "value": "warehouse",
      "mode": "whitelist"
    }
  ],
  "sort": 1,
  "entries": [
    {
      "type": "item",
      "item": {
        "style_number": "A396",
        "season": "spring/summer",
        "color": "all black",
        "name": "test",
        "brand_id": "172ak061712-001",
        "unique_key": "A396,spring/summer,all black",
        "schema_id": "537bcbd716af5274043a0992",
        "sizes": [
          {
            "size": "OS",
            "size_group": "A1",
            "pricing": {
              "USD": {
                "wholesale": 10,
                "retail": 12.1,
                "disabled": false
              }
            }
          }
        ],
        "banners": [
          "[583f5196675ef9ac78c1628d]"
        ],
        "size_groups": [
          "[ group1, group2, group3 ]"
        ],
        "available_now": false,
        "images": [
          "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
        ],
        "cancelled": false,
        "archived": false,
        "active": true,
        "description": "awesome product",
        "available_from": "2017/08/30",
        "available_until": "2019/08/30",
        "order_closing": "2017-09-12 00:00:00.000Z",
        "pricing": {
          "USD": {
            "wholesale": 10,
            "retail": 12.1,
            "disabled": false
          }
        },
        "seasons": [
          "[spring, summer, 2018]"
        ],
        "_id": "599611906873730001745011",
        "__size_ids": [
          "[599611906873730001745011]"
        ],
        "modified_on": "2017-09-11T22:30:04.911Z",
        "__inventory_cache": [
          {
            "bucket": "2018/07/25",
            "warehouse": "537bcbd716af5274043a09be",
            "sku_id": "59958be4ffb5c600017a05cb",
            "_id": "59b70e6a01c70700012dbdb8",
            "quantity": 72
          }
        ],
        "__inventory": [
          "[default]"
        ]
      },
      "item_id": "5a28ccf5b0aaf1000101ae55",
      "modified_on": 155667077878,
      "notes": "Hello, world!",
      "sync_id": "Hello, world!",
      "created_on": 1558098782447,
      "sort": 3372
    }
  ],
  "links": [
    {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "catalog_id": "593fec4a8f113256c806ac59",
      "created_on": 1558098782447,
      "label": "Some link label",
      "link": "Hello, world!"
    }
  ],
  "shares": "some description",
  "available_from": 1556670722522,
  "delivery_window_start": 1556670722522,
  "delivery_window_end": 155667079999,
  "prebook": true
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Catalog ID (24 character hex string)"
    },
    "sync_id": {
      "type": "string",
      "description": "Random UUID"
    },
    "brand_id": {
      "type": "string",
      "description": "ID of a brand owning Catalog"
    },
    "created_on": {
      "type": "number",
      "description": "Creation timestamp"
    },
    "modified_on": {
      "type": "number",
      "description": "Last modification timestamp"
    },
    "owner_account_id": {
      "type": "string",
      "description": "ID of an owner"
    },
    "active": {
      "type": "boolean",
      "description": "Flag denoting is catalog active"
    },
    "archived": {
      "type": "boolean",
      "description": "Flag denoting is catalog active"
    },
    "title": {
      "type": "string",
      "description": "Catalog's title"
    },
    "description": {
      "type": "string",
      "description": "Catalog's description"
    },
    "cover": {
      "type": "string",
      "description": "Cover image name"
    },
    "portrait_image": {
      "type": "string",
      "description": "Portrait image name"
    },
    "default_pdf_template": {
      "type": "string",
      "description": "Name of a default PDF template"
    },
    "type": {
      "type": "string",
      "description": "Catalog type 'landscape_single_16 | custom-list'"
    },
    "restrictions": {
      "type": "array",
      "description": "Array of catalog's restrictions"
    },
    "sort": {
      "type": "number",
      "description": "Sort order"
    },
    "entries": {
      "type": "array",
      "description": "Array of of catalog's entries"
    },
    "links": {
      "type": "array",
      "description": "Array of links to catalog"
    },
    "shares": {
      "type": "string"
    },
    "available_from": {
      "type": "number",
      "description": "Timestamp of when catalog is available from"
    },
    "delivery_window_start": {
      "type": "number",
      "description": "Timestamp of delivery windows start"
    },
    "delivery_window_end": {
      "type": "number",
      "description": "Timestamp of delivery windows end"
    },
    "prebook": {
      "type": "boolean",
      "description": "Is catalog available for prebook"
    }
  }
}

Update Catalog by ID
PATCH`/api/v3.1/catalog/{id}`

Example URI

PATCH https://nuorder.com/api/v3.1/catalog/58beec5330c543013d31ef5b

URI Parameters

HideShow

id: string (required) Example: 58beec5330c543013d31ef5b
Catalog ID

Request Partial Example

HideShow

This is a PATCH endpoint, so you need only send what changed.

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
    title: 'New Catalog Title'
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": "593fec4a8f113256c806ac59",
  "sync_id": "F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0",
  "brand_id": "593fec4a8f113256c806ac59",
  "created_on": 1556670722522,
  "modified_on": 155667077878,
  "owner_account_id": "593fec4a8f113256c806ac59",
  "active": true,
  "archived": false,
  "title": "Hello, world!",
  "description": "Hello, world!",
  "cover": "81e481d94c3a9f22d65464b8e23c066e.jpg",
  "portrait_image": "81e481d94c3a9f22d65464b8e23c066e.jpg",
  "default_pdf_template": "landscape_single_16",
  "type": "landscape_single_16",
  "restrictions": [
    {
      "sync_id": "F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0",
      "field": "warehouse",
      "value": "warehouse",
      "mode": "whitelist"
    }
  ],
  "sort": 1,
  "entries": [
    {
      "type": "item",
      "item": {
        "style_number": "A396",
        "season": "spring/summer",
        "color": "all black",
        "name": "test",
        "brand_id": "172ak061712-001",
        "unique_key": "A396,spring/summer,all black",
        "schema_id": "537bcbd716af5274043a0992",
        "sizes": [
          {
            "size": "OS",
            "size_group": "A1",
            "pricing": {
              "USD": {
                "wholesale": 10,
                "retail": 12.1,
                "disabled": false
              }
            }
          }
        ],
        "banners": [
          "[583f5196675ef9ac78c1628d]"
        ],
        "size_groups": [
          "[ group1, group2, group3 ]"
        ],
        "available_now": false,
        "images": [
          "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
        ],
        "cancelled": false,
        "archived": false,
        "active": true,
        "description": "awesome product",
        "available_from": "2017/08/30",
        "available_until": "2019/08/30",
        "order_closing": "2017-09-12 00:00:00.000Z",
        "pricing": {
          "USD": {
            "wholesale": 10,
            "retail": 12.1,
            "disabled": false
          }
        },
        "seasons": [
          "[spring, summer, 2018]"
        ],
        "_id": "599611906873730001745011",
        "__size_ids": [
          "[599611906873730001745011]"
        ],
        "modified_on": "2017-09-11T22:30:04.911Z",
        "__inventory_cache": [
          {
            "bucket": "2018/07/25",
            "warehouse": "537bcbd716af5274043a09be",
            "sku_id": "59958be4ffb5c600017a05cb",
            "_id": "59b70e6a01c70700012dbdb8",
            "quantity": 72
          }
        ],
        "__inventory": [
          "[default]"
        ]
      },
      "item_id": "5a28ccf5b0aaf1000101ae55",
      "modified_on": 155667077878,
      "notes": "Hello, world!",
      "sync_id": "Hello, world!",
      "created_on": 1558098782447,
      "sort": 3372
    }
  ],
  "links": [
    {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "catalog_id": "593fec4a8f113256c806ac59",
      "created_on": 1558098782447,
      "label": "Some link label",
      "link": "Hello, world!"
    }
  ],
  "shares": "some description",
  "available_from": 1556670722522,
  "delivery_window_start": 1556670722522,
  "delivery_window_end": 155667079999,
  "prebook": true
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Catalog ID (24 character hex string)"
    },
    "sync_id": {
      "type": "string",
      "description": "Random UUID"
    },
    "brand_id": {
      "type": "string",
      "description": "ID of a brand owning Catalog"
    },
    "created_on": {
      "type": "number",
      "description": "Creation timestamp"
    },
    "modified_on": {
      "type": "number",
      "description": "Last modification timestamp"
    },
    "owner_account_id": {
      "type": "string",
      "description": "ID of an owner"
    },
    "active": {
      "type": "boolean",
      "description": "Flag denoting is catalog active"
    },
    "archived": {
      "type": "boolean",
      "description": "Flag denoting is catalog active"
    },
    "title": {
      "type": "string",
      "description": "Catalog's title"
    },
    "description": {
      "type": "string",
      "description": "Catalog's description"
    },
    "cover": {
      "type": "string",
      "description": "Cover image name"
    },
    "portrait_image": {
      "type": "string",
      "description": "Portrait image name"
    },
    "default_pdf_template": {
      "type": "string",
      "description": "Name of a default PDF template"
    },
    "type": {
      "type": "string",
      "description": "Catalog type 'landscape_single_16 | custom-list'"
    },
    "restrictions": {
      "type": "array",
      "description": "Array of catalog's restrictions"
    },
    "sort": {
      "type": "number",
      "description": "Sort order"
    },
    "entries": {
      "type": "array",
      "description": "Array of of catalog's entries"
    },
    "links": {
      "type": "array",
      "description": "Array of links to catalog"
    },
    "shares": {
      "type": "string"
    },
    "available_from": {
      "type": "number",
      "description": "Timestamp of when catalog is available from"
    },
    "delivery_window_start": {
      "type": "number",
      "description": "Timestamp of delivery windows start"
    },
    "delivery_window_end": {
      "type": "number",
      "description": "Timestamp of delivery windows end"
    },
    "prebook": {
      "type": "boolean",
      "description": "Is catalog available for prebook"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Error message with what field(s) need to be corrected',
    args: {
        /* fields that need to be corrected */
    }
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage catalogs'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Catalog not found',
    {
        id: '58beec5330c543013d31ef5b'
    }
}

Remove Catalog by ID
DELETE`/api/v3.1/catalog/{id}`

Example URI

DELETE https://nuorder.com/api/v3.1/catalog/59af25379042bd00013b7996

URI Parameters

HideShow

id: string (required) Example: 59af25379042bd00013b7996
catalog id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    id: '59af25379042bd00013b7996',
    success: true
}

Catalog Entries ¶

APIs for managing your Catalog entries.

Fetch catalog entries
GET`/api/v3.1/catalog/entries`

Example URI

GET https://nuorder.com/api/v3.1/catalog/entries

URI Parameters

HideShow

__archived

boolean (optional)

Used to query active, inactive or all catalogs

__search

string (optional) Example: red jacket

A search string

__limit

number (optional) Example: 100

Amount of returned records (by default is 50)

__last_id

string (optional) Example: 58bf12ef30c543013d31ef5d

ID of last catalog entry fetched (used for fetching next entries)

__populate

enum (required)

Indicates data points to be fetched together with catalog

Choices: __variant __price __item

__fields: `__all`

array[string] (required)

Array of field names

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": "5cdeb35ef0c7ae0337a6779e",
  "catalog_id": "5cafcc501aedea3950cf8047",
  "type": "item",
  "item": {
    "style_number": "A396",
    "season": "spring/summer",
    "color": "all black",
    "name": "test",
    "brand_id": "172ak061712-001",
    "unique_key": "A396,spring/summer,all black",
    "schema_id": "537bcbd716af5274043a0992",
    "sizes": [
      {
        "size": "OS",
        "size_group": "A1",
        "pricing": {
          "USD": {
            "wholesale": 10,
            "retail": 12.1,
            "disabled": false
          }
        }
      }
    ],
    "banners": [
      "[583f5196675ef9ac78c1628d]"
    ],
    "size_groups": [
      "[ group1, group2, group3 ]"
    ],
    "available_now": false,
    "images": [
      "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
    ],
    "cancelled": false,
    "archived": false,
    "active": true,
    "description": "awesome product",
    "available_from": "2017/08/30",
    "available_until": "2019/08/30",
    "order_closing": "2017-09-12 00:00:00.000Z",
    "pricing": {
      "USD": {
        "wholesale": 10,
        "retail": 12.1,
        "disabled": false
      }
    },
    "seasons": [
      "[spring, summer, 2018]"
    ],
    "_id": "599611906873730001745011",
    "__size_ids": [
      "[599611906873730001745011]"
    ],
    "modified_on": "2017-09-11T22:30:04.911Z",
    "__inventory_cache": [
      {
        "bucket": "2018/07/25",
        "warehouse": "537bcbd716af5274043a09be",
        "sku_id": "59958be4ffb5c600017a05cb",
        "_id": "59b70e6a01c70700012dbdb8",
        "quantity": 72
      }
    ],
    "__inventory": [
      "[default]"
    ]
  },
  "item_id": "5a28ccf5b0aaf1000101ae55",
  "modified_on": 155667077878,
  "notes": "Hello, world!",
  "sync_id": "Hello, world!",
  "created_on": 1558098782447,
  "sort": 3372
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Entry ID (24 character hex string)"
    },
    "catalog_id": {
      "type": "string",
      "description": "Catalog ID (24 character hex string)"
    },
    "type": {
      "type": "string",
      "description": "Entry type ('item | separator | image')"
    },
    "item": {
      "type": "object",
      "properties": {
        "style_number": {
          "type": "string",
          "description": "product style number"
        },
        "season": {
          "type": "string",
          "description": "product season"
        },
        "color": {
          "type": "string",
          "description": "product color"
        },
        "name": {
          "type": "string",
          "description": "product name"
        },
        "brand_id": {
          "type": "string",
          "description": "product external identificator"
        },
        "unique_key": {
          "type": "string",
          "description": "Product unique key"
        },
        "schema_id": {
          "type": "string",
          "description": "product schema id"
        },
        "sizes": {
          "type": "array",
          "description": "product sizes"
        },
        "banners": {
          "type": "array",
          "description": "order banners"
        },
        "size_groups": {
          "type": "array",
          "description": "size groups"
        },
        "available_now": {
          "type": "boolean",
          "description": "whether product is available now"
        },
        "images": {
          "type": "array",
          "description": "product images URLs: upload Images via API not supported at this time"
        },
        "cancelled": {
          "type": "boolean",
          "description": "whether product was cancelled"
        },
        "archived": {
          "type": "boolean",
          "description": "whether product was archived"
        },
        "active": {
          "type": "boolean",
          "description": "whether product is active,"
        },
        "description": {
          "type": "string",
          "description": "product description"
        },
        "available_from": {
          "type": "string",
          "description": "date available from"
        },
        "available_until": {
          "type": "string",
          "description": "date available until"
        },
        "order_closing": {
          "type": "string",
          "description": "date order closing"
        },
        "pricing": {
          "type": "object",
          "properties": {
            "USD": {
              "type": "object",
              "properties": {
                "wholesale": {
                  "type": "number",
                  "description": "wholesale price"
                },
                "retail": {
                  "type": "number",
                  "description": "retail price"
                },
                "disabled": {
                  "type": "boolean",
                  "description": "whether price is disabled"
                }
              },
              "required": [
                "wholesale"
              ]
            }
          },
          "description": "product pricing"
        },
        "seasons": {
          "type": "array",
          "description": "product additional seasons"
        },
        "_id": {
          "type": "string",
          "description": "product ID"
        },
        "__size_ids": {
          "type": "array",
          "description": "size ids array"
        },
        "modified_on": {
          "type": "string",
          "description": "last modified date"
        },
        "__inventory_cache": {
          "type": "array",
          "description": "inventory cached data (DEPRECATED, to be removed soon)"
        },
        "__inventory": {
          "type": "array",
          "description": "inventory names"
        }
      },
      "required": [
        "style_number",
        "season",
        "color",
        "name",
        "sizes",
        "pricing"
      ]
    },
    "item_id": {
      "type": "string",
      "description": "Product ID (24 character hex string)"
    },
    "modified_on": {
      "type": "number",
      "description": "Last modification timestamp"
    },
    "notes": {
      "type": "string",
      "description": "Notes"
    },
    "sync_id": {
      "type": "string",
      "description": "Random `F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0` (string) - Random UUID"
    },
    "created_on": {
      "type": "number",
      "description": "Creation timestamp"
    },
    "sort": {
      "type": "number",
      "description": "Sort order"
    }
  }
}

Create catalog entry
POST`/api/v3.1/catalog/{id}/entries`

Example URI

POST https://nuorder.com/api/v3.1/catalog/5cafcc501aedea3950cf8047/entries

URI Parameters

HideShow

id: string (required) Example: 5cafcc501aedea3950cf8047
Catalog ID

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "id": "5cdeb35ef0c7ae0337a6779e",
  "catalog_id": "5cafcc501aedea3950cf8047",
  "type": "item",
  "item": {
    "style_number": "A396",
    "season": "spring/summer",
    "color": "all black",
    "name": "test",
    "brand_id": "172ak061712-001",
    "unique_key": "A396,spring/summer,all black",
    "schema_id": "537bcbd716af5274043a0992",
    "sizes": [
      {
        "size": "OS",
        "size_group": "A1",
        "pricing": {
          "USD": {
            "wholesale": 10,
            "retail": 12.1,
            "disabled": false
          }
        }
      }
    ],
    "banners": [
      "[583f5196675ef9ac78c1628d]"
    ],
    "size_groups": [
      "[ group1, group2, group3 ]"
    ],
    "available_now": false,
    "images": [
      "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
    ],
    "cancelled": false,
    "archived": false,
    "active": true,
    "description": "awesome product",
    "available_from": "2017/08/30",
    "available_until": "2019/08/30",
    "order_closing": "2017-09-12 00:00:00.000Z",
    "pricing": {
      "USD": {
        "wholesale": 10,
        "retail": 12.1,
        "disabled": false
      }
    },
    "seasons": [
      "[spring, summer, 2018]"
    ],
    "_id": "599611906873730001745011",
    "__size_ids": [
      "[599611906873730001745011]"
    ],
    "modified_on": "2017-09-11T22:30:04.911Z",
    "__inventory_cache": [
      {
        "bucket": "2018/07/25",
        "warehouse": "537bcbd716af5274043a09be",
        "sku_id": "59958be4ffb5c600017a05cb",
        "_id": "59b70e6a01c70700012dbdb8",
        "quantity": 72
      }
    ],
    "__inventory": [
      "[default]"
    ]
  },
  "item_id": "5a28ccf5b0aaf1000101ae55",
  "modified_on": 155667077878,
  "notes": "Hello, world!",
  "sync_id": "Hello, world!",
  "created_on": 1558098782447,
  "sort": 3372
}

Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Entry ID (24 character hex string)"
    },
    "catalog_id": {
      "type": "string",
      "description": "Catalog ID (24 character hex string)"
    },
    "type": {
      "type": "string",
      "description": "Entry type ('item | separator | image')"
    },
    "item": {
      "type": "object",
      "properties": {
        "style_number": {
          "type": "string",
          "description": "product style number"
        },
        "season": {
          "type": "string",
          "description": "product season"
        },
        "color": {
          "type": "string",
          "description": "product color"
        },
        "name": {
          "type": "string",
          "description": "product name"
        },
        "brand_id": {
          "type": "string",
          "description": "product external identificator"
        },
        "unique_key": {
          "type": "string",
          "description": "Product unique key"
        },
        "schema_id": {
          "type": "string",
          "description": "product schema id"
        },
        "sizes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "size": {
                "type": "string",
                "description": "size name"
              },
              "size_group": {
                "type": "string",
                "description": "size group"
              },
              "pricing": {
                "type": "object",
                "properties": {
                  "USD": {
                    "type": "object",
                    "properties": {
                      "wholesale": {
                        "type": "number",
                        "description": "wholesale price"
                      },
                      "retail": {
                        "type": "number",
                        "description": "retail price"
                      },
                      "disabled": {
                        "type": "boolean",
                        "description": "whether price is disabled"
                      }
                    },
                    "required": [
                      "wholesale"
                    ]
                  }
                },
                "description": "size prices in available currencies, It is important to specify prices at the size level only when there is variation in pricing for a product based on its size. If prices remain consistent across all sizes, product-level pricing will be sufficient."
              }
            }
          },
          "description": "product sizes"
        },
        "banners": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "order banners"
        },
        "size_groups": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "size groups"
        },
        "available_now": {
          "type": "boolean",
          "description": "whether product is available now"
        },
        "images": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "product images URLs: upload Images via API not supported at this time"
        },
        "cancelled": {
          "type": "boolean",
          "description": "whether product was cancelled"
        },
        "archived": {
          "type": "boolean",
          "description": "whether product was archived"
        },
        "active": {
          "type": "boolean",
          "description": "whether product is active,"
        },
        "description": {
          "type": "string",
          "description": "product description"
        },
        "available_from": {
          "type": "string",
          "description": "date available from"
        },
        "available_until": {
          "type": "string",
          "description": "date available until"
        },
        "order_closing": {
          "type": "string",
          "description": "date order closing"
        },
        "pricing": {
          "type": "object",
          "properties": {
            "USD": {
              "type": "object",
              "properties": {
                "wholesale": {
                  "type": "number",
                  "description": "wholesale price"
                },
                "retail": {
                  "type": "number",
                  "description": "retail price"
                },
                "disabled": {
                  "type": "boolean",
                  "description": "whether price is disabled"
                }
              },
              "required": [
                "wholesale"
              ]
            }
          },
          "description": "product pricing"
        },
        "seasons": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "product additional seasons"
        },
        "_id": {
          "type": "string",
          "description": "product ID"
        },
        "__size_ids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "size ids array"
        },
        "modified_on": {
          "type": "string",
          "description": "last modified date"
        },
        "__inventory_cache": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "bucket": {
                "type": "string",
                "description": "bucket name,"
              },
              "warehouse": {
                "type": "string",
                "description": "warehouse ID,"
              },
              "sku_id": {
                "type": "string",
                "description": "sku ID"
              },
              "_id": {
                "type": "string",
                "description": "inventory cache id"
              },
              "quantity": {
                "type": "number",
                "description": "quantity amount"
              }
            }
          },
          "description": "inventory cached data (DEPRECATED, to be removed soon)"
        },
        "__inventory": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "inventory names"
        }
      },
      "required": [
        "style_number",
        "season",
        "color",
        "name",
        "sizes",
        "pricing"
      ]
    },
    "item_id": {
      "type": "string",
      "description": "Product ID (24 character hex string)"
    },
    "modified_on": {
      "type": "number",
      "description": "Last modification timestamp"
    },
    "notes": {
      "type": "string",
      "description": "Notes"
    },
    "sync_id": {
      "type": "string",
      "description": "Random `F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0` (string) - Random UUID"
    },
    "created_on": {
      "type": "number",
      "description": "Creation timestamp"
    },
    "sort": {
      "type": "number",
      "description": "Sort order"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": "5cdeb35ef0c7ae0337a6779e",
    "catalog_id": "5cafcc501aedea3950cf8047",
    "type": "item",
    "item": {
      "style_number": "A396",
      "season": "spring/summer",
      "color": "all black",
      "name": "test",
      "brand_id": "172ak061712-001",
      "unique_key": "A396,spring/summer,all black",
      "schema_id": "537bcbd716af5274043a0992",
      "sizes": [
        {
          "size": "OS",
          "size_group": "A1",
          "pricing": {
            "USD": {
              "wholesale": 10,
              "retail": 12.1,
              "disabled": false
            }
          }
        }
      ],
      "banners": [
        "[583f5196675ef9ac78c1628d]"
      ],
      "size_groups": [
        "[ group1, group2, group3 ]"
      ],
      "available_now": false,
      "images": [
        "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
      ],
      "cancelled": false,
      "archived": false,
      "active": true,
      "description": "awesome product",
      "available_from": "2017/08/30",
      "available_until": "2019/08/30",
      "order_closing": "2017-09-12 00:00:00.000Z",
      "pricing": {
        "USD": {
          "wholesale": 10,
          "retail": 12.1,
          "disabled": false
        }
      },
      "seasons": [
        "[spring, summer, 2018]"
      ],
      "_id": "599611906873730001745011",
      "__size_ids": [
        "[599611906873730001745011]"
      ],
      "modified_on": "2017-09-11T22:30:04.911Z",
      "__inventory_cache": [
        {
          "bucket": "2018/07/25",
          "warehouse": "537bcbd716af5274043a09be",
          "sku_id": "59958be4ffb5c600017a05cb",
          "_id": "59b70e6a01c70700012dbdb8",
          "quantity": 72
        }
      ],
      "__inventory": [
        "[default]"
      ]
    },
    "item_id": "5a28ccf5b0aaf1000101ae55",
    "modified_on": 155667077878,
    "notes": "Hello, world!",
    "sync_id": "Hello, world!",
    "created_on": 1558098782447,
    "sort": 3372
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Validation error messages'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'You do not have permission to edit this catalog'
}

Bulk create catalog entries
POST`/api/v3.1/catalog/{id}/entries/bulk`

Example URI

POST https://nuorder.com/api/v3.1/catalog/5cafcc501aedea3950cf8047/entries/bulk

URI Parameters

HideShow

id: string (required) Example: 5cafcc501aedea3950cf8047
Catalog ID

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "entries": [
    {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "catalog_id": "5cafcc501aedea3950cf8047",
      "type": "item",
      "item": {
        "style_number": "A396",
        "season": "spring/summer",
        "color": "all black",
        "name": "test",
        "brand_id": "172ak061712-001",
        "unique_key": "A396,spring/summer,all black",
        "schema_id": "537bcbd716af5274043a0992",
        "sizes": [
          {
            "size": "OS",
            "size_group": "A1",
            "pricing": {
              "USD": {
                "wholesale": 10,
                "retail": 12.1,
                "disabled": false
              }
            }
          }
        ],
        "banners": [
          "[583f5196675ef9ac78c1628d]"
        ],
        "size_groups": [
          "[ group1, group2, group3 ]"
        ],
        "available_now": false,
        "images": [
          "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
        ],
        "cancelled": false,
        "archived": false,
        "active": true,
        "description": "awesome product",
        "available_from": "2017/08/30",
        "available_until": "2019/08/30",
        "order_closing": "2017-09-12 00:00:00.000Z",
        "pricing": {
          "USD": {
            "wholesale": 10,
            "retail": 12.1,
            "disabled": false
          }
        },
        "seasons": [
          "[spring, summer, 2018]"
        ],
        "_id": "599611906873730001745011",
        "__size_ids": [
          "[599611906873730001745011]"
        ],
        "modified_on": "2017-09-11T22:30:04.911Z",
        "__inventory_cache": [
          {
            "bucket": "2018/07/25",
            "warehouse": "537bcbd716af5274043a09be",
            "sku_id": "59958be4ffb5c600017a05cb",
            "_id": "59b70e6a01c70700012dbdb8",
            "quantity": 72
          }
        ],
        "__inventory": [
          "[default]"
        ]
      },
      "item_id": "5a28ccf5b0aaf1000101ae55",
      "modified_on": 155667077878,
      "notes": "Hello, world!",
      "sync_id": "Hello, world!",
      "created_on": 1558098782447,
      "sort": 3372
    }
  ]
}

Schema

{
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Entry ID (24 character hex string)"
          },
          "catalog_id": {
            "type": "string",
            "description": "Catalog ID (24 character hex string)"
          },
          "type": {
            "type": "string",
            "description": "Entry type ('item | separator | image')"
          },
          "item": {
            "type": "object",
            "properties": {
              "style_number": {
                "type": "string",
                "description": "product style number"
              },
              "season": {
                "type": "string",
                "description": "product season"
              },
              "color": {
                "type": "string",
                "description": "product color"
              },
              "name": {
                "type": "string",
                "description": "product name"
              },
              "brand_id": {
                "type": "string",
                "description": "product external identificator"
              },
              "unique_key": {
                "type": "string",
                "description": "Product unique key"
              },
              "schema_id": {
                "type": "string",
                "description": "product schema id"
              },
              "sizes": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "size": {
                      "type": "string",
                      "description": "size name"
                    },
                    "size_group": {
                      "type": "string",
                      "description": "size group"
                    },
                    "pricing": {
                      "type": "object",
                      "properties": {
                        "USD": {
                          "type": "object",
                          "properties": {
                            "wholesale": {
                              "type": "number",
                              "description": "wholesale price"
                            },
                            "retail": {
                              "type": "number",
                              "description": "retail price"
                            },
                            "disabled": {
                              "type": "boolean",
                              "description": "whether price is disabled"
                            }
                          },
                          "required": [
                            "wholesale"
                          ]
                        }
                      },
                      "description": "size prices in available currencies, It is important to specify prices at the size level only when there is variation in pricing for a product based on its size. If prices remain consistent across all sizes, product-level pricing will be sufficient."
                    }
                  }
                },
                "description": "product sizes"
              },
              "banners": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "order banners"
              },
              "size_groups": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "size groups"
              },
              "available_now": {
                "type": "boolean",
                "description": "whether product is available now"
              },
              "images": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "product images URLs: upload Images via API not supported at this time"
              },
              "cancelled": {
                "type": "boolean",
                "description": "whether product was cancelled"
              },
              "archived": {
                "type": "boolean",
                "description": "whether product was archived"
              },
              "active": {
                "type": "boolean",
                "description": "whether product is active,"
              },
              "description": {
                "type": "string",
                "description": "product description"
              },
              "available_from": {
                "type": "string",
                "description": "date available from"
              },
              "available_until": {
                "type": "string",
                "description": "date available until"
              },
              "order_closing": {
                "type": "string",
                "description": "date order closing"
              },
              "pricing": {
                "type": "object",
                "properties": {
                  "USD": {
                    "type": "object",
                    "properties": {
                      "wholesale": {
                        "type": "number",
                        "description": "wholesale price"
                      },
                      "retail": {
                        "type": "number",
                        "description": "retail price"
                      },
                      "disabled": {
                        "type": "boolean",
                        "description": "whether price is disabled"
                      }
                    },
                    "required": [
                      "wholesale"
                    ]
                  }
                },
                "description": "product pricing"
              },
              "seasons": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "product additional seasons"
              },
              "_id": {
                "type": "string",
                "description": "product ID"
              },
              "__size_ids": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "size ids array"
              },
              "modified_on": {
                "type": "string",
                "description": "last modified date"
              },
              "__inventory_cache": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "bucket": {
                      "type": "string",
                      "description": "bucket name,"
                    },
                    "warehouse": {
                      "type": "string",
                      "description": "warehouse ID,"
                    },
                    "sku_id": {
                      "type": "string",
                      "description": "sku ID"
                    },
                    "_id": {
                      "type": "string",
                      "description": "inventory cache id"
                    },
                    "quantity": {
                      "type": "number",
                      "description": "quantity amount"
                    }
                  }
                },
                "description": "inventory cached data (DEPRECATED, to be removed soon)"
              },
              "__inventory": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "inventory names"
              }
            },
            "required": [
              "style_number",
              "season",
              "color",
              "name",
              "sizes",
              "pricing"
            ]
          },
          "item_id": {
            "type": "string",
            "description": "Product ID (24 character hex string)"
          },
          "modified_on": {
            "type": "number",
            "description": "Last modification timestamp"
          },
          "notes": {
            "type": "string",
            "description": "Notes"
          },
          "sync_id": {
            "type": "string",
            "description": "Random `F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0` (string) - Random UUID"
          },
          "created_on": {
            "type": "number",
            "description": "Creation timestamp"
          },
          "sort": {
            "type": "number",
            "description": "Sort order"
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": "5cdeb35ef0c7ae0337a6779e",
    "catalog_id": "5cafcc501aedea3950cf8047",
    "type": "item",
    "item": {
      "style_number": "A396",
      "season": "spring/summer",
      "color": "all black",
      "name": "test",
      "brand_id": "172ak061712-001",
      "unique_key": "A396,spring/summer,all black",
      "schema_id": "537bcbd716af5274043a0992",
      "sizes": [
        {
          "size": "OS",
          "size_group": "A1",
          "pricing": {
            "USD": {
              "wholesale": 10,
              "retail": 12.1,
              "disabled": false
            }
          }
        }
      ],
      "banners": [
        "[583f5196675ef9ac78c1628d]"
      ],
      "size_groups": [
        "[ group1, group2, group3 ]"
      ],
      "available_now": false,
      "images": [
        "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
      ],
      "cancelled": false,
      "archived": false,
      "active": true,
      "description": "awesome product",
      "available_from": "2017/08/30",
      "available_until": "2019/08/30",
      "order_closing": "2017-09-12 00:00:00.000Z",
      "pricing": {
        "USD": {
          "wholesale": 10,
          "retail": 12.1,
          "disabled": false
        }
      },
      "seasons": [
        "[spring, summer, 2018]"
      ],
      "_id": "599611906873730001745011",
      "__size_ids": [
        "[599611906873730001745011]"
      ],
      "modified_on": "2017-09-11T22:30:04.911Z",
      "__inventory_cache": [
        {
          "bucket": "2018/07/25",
          "warehouse": "537bcbd716af5274043a09be",
          "sku_id": "59958be4ffb5c600017a05cb",
          "_id": "59b70e6a01c70700012dbdb8",
          "quantity": 72
        }
      ],
      "__inventory": [
        "[default]"
      ]
    },
    "item_id": "5a28ccf5b0aaf1000101ae55",
    "modified_on": 155667077878,
    "notes": "Hello, world!",
    "sync_id": "Hello, world!",
    "created_on": 1558098782447,
    "sort": 3372
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Validation error messages'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'You do not have permission to edit this catalog'
}

Bulk create catalog entries with details
POST`/api/v3.1/catalog/{id}/entries/bulk/summarized`

Example URI

POST https://nuorder.com/api/v3.1/catalog/5cafcc501aedea3950cf8047/entries/bulk/summarized

URI Parameters

HideShow

id: string (required) Example: 5cafcc501aedea3950cf8047
Catalog ID

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "entries": [
    {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "catalog_id": "5cafcc501aedea3950cf8047",
      "type": "item",
      "item": {
        "style_number": "A396",
        "season": "spring/summer",
        "color": "all black",
        "name": "test",
        "brand_id": "172ak061712-001",
        "unique_key": "A396,spring/summer,all black",
        "schema_id": "537bcbd716af5274043a0992",
        "sizes": [
          {
            "size": "OS",
            "size_group": "A1",
            "pricing": {
              "USD": {
                "wholesale": 10,
                "retail": 12.1,
                "disabled": false
              }
            }
          }
        ],
        "banners": [
          "[583f5196675ef9ac78c1628d]"
        ],
        "size_groups": [
          "[ group1, group2, group3 ]"
        ],
        "available_now": false,
        "images": [
          "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
        ],
        "cancelled": false,
        "archived": false,
        "active": true,
        "description": "awesome product",
        "available_from": "2017/08/30",
        "available_until": "2019/08/30",
        "order_closing": "2017-09-12 00:00:00.000Z",
        "pricing": {
          "USD": {
            "wholesale": 10,
            "retail": 12.1,
            "disabled": false
          }
        },
        "seasons": [
          "[spring, summer, 2018]"
        ],
        "_id": "599611906873730001745011",
        "__size_ids": [
          "[599611906873730001745011]"
        ],
        "modified_on": "2017-09-11T22:30:04.911Z",
        "__inventory_cache": [
          {
            "bucket": "2018/07/25",
            "warehouse": "537bcbd716af5274043a09be",
            "sku_id": "59958be4ffb5c600017a05cb",
            "_id": "59b70e6a01c70700012dbdb8",
            "quantity": 72
          }
        ],
        "__inventory": [
          "[default]"
        ]
      },
      "item_id": "5a28ccf5b0aaf1000101ae55",
      "modified_on": 155667077878,
      "notes": "Hello, world!",
      "sync_id": "Hello, world!",
      "created_on": 1558098782447,
      "sort": 3372
    }
  ]
}

Schema

{
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Entry ID (24 character hex string)"
          },
          "catalog_id": {
            "type": "string",
            "description": "Catalog ID (24 character hex string)"
          },
          "type": {
            "type": "string",
            "description": "Entry type ('item | separator | image')"
          },
          "item": {
            "type": "object",
            "properties": {
              "style_number": {
                "type": "string",
                "description": "product style number"
              },
              "season": {
                "type": "string",
                "description": "product season"
              },
              "color": {
                "type": "string",
                "description": "product color"
              },
              "name": {
                "type": "string",
                "description": "product name"
              },
              "brand_id": {
                "type": "string",
                "description": "product external identificator"
              },
              "unique_key": {
                "type": "string",
                "description": "Product unique key"
              },
              "schema_id": {
                "type": "string",
                "description": "product schema id"
              },
              "sizes": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "size": {
                      "type": "string",
                      "description": "size name"
                    },
                    "size_group": {
                      "type": "string",
                      "description": "size group"
                    },
                    "pricing": {
                      "type": "object",
                      "properties": {
                        "USD": {
                          "type": "object",
                          "properties": {
                            "wholesale": {
                              "type": "number",
                              "description": "wholesale price"
                            },
                            "retail": {
                              "type": "number",
                              "description": "retail price"
                            },
                            "disabled": {
                              "type": "boolean",
                              "description": "whether price is disabled"
                            }
                          },
                          "required": [
                            "wholesale"
                          ]
                        }
                      },
                      "description": "size prices in available currencies, It is important to specify prices at the size level only when there is variation in pricing for a product based on its size. If prices remain consistent across all sizes, product-level pricing will be sufficient."
                    }
                  }
                },
                "description": "product sizes"
              },
              "banners": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "order banners"
              },
              "size_groups": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "size groups"
              },
              "available_now": {
                "type": "boolean",
                "description": "whether product is available now"
              },
              "images": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "product images URLs: upload Images via API not supported at this time"
              },
              "cancelled": {
                "type": "boolean",
                "description": "whether product was cancelled"
              },
              "archived": {
                "type": "boolean",
                "description": "whether product was archived"
              },
              "active": {
                "type": "boolean",
                "description": "whether product is active,"
              },
              "description": {
                "type": "string",
                "description": "product description"
              },
              "available_from": {
                "type": "string",
                "description": "date available from"
              },
              "available_until": {
                "type": "string",
                "description": "date available until"
              },
              "order_closing": {
                "type": "string",
                "description": "date order closing"
              },
              "pricing": {
                "type": "object",
                "properties": {
                  "USD": {
                    "type": "object",
                    "properties": {
                      "wholesale": {
                        "type": "number",
                        "description": "wholesale price"
                      },
                      "retail": {
                        "type": "number",
                        "description": "retail price"
                      },
                      "disabled": {
                        "type": "boolean",
                        "description": "whether price is disabled"
                      }
                    },
                    "required": [
                      "wholesale"
                    ]
                  }
                },
                "description": "product pricing"
              },
              "seasons": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "product additional seasons"
              },
              "_id": {
                "type": "string",
                "description": "product ID"
              },
              "__size_ids": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "size ids array"
              },
              "modified_on": {
                "type": "string",
                "description": "last modified date"
              },
              "__inventory_cache": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "bucket": {
                      "type": "string",
                      "description": "bucket name,"
                    },
                    "warehouse": {
                      "type": "string",
                      "description": "warehouse ID,"
                    },
                    "sku_id": {
                      "type": "string",
                      "description": "sku ID"
                    },
                    "_id": {
                      "type": "string",
                      "description": "inventory cache id"
                    },
                    "quantity": {
                      "type": "number",
                      "description": "quantity amount"
                    }
                  }
                },
                "description": "inventory cached data (DEPRECATED, to be removed soon)"
              },
              "__inventory": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "inventory names"
              }
            },
            "required": [
              "style_number",
              "season",
              "color",
              "name",
              "sizes",
              "pricing"
            ]
          },
          "item_id": {
            "type": "string",
            "description": "Product ID (24 character hex string)"
          },
          "modified_on": {
            "type": "number",
            "description": "Last modification timestamp"
          },
          "notes": {
            "type": "string",
            "description": "Notes"
          },
          "sync_id": {
            "type": "string",
            "description": "Random `F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0` (string) - Random UUID"
          },
          "created_on": {
            "type": "number",
            "description": "Creation timestamp"
          },
          "sort": {
            "type": "number",
            "description": "Sort order"
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "entries": [
    {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "catalog_id": "5cafcc501aedea3950cf8047",
      "type": "item",
      "item": {
        "style_number": "A396",
        "season": "spring/summer",
        "color": "all black",
        "name": "test",
        "brand_id": "172ak061712-001",
        "unique_key": "A396,spring/summer,all black",
        "schema_id": "537bcbd716af5274043a0992",
        "sizes": [
          {
            "size": "OS",
            "size_group": "A1",
            "pricing": {
              "USD": {
                "wholesale": 10,
                "retail": 12.1,
                "disabled": false
              }
            }
          }
        ],
        "banners": [
          "[583f5196675ef9ac78c1628d]"
        ],
        "size_groups": [
          "[ group1, group2, group3 ]"
        ],
        "available_now": false,
        "images": [
          "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
        ],
        "cancelled": false,
        "archived": false,
        "active": true,
        "description": "awesome product",
        "available_from": "2017/08/30",
        "available_until": "2019/08/30",
        "order_closing": "2017-09-12 00:00:00.000Z",
        "pricing": {
          "USD": {
            "wholesale": 10,
            "retail": 12.1,
            "disabled": false
          }
        },
        "seasons": [
          "[spring, summer, 2018]"
        ],
        "_id": "599611906873730001745011",
        "__size_ids": [
          "[599611906873730001745011]"
        ],
        "modified_on": "2017-09-11T22:30:04.911Z",
        "__inventory_cache": [
          {
            "bucket": "2018/07/25",
            "warehouse": "537bcbd716af5274043a09be",
            "sku_id": "59958be4ffb5c600017a05cb",
            "_id": "59b70e6a01c70700012dbdb8",
            "quantity": 72
          }
        ],
        "__inventory": [
          "[default]"
        ]
      },
      "item_id": "5a28ccf5b0aaf1000101ae55",
      "modified_on": 155667077878,
      "notes": "Hello, world!",
      "sync_id": "Hello, world!",
      "created_on": 1558098782447,
      "sort": 3372
    }
  ],
  "rejectedEntries": [
    "Hello, world!"
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "description": "Added entries"
    },
    "rejectedEntries": {
      "type": "array",
      "description": "Rejected item IDs (24 character hex string)"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Validation error messages'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'You do not have permission to edit this catalog'
}

Update entry by ID
PATCH`/api/v3.1/catalog/{catalogId}/entry/{id}`

Example URI

PATCH https://nuorder.com/api/v3.1/catalog/5cafcc501aedea3950cf8047/entry/58beec5330c543013d31ef5b

URI Parameters

HideShow

id: string (required) Example: 58beec5330c543013d31ef5b
Entry ID
catalogId: string (required) Example: 5cafcc501aedea3950cf8047
Catalog ID

Request Partial Example

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header
Content-Type: application/json

Body

This is a `PATCH` endpoint, so you need only send what changed.

Response 200

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header
Content-Type: application/json

Body

{
  "id": "5cdeb35ef0c7ae0337a6779e",
  "catalog_id": "5cafcc501aedea3950cf8047",
  "type": "item",
  "item": {
    "style_number": "A396",
    "season": "spring/summer",
    "color": "all black",
    "name": "test",
    "brand_id": "172ak061712-001",
    "unique_key": "A396,spring/summer,all black",
    "schema_id": "537bcbd716af5274043a0992",
    "sizes": [
      {
        "size": "OS",
        "size_group": "A1",
        "pricing": {
          "USD": {
            "wholesale": 10,
            "retail": 12.1,
            "disabled": false
          }
        }
      }
    ],
    "banners": [
      "[583f5196675ef9ac78c1628d]"
    ],
    "size_groups": [
      "[ group1, group2, group3 ]"
    ],
    "available_now": false,
    "images": [
      "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
    ],
    "cancelled": false,
    "archived": false,
    "active": true,
    "description": "awesome product",
    "available_from": "2017/08/30",
    "available_until": "2019/08/30",
    "order_closing": "2017-09-12 00:00:00.000Z",
    "pricing": {
      "USD": {
        "wholesale": 10,
        "retail": 12.1,
        "disabled": false
      }
    },
    "seasons": [
      "[spring, summer, 2018]"
    ],
    "_id": "599611906873730001745011",
    "__size_ids": [
      "[599611906873730001745011]"
    ],
    "modified_on": "2017-09-11T22:30:04.911Z",
    "__inventory_cache": [
      {
        "bucket": "2018/07/25",
        "warehouse": "537bcbd716af5274043a09be",
        "sku_id": "59958be4ffb5c600017a05cb",
        "_id": "59b70e6a01c70700012dbdb8",
        "quantity": 72
      }
    ],
    "__inventory": [
      "[default]"
    ]
  },
  "item_id": "5a28ccf5b0aaf1000101ae55",
  "modified_on": 155667077878,
  "notes": "Hello, world!",
  "sync_id": "Hello, world!",
  "created_on": 1558098782447,
  "sort": 3372
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Entry ID (24 character hex string)"
    },
    "catalog_id": {
      "type": "string",
      "description": "Catalog ID (24 character hex string)"
    },
    "type": {
      "type": "string",
      "description": "Entry type ('item | separator | image')"
    },
    "item": {
      "type": "object",
      "properties": {
        "style_number": {
          "type": "string",
          "description": "product style number"
        },
        "season": {
          "type": "string",
          "description": "product season"
        },
        "color": {
          "type": "string",
          "description": "product color"
        },
        "name": {
          "type": "string",
          "description": "product name"
        },
        "brand_id": {
          "type": "string",
          "description": "product external identificator"
        },
        "unique_key": {
          "type": "string",
          "description": "Product unique key"
        },
        "schema_id": {
          "type": "string",
          "description": "product schema id"
        },
        "sizes": {
          "type": "array",
          "description": "product sizes"
        },
        "banners": {
          "type": "array",
          "description": "order banners"
        },
        "size_groups": {
          "type": "array",
          "description": "size groups"
        },
        "available_now": {
          "type": "boolean",
          "description": "whether product is available now"
        },
        "images": {
          "type": "array",
          "description": "product images URLs: upload Images via API not supported at this time"
        },
        "cancelled": {
          "type": "boolean",
          "description": "whether product was cancelled"
        },
        "archived": {
          "type": "boolean",
          "description": "whether product was archived"
        },
        "active": {
          "type": "boolean",
          "description": "whether product is active,"
        },
        "description": {
          "type": "string",
          "description": "product description"
        },
        "available_from": {
          "type": "string",
          "description": "date available from"
        },
        "available_until": {
          "type": "string",
          "description": "date available until"
        },
        "order_closing": {
          "type": "string",
          "description": "date order closing"
        },
        "pricing": {
          "type": "object",
          "properties": {
            "USD": {
              "type": "object",
              "properties": {
                "wholesale": {
                  "type": "number",
                  "description": "wholesale price"
                },
                "retail": {
                  "type": "number",
                  "description": "retail price"
                },
                "disabled": {
                  "type": "boolean",
                  "description": "whether price is disabled"
                }
              },
              "required": [
                "wholesale"
              ]
            }
          },
          "description": "product pricing"
        },
        "seasons": {
          "type": "array",
          "description": "product additional seasons"
        },
        "_id": {
          "type": "string",
          "description": "product ID"
        },
        "__size_ids": {
          "type": "array",
          "description": "size ids array"
        },
        "modified_on": {
          "type": "string",
          "description": "last modified date"
        },
        "__inventory_cache": {
          "type": "array",
          "description": "inventory cached data (DEPRECATED, to be removed soon)"
        },
        "__inventory": {
          "type": "array",
          "description": "inventory names"
        }
      },
      "required": [
        "style_number",
        "season",
        "color",
        "name",
        "sizes",
        "pricing"
      ]
    },
    "item_id": {
      "type": "string",
      "description": "Product ID (24 character hex string)"
    },
    "modified_on": {
      "type": "number",
      "description": "Last modification timestamp"
    },
    "notes": {
      "type": "string",
      "description": "Notes"
    },
    "sync_id": {
      "type": "string",
      "description": "Random `F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0` (string) - Random UUID"
    },
    "created_on": {
      "type": "number",
      "description": "Creation timestamp"
    },
    "sort": {
      "type": "number",
      "description": "Sort order"
    }
  }
}

Response 400

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header
Content-Type: application/json

Body

{
    message: 'Error message with what field(s) need to be corrected',
    args: {
        /* fields that need to be corrected */
    }
}

Response 403

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header
Content-Type: application/json

Body

{
    message: 'You do not have permission to edit this catalog'
}

Remove entry by ID
DELETE`/api/v3.1/catalog/{catalogId}/entry/{id}`

Example URI

DELETE https://nuorder.com/api/v3.1/catalog/5cafcc501aedea3950cf8047/entry/58beec5330c543013d31ef5b

URI Parameters

HideShow

id: string (required) Example: 58beec5330c543013d31ef5b
Entry ID
catalogId: string (required) Example: 5cafcc501aedea3950cf8047
Catalog ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    id: '58beec5330c543013d31ef5b',
    success: true
}

Delete all entries
DELETE`/api/v3.1/catalog/{catalogId}/entries`

Example URI

DELETE https://nuorder.com/api/v3.1/catalog/5cafcc501aedea3950cf8047/entries

URI Parameters

HideShow

catalogId: string (required) Example: 5cafcc501aedea3950cf8047
Catalog ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    id: '58beec5330c543013d31ef5b',
    success: true
}

Catalog Restrictions ¶

APIs for managing your Catalog restrictions.

Create restriction
POST`/api/v3.0/catalog/restrictions`

Example URI

POST https://nuorder.com/api/v3.0/catalog/restrictions

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "id": "5cdeb35ef0c7ae0337a6779e",
  "catalog_id": "5cafcc501aedea3950cf8047",
  "sync_id": "F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0",
  "field": "warehouse",
  "value": "warehouse",
  "mode": "whitelist"
}

Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the restriction entry in the database. Used for updating or removing specific restrictions."
    },
    "catalog_id": {
      "type": "string",
      "description": "Identifier of the catalog this restriction belongs to. Links the restriction to a specific catalog."
    },
    "sync_id": {
      "type": "string",
      "description": "Random UUID used for synchronization and tracking between systems. Helps identify the same restriction across different operations."
    },
    "field": {
      "enum": [
        "warehouse",
        "currency_code",
        "customer_group",
        "subteam"
      ],
      "description": "Type of restriction being applied. Possible values:"
    },
    "value": {
      "enum": [
        "warehouse",
        "currency_code",
        "customer_group",
        "subteam"
      ],
      "description": "The specific value for the restriction. The format depends on the field type:"
    },
    "mode": {
      "enum": [
        "whitelist",
        "blacklist"
      ],
      "description": "Determines how the restriction is applied:"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "id": "5cdeb35ef0c7ae0337a6779e",
  "catalog_id": "5cafcc501aedea3950cf8047",
  "sync_id": "F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0",
  "field": "warehouse",
  "value": "warehouse",
  "mode": "whitelist"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the restriction entry in the database. Used for updating or removing specific restrictions."
    },
    "catalog_id": {
      "type": "string",
      "description": "Identifier of the catalog this restriction belongs to. Links the restriction to a specific catalog."
    },
    "sync_id": {
      "type": "string",
      "description": "Random UUID used for synchronization and tracking between systems. Helps identify the same restriction across different operations."
    },
    "field": {
      "type": "string",
      "enum": [
        "warehouse",
        "currency_code",
        "customer_group",
        "subteam"
      ],
      "description": "Type of restriction being applied. Possible values:"
    },
    "value": {
      "type": "string",
      "enum": [
        "warehouse",
        "currency_code",
        "customer_group",
        "subteam"
      ],
      "description": "The specific value for the restriction. The format depends on the field type:"
    },
    "mode": {
      "type": "string",
      "enum": [
        "whitelist",
        "blacklist"
      ],
      "description": "Determines how the restriction is applied:"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Validation error messages'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'You do not have permission to edit this catalog'
}

Bulk create restrictions
POST`/api/v3.0/catalog/{id}/restrictions/bulk`

Example URI

POST https://nuorder.com/api/v3.0/catalog/5cafcc501aedea3950cf8047/restrictions/bulk

URI Parameters

HideShow

id: string (required) Example: 5cafcc501aedea3950cf8047
Catalog ID

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "restrictions": [
    {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "catalog_id": "5cafcc501aedea3950cf8047",
      "sync_id": "F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0",
      "field": "warehouse",
      "value": "warehouse",
      "mode": "whitelist"
    }
  ]
}

Schema

{
  "type": "object",
  "properties": {
    "restrictions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the restriction entry in the database. Used for updating or removing specific restrictions."
          },
          "catalog_id": {
            "type": "string",
            "description": "Identifier of the catalog this restriction belongs to. Links the restriction to a specific catalog."
          },
          "sync_id": {
            "type": "string",
            "description": "Random UUID used for synchronization and tracking between systems. Helps identify the same restriction across different operations."
          },
          "field": {
            "enum": [
              "warehouse",
              "currency_code",
              "customer_group",
              "subteam"
            ],
            "description": "Type of restriction being applied. Possible values:"
          },
          "value": {
            "enum": [
              "warehouse",
              "currency_code",
              "customer_group",
              "subteam"
            ],
            "description": "The specific value for the restriction. The format depends on the field type:"
          },
          "mode": {
            "enum": [
              "whitelist",
              "blacklist"
            ],
            "description": "Determines how the restriction is applied:"
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": "5cdeb35ef0c7ae0337a6779e",
    "catalog_id": "5cafcc501aedea3950cf8047",
    "sync_id": "F0282267-8E9C-4CC5-BB22-A1B4B6AD88C0",
    "field": "warehouse",
    "value": "warehouse",
    "mode": "whitelist"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Validation error messages'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'You do not have permission to edit this catalog'
}

Remove all restrictions
DELETE`/api/v3.0/catalog/restrictions`

Example URI

DELETE https://nuorder.com/api/v3.0/catalog/restrictions

URI Parameters

HideShow

catalogId: string (required) Example: 5cafcc501aedea3950cf8047
Catalog ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": "5cdeb35ef0c7ae0337a6779e",
    "catalog_id": "5cafcc501aedea3950cf8047",
    "field": "Hello, world!",
    "value": "Hello, world!"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Remove restriction by ID
DELETE`/api/v3.0/catalog/{catalogId}/restriction/{id}`

Example URI

DELETE https://nuorder.com/api/v3.0/catalog/5cafcc501aedea3950cf8047/restriction/58beec5330c543013d31ef5b

URI Parameters

HideShow

id: string (required) Example: 58beec5330c543013d31ef5b
Restriction ID
catalogId: string (required) Example: 5cafcc501aedea3950cf8047
Catalog ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    id: '58beec5330c543013d31ef5b',
    success: true
}

Color Swatches ¶

APIs for managing custom color swatches

List All Color Swatches
GET`/api/color-swatches`

Example URI

GET https://nuorder.com/api/color-swatches

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "_id": "W4kerqJarQtuMPEK87gPuVsX",
    "color": "red",
    "swatch_type": "file",
    "value": "dddd00"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to list products'
}

Get a Color Swatch by Color
GET`/api/color-swatches/{color}`

Example URI

GET https://nuorder.com/api/color-swatches/red

URI Parameters

HideShow

color: string (required) Example: red
Valid product color

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "W4kerqJarQtuMPEK87gPuVsX",
  "color": "red",
  "swatch_type": "file",
  "value": "dddd00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "internal swatch id"
    },
    "color": {
      "type": "string",
      "description": "existing product color"
    },
    "swatch_type": {
      "type": "string",
      "enum": [
        "file"
      ]
    },
    "value": {
      "type": "string",
      "description": "hex color value or swatch image url (`http://cdn1.nuorder.com/brand_color_swatch/11f41aac4484da0d08b8aa3bc1e3c12d.jpg`)"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Error message with what field(s) need to be corrected'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage products'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Color swatch not found'
}

Create a Color Swatch
POST`/api/color-swatches`

Example URI

POST https://nuorder.com/api/color-swatches

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
    color: 'blue',      // should be real product color
    swatch_type: 'hex', // optional, 'hex'/'file'
    value: 'dddd00'     // color or public image URL
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "W4kerqJarQtuMPEK87gPuVsX",
  "color": "red",
  "swatch_type": "file",
  "value": "dddd00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "internal swatch id"
    },
    "color": {
      "type": "string",
      "description": "existing product color"
    },
    "swatch_type": {
      "type": "string",
      "enum": [
        "file"
      ]
    },
    "value": {
      "type": "string",
      "description": "hex color value or swatch image url (`http://cdn1.nuorder.com/brand_color_swatch/11f41aac4484da0d08b8aa3bc1e3c12d.jpg`)"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Error message with what field(s) need to be corrected',
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage products'
}

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Color swatch is already exists'
}

Bulk Swatches Upload
POST`/api/color-swatches/bulk`

Example URI

POST https://nuorder.com/api/color-swatches/bulk

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

[
  {
    "_id": "W4kerqJarQtuMPEK87gPuVsX",
    "color": "red",
    "swatch_type": "file",
    "value": "dddd00"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "_id": {
        "type": "string",
        "enum": [
          "W4kerqJarQtuMPEK87gPuVsX"
        ],
        "description": "internal swatch id"
      },
      "color": {
        "type": "string",
        "enum": [
          "red"
        ],
        "description": "existing product color"
      },
      "swatch_type": {
        "type": "string",
        "enum": [
          "file"
        ]
      },
      "value": {
        "type": "string",
        "enum": [
          "dddd00"
        ],
        "description": "hex color value or swatch image url (`http://cdn1.nuorder.com/brand_color_swatch/11f41aac4484da0d08b8aa3bc1e3c12d.jpg`)"
      }
    },
    "required": [
      "_id",
      "color",
      "swatch_type",
      "value"
    ],
    "additionalProperties": false
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "_id": "W4kerqJarQtuMPEK87gPuVsX",
    "color": "red",
    "swatch_type": "file",
    "value": "dddd00"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "_id": {
        "type": "string",
        "enum": [
          "W4kerqJarQtuMPEK87gPuVsX"
        ],
        "description": "internal swatch id"
      },
      "color": {
        "type": "string",
        "enum": [
          "red"
        ],
        "description": "existing product color"
      },
      "swatch_type": {
        "type": "string",
        "enum": [
          "file"
        ]
      },
      "value": {
        "type": "string",
        "enum": [
          "dddd00"
        ],
        "description": "hex color value or swatch image url (`http://cdn1.nuorder.com/brand_color_swatch/11f41aac4484da0d08b8aa3bc1e3c12d.jpg`)"
      }
    },
    "required": [
      "_id",
      "color",
      "swatch_type",
      "value"
    ],
    "additionalProperties": false
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Error message with what field(s) need to be corrected',
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage products'
}

Update a Color Swatch
PUT`/api/color-swatches/{color}`

Example URI

PUT https://nuorder.com/api/color-swatches/red

URI Parameters

HideShow

color: string (required) Example: red
Valid product color

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
    swatch_type: 'hex', // optional, 'hex'/'file'
    value: 'dddd00'     // color or public image URL
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "W4kerqJarQtuMPEK87gPuVsX",
  "color": "red",
  "swatch_type": "file",
  "value": "dddd00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "internal swatch id"
    },
    "color": {
      "type": "string",
      "description": "existing product color"
    },
    "swatch_type": {
      "type": "string",
      "enum": [
        "file"
      ]
    },
    "value": {
      "type": "string",
      "description": "hex color value or swatch image url (`http://cdn1.nuorder.com/brand_color_swatch/11f41aac4484da0d08b8aa3bc1e3c12d.jpg`)"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Error message with what field(s) need to be corrected'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage products'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Color swatch not found'
}

Update a Color Swatch with Image from Client
PUT`/api/color-swatches/{color}/blob`

Example URI

PUT https://nuorder.com/api/color-swatches/red/blob

URI Parameters

HideShow

color: string (required) Example: red
Valid product color

Request

HideShow

Headers

Content-Type: image/jpg or image/png
Authorization: OAuth 1.0 Authorization Header

Body

Raw image data (Buffer object in nodejs)

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "W4kerqJarQtuMPEK87gPuVsX",
  "color": "red",
  "swatch_type": "file",
  "value": "dddd00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "internal swatch id"
    },
    "color": {
      "type": "string",
      "description": "existing product color"
    },
    "swatch_type": {
      "type": "string",
      "enum": [
        "file"
      ]
    },
    "value": {
      "type": "string",
      "description": "hex color value or swatch image url (`http://cdn1.nuorder.com/brand_color_swatch/11f41aac4484da0d08b8aa3bc1e3c12d.jpg`)"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Error message with what field(s) need to be corrected'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage products'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Color swatch not found'
}

Delete a Color Swatch
DELETE`/api/color-swatches/{color}`

Example URI

DELETE https://nuorder.com/api/color-swatches/color

URI Parameters

HideShow

color: string (required)
swatch color

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    success: true
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage products'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Color Swatch not found'
}

Company Collection ¶

APIs for managing your Companies.

Get Company by ID
GET`/api/company/{id}`

Example URI

GET https://nuorder.com/api/company/59af25379042bd00013b7996

URI Parameters

HideShow

id: string (required) Example: 59af25379042bd00013b7996
company id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "Beauty Poet",
  "code": "950661308",
  "reps": [
    {
      "name": "Sales Rep",
      "email": "Sales.Rep@nuorder.com",
      "ref": "537b8fb62585fcd3447e7a4d",
      "_id": "574e15f83c92227914b0185c"
    }
  ],
  "addresses": [
    {
      "display_name": "Beauty Poet- San Luis Obispo",
      "line_1": "1920 Broad Street",
      "city": "San Luis Obispo",
      "state": "CA",
      "zip": "93401",
      "shipping_code": "997816352",
      "billing_code": "997816352",
      "default_shipping": true,
      "default_billing": true,
      "type": "both",
      "country": "United States"
    }
  ],
  "allow_bulk": false,
  "surcharge": 0,
  "discount": 0,
  "customer_groups": [
    "56e9f7cb307b958202051c23",
    "premium"
  ],
  "currency_code": "USD",
  "active": true,
  "payment_terms": "Net 30",
  "credit_status": "S",
  "warehouse": "5553913f834dc25c6469e1d8",
  "legal_file": "ABCDE",
  "_id": "59af25379042bd00013b7996",
  "__sortable_name": "beauty poet",
  "schema_id": "537bcbd716af5274043a0993",
  "user_connections": [
    {
      "name": "Reece Test Buyer",
      "email": "reece.harrison+buyer@lightspeedhq.com",
      "reps": [
        {
          "name": "Sales Rep",
          "email": "Sales.Rep@nuorder.com",
          "ref": "537b8fb62585fcd3447e7a4d",
          "_id": "574e15f83c92227914b0185c"
        }
      ],
      "title": "Head Buyer",
      "phone_office": "(555) 867-5309",
      "phone_cell": "(555) 867-5309",
      "_id": "574e15f83c92227914b0185b",
      "ref": "537b901f2585fcd3447e7ba9",
      "linesheets": [],
      "last_viewed": "2017-02-01T07:13:04.083Z"
    }
  ],
  "__connected_brand_users": [
    "[537b8fb62585fcd3447e7a4d]"
  ],
  "__filter_key": [
    "[test]"
  ],
  "__search_key": [
    "[beuty,poet,950661308]"
  ],
  "created_on": "2017-09-05T22:29:11.987Z",
  "default_discount": 0,
  "default_surcharge": 0,
  "pricing_template": "Wholesale USD"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "company name"
    },
    "code": {
      "type": "string",
      "description": "company code"
    },
    "reps": {
      "type": "array",
      "description": "Sales Reps"
    },
    "addresses": {
      "type": "array",
      "description": "company addresses"
    },
    "allow_bulk": {
      "type": "boolean",
      "description": "whether company allowed to send bulk orders"
    },
    "surcharge": {
      "type": "number",
      "description": "company's surcharge"
    },
    "discount": {
      "type": "number",
      "description": "company's discount"
    },
    "customer_groups": {
      "type": "array",
      "description": "company groups"
    },
    "currency_code": {
      "type": "string",
      "description": "company currency code"
    },
    "active": {
      "type": "boolean",
      "description": "whether company is active"
    },
    "payment_terms": {
      "type": "string",
      "description": "company's payment terms"
    },
    "credit_status": {
      "type": "string",
      "description": "company's credit status"
    },
    "warehouse": {
      "type": "string",
      "description": "warehouse name or ID"
    },
    "legal_file": {
      "type": "string",
      "description": "Order Confirmation Terms file"
    },
    "_id": {
      "type": "string",
      "description": "company ID"
    },
    "__sortable_name": {
      "type": "string",
      "description": "sortable name"
    },
    "schema_id": {
      "type": "string",
      "description": "company schema ID"
    },
    "user_connections": {
      "type": "array",
      "description": "company users"
    },
    "__connected_brand_users": {
      "type": "array",
      "description": "IDs of connected brand users"
    },
    "__filter_key": {
      "type": "array",
      "description": "filter keys"
    },
    "__search_key": {
      "type": "array",
      "description": "keys that company could be found by"
    },
    "created_on": {
      "type": "string",
      "description": "date company was created"
    },
    "default_discount": {
      "type": "number",
      "description": "alias of company's discount"
    },
    "default_surcharge": {
      "type": "number",
      "description": "alias of company's surcharge"
    },
    "pricing_template": {
      "type": "string",
      "description": "pricesheet assigned to a company"
    }
  },
  "required": [
    "name",
    "currency_code"
  ]
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'company not found'
}

Get Company by code
GET`/api/company/code/{code}`

Example URI

GET https://nuorder.com/api/company/code/31301

URI Parameters

HideShow

code: string (required) Example: 31301
company id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "Beauty Poet",
  "code": "950661308",
  "reps": [
    {
      "name": "Sales Rep",
      "email": "Sales.Rep@nuorder.com",
      "ref": "537b8fb62585fcd3447e7a4d",
      "_id": "574e15f83c92227914b0185c"
    }
  ],
  "addresses": [
    {
      "display_name": "Beauty Poet- San Luis Obispo",
      "line_1": "1920 Broad Street",
      "city": "San Luis Obispo",
      "state": "CA",
      "zip": "93401",
      "shipping_code": "997816352",
      "billing_code": "997816352",
      "default_shipping": true,
      "default_billing": true,
      "type": "both",
      "country": "United States"
    }
  ],
  "allow_bulk": false,
  "surcharge": 0,
  "discount": 0,
  "customer_groups": [
    "56e9f7cb307b958202051c23",
    "premium"
  ],
  "currency_code": "USD",
  "active": true,
  "payment_terms": "Net 30",
  "credit_status": "S",
  "warehouse": "5553913f834dc25c6469e1d8",
  "legal_file": "ABCDE",
  "_id": "59af25379042bd00013b7996",
  "__sortable_name": "beauty poet",
  "schema_id": "537bcbd716af5274043a0993",
  "user_connections": [
    {
      "name": "Reece Test Buyer",
      "email": "reece.harrison+buyer@lightspeedhq.com",
      "reps": [
        {
          "name": "Sales Rep",
          "email": "Sales.Rep@nuorder.com",
          "ref": "537b8fb62585fcd3447e7a4d",
          "_id": "574e15f83c92227914b0185c"
        }
      ],
      "title": "Head Buyer",
      "phone_office": "(555) 867-5309",
      "phone_cell": "(555) 867-5309",
      "_id": "574e15f83c92227914b0185b",
      "ref": "537b901f2585fcd3447e7ba9",
      "linesheets": [],
      "last_viewed": "2017-02-01T07:13:04.083Z"
    }
  ],
  "__connected_brand_users": [
    "[537b8fb62585fcd3447e7a4d]"
  ],
  "__filter_key": [
    "[test]"
  ],
  "__search_key": [
    "[beuty,poet,950661308]"
  ],
  "created_on": "2017-09-05T22:29:11.987Z",
  "default_discount": 0,
  "default_surcharge": 0,
  "pricing_template": "Wholesale USD"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "company name"
    },
    "code": {
      "type": "string",
      "description": "company code"
    },
    "reps": {
      "type": "array",
      "description": "Sales Reps"
    },
    "addresses": {
      "type": "array",
      "description": "company addresses"
    },
    "allow_bulk": {
      "type": "boolean",
      "description": "whether company allowed to send bulk orders"
    },
    "surcharge": {
      "type": "number",
      "description": "company's surcharge"
    },
    "discount": {
      "type": "number",
      "description": "company's discount"
    },
    "customer_groups": {
      "type": "array",
      "description": "company groups"
    },
    "currency_code": {
      "type": "string",
      "description": "company currency code"
    },
    "active": {
      "type": "boolean",
      "description": "whether company is active"
    },
    "payment_terms": {
      "type": "string",
      "description": "company's payment terms"
    },
    "credit_status": {
      "type": "string",
      "description": "company's credit status"
    },
    "warehouse": {
      "type": "string",
      "description": "warehouse name or ID"
    },
    "legal_file": {
      "type": "string",
      "description": "Order Confirmation Terms file"
    },
    "_id": {
      "type": "string",
      "description": "company ID"
    },
    "__sortable_name": {
      "type": "string",
      "description": "sortable name"
    },
    "schema_id": {
      "type": "string",
      "description": "company schema ID"
    },
    "user_connections": {
      "type": "array",
      "description": "company users"
    },
    "__connected_brand_users": {
      "type": "array",
      "description": "IDs of connected brand users"
    },
    "__filter_key": {
      "type": "array",
      "description": "filter keys"
    },
    "__search_key": {
      "type": "array",
      "description": "keys that company could be found by"
    },
    "created_on": {
      "type": "string",
      "description": "date company was created"
    },
    "default_discount": {
      "type": "number",
      "description": "alias of company's discount"
    },
    "default_surcharge": {
      "type": "number",
      "description": "alias of company's surcharge"
    },
    "pricing_template": {
      "type": "string",
      "description": "pricesheet assigned to a company"
    }
  },
  "required": [
    "name",
    "currency_code"
  ]
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'company not found'
}

Get Companies IDs
GET`/api/companies/list`

Example URI

GET https://nuorder.com/api/companies/list

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
    '54caa0e7ffea91557a81ecdd',
    '54caa0e7ffea91557a81ece1',
    '54caa0e7ffea91557a81ece5'
]

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Get Companies Codes
GET`/api/companies/codes/list`

Example URI

GET https://nuorder.com/api/companies/codes/list

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
    '',
    '0819941',
    '11111',
    '111111',
    '1587479',
]

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Get Companies by created/modified filter
GET`/api/companies/{field}/{when}/{mm}/{dd}/{yyyy}`

Example URI

GET https://nuorder.com/api/companies/created/before/7/29/2017

URI Parameters

HideShow

field

string (required) Example: created

field to filter on

Choices: created modified

when

string (required) Example: before

before or after

Choices: before after

mm

number (required) Example: 7

month number 1…12

dd

number (required) Example: 29

day of month: 1…31

yyyy

number (required) Example: 2017

year

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "name": "Beauty Poet",
    "code": "950661308",
    "reps": [
      {
        "name": "Sales Rep",
        "email": "Sales.Rep@nuorder.com",
        "ref": "537b8fb62585fcd3447e7a4d",
        "_id": "574e15f83c92227914b0185c"
      }
    ],
    "addresses": [
      {
        "display_name": "Beauty Poet- San Luis Obispo",
        "line_1": "1920 Broad Street",
        "city": "San Luis Obispo",
        "state": "CA",
        "zip": "93401",
        "shipping_code": "997816352",
        "billing_code": "997816352",
        "default_shipping": true,
        "default_billing": true,
        "type": "both",
        "country": "United States"
      }
    ],
    "allow_bulk": false,
    "surcharge": 0,
    "discount": 0,
    "customer_groups": [
      "56e9f7cb307b958202051c23",
      "premium"
    ],
    "currency_code": "USD",
    "active": true,
    "payment_terms": "Net 30",
    "credit_status": "S",
    "warehouse": "5553913f834dc25c6469e1d8",
    "legal_file": "ABCDE",
    "_id": "59af25379042bd00013b7996",
    "__sortable_name": "beauty poet",
    "schema_id": "537bcbd716af5274043a0993",
    "user_connections": [
      {
        "name": "Reece Test Buyer",
        "email": "reece.harrison+buyer@lightspeedhq.com",
        "reps": [
          {
            "name": "Sales Rep",
            "email": "Sales.Rep@nuorder.com",
            "ref": "537b8fb62585fcd3447e7a4d",
            "_id": "574e15f83c92227914b0185c"
          }
        ],
        "title": "Head Buyer",
        "phone_office": "(555) 867-5309",
        "phone_cell": "(555) 867-5309",
        "_id": "574e15f83c92227914b0185b",
        "ref": "537b901f2585fcd3447e7ba9",
        "linesheets": [],
        "last_viewed": "2017-02-01T07:13:04.083Z"
      }
    ],
    "__connected_brand_users": [
      "[537b8fb62585fcd3447e7a4d]"
    ],
    "__filter_key": [
      "[test]"
    ],
    "__search_key": [
      "[beuty,poet,950661308]"
    ],
    "created_on": "2017-09-05T22:29:11.987Z",
    "default_discount": 0,
    "default_surcharge": 0,
    "pricing_template": "Wholesale USD"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid month, Invalid Year'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Get Companies IDs by Rep Email
GET`/api/companies/rep/{email}/list`

Example URI

GET https://nuorder.com/api/companies/rep/example@nuorder.com/list

URI Parameters

HideShow

email: string (required) Example: example@nuorder.com
Rep email

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    'rep': 'example@nuorder.org',
    'companies': [
        '54caa0e7ffea91557a81ecfd',
        '54caa0e7ffea91557a81ed39',
        '54caa0e8ffea91557a81ed56'
    ]
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Get Companies by Rep Email
GET`/api/companies/rep/{email}/detail`

Example URI

GET https://nuorder.com/api/companies/rep/example@nuorder.com/detail

URI Parameters

HideShow

email: string (required) Example: example@nuorder.com
Rep email

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "name": "Beauty Poet",
    "code": "950661308",
    "reps": [
      {
        "name": "Sales Rep",
        "email": "Sales.Rep@nuorder.com",
        "ref": "537b8fb62585fcd3447e7a4d",
        "_id": "574e15f83c92227914b0185c"
      }
    ],
    "addresses": [
      {
        "display_name": "Beauty Poet- San Luis Obispo",
        "line_1": "1920 Broad Street",
        "city": "San Luis Obispo",
        "state": "CA",
        "zip": "93401",
        "shipping_code": "997816352",
        "billing_code": "997816352",
        "default_shipping": true,
        "default_billing": true,
        "type": "both",
        "country": "United States"
      }
    ],
    "allow_bulk": false,
    "surcharge": 0,
    "discount": 0,
    "customer_groups": [
      "56e9f7cb307b958202051c23",
      "premium"
    ],
    "currency_code": "USD",
    "active": true,
    "payment_terms": "Net 30",
    "credit_status": "S",
    "warehouse": "5553913f834dc25c6469e1d8",
    "legal_file": "ABCDE",
    "_id": "59af25379042bd00013b7996",
    "__sortable_name": "beauty poet",
    "schema_id": "537bcbd716af5274043a0993",
    "user_connections": [
      {
        "name": "Reece Test Buyer",
        "email": "reece.harrison+buyer@lightspeedhq.com",
        "reps": [
          {
            "name": "Sales Rep",
            "email": "Sales.Rep@nuorder.com",
            "ref": "537b8fb62585fcd3447e7a4d",
            "_id": "574e15f83c92227914b0185c"
          }
        ],
        "title": "Head Buyer",
        "phone_office": "(555) 867-5309",
        "phone_cell": "(555) 867-5309",
        "_id": "574e15f83c92227914b0185b",
        "ref": "537b901f2585fcd3447e7ba9",
        "linesheets": [],
        "last_viewed": "2017-02-01T07:13:04.083Z"
      }
    ],
    "__connected_brand_users": [
      "[537b8fb62585fcd3447e7a4d]"
    ],
    "__filter_key": [
      "[test]"
    ],
    "__search_key": [
      "[beuty,poet,950661308]"
    ],
    "created_on": "2017-09-05T22:29:11.987Z",
    "default_discount": 0,
    "default_surcharge": 0,
    "pricing_template": "Wholesale USD"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Create Company
PUT`/api/company/new`

Example URI

PUT https://nuorder.com/api/company/new

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "name": "Beauty Poet",
  "code": "950661308",
  "reps": [
    {
      "email": "Sales.Rep@nuorder.com"
    }
  ],
  "addresses": [
    {
      "display_name": "Beauty Poet- San Luis Obispo",
      "line_1": "1920 Broad Street",
      "city": "San Luis Obispo",
      "state": "CA",
      "zip": "93401",
      "shipping_code": "997816352",
      "billing_code": "997816352",
      "default_shipping": true,
      "default_billing": true,
      "type": "billing",
      "country": "United States"
    }
  ],
  "allow_bulk": false,
  "surcharge": 0,
  "discount": 0,
  "customer_groups": [
    "56e9f7cb307b958202051c23",
    "premium"
  ],
  "currency_code": "USD",
  "active": true,
  "payment_terms": "Net 30",
  "credit_status": "S",
  "warehouse": "5553913f834dc25c6469e1d8",
  "legal_file": "ABCDE"
}

Schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "company name"
    },
    "code": {
      "type": "string",
      "description": "company code"
    },
    "reps": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "Sales Rep Email"
          }
        }
      },
      "description": "Sales Reps"
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "display_name": {
            "type": "string",
            "description": "address name"
          },
          "line_1": {
            "type": "string",
            "description": "line 1"
          },
          "city": {
            "type": "string",
            "description": "City"
          },
          "state": {
            "type": "string",
            "description": "State code"
          },
          "zip": {
            "type": "string",
            "description": "zip code"
          },
          "shipping_code": {
            "type": "string",
            "description": "shipping code"
          },
          "billing_code": {
            "type": "string",
            "description": "billing code"
          },
          "default_shipping": {
            "type": "boolean",
            "description": "is default shipping address"
          },
          "default_billing": {
            "type": "boolean",
            "description": "is default billing address"
          },
          "type": {
            "enum": [
              "billing",
              "shipping"
            ],
            "description": "address type: billing, shipping or both"
          },
          "country": {
            "type": "string",
            "description": "country"
          }
        },
        "required": [
          "line_1"
        ]
      },
      "description": "company addresses"
    },
    "allow_bulk": {
      "type": "boolean",
      "description": "whether company allowed to send bulk orders"
    },
    "surcharge": {
      "type": "number",
      "description": "company's surcharge"
    },
    "discount": {
      "type": "number",
      "description": "company's discount"
    },
    "customer_groups": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "company groups"
    },
    "currency_code": {
      "type": "string",
      "description": "company currency code"
    },
    "active": {
      "type": "boolean",
      "description": "whether company is active"
    },
    "payment_terms": {
      "type": "string",
      "description": "company's payment terms"
    },
    "credit_status": {
      "type": "string",
      "description": "company's credit status"
    },
    "warehouse": {
      "type": "string",
      "description": "warehouse name or ID"
    },
    "legal_file": {
      "type": "string",
      "description": "Order Confirmation Terms file. Set empty string or null to reset"
    }
  },
  "required": [
    "name",
    "currency_code"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "Beauty Poet",
  "code": "950661308",
  "reps": [
    {
      "name": "Sales Rep",
      "email": "Sales.Rep@nuorder.com",
      "ref": "537b8fb62585fcd3447e7a4d",
      "_id": "574e15f83c92227914b0185c"
    }
  ],
  "addresses": [
    {
      "display_name": "Beauty Poet- San Luis Obispo",
      "line_1": "1920 Broad Street",
      "city": "San Luis Obispo",
      "state": "CA",
      "zip": "93401",
      "shipping_code": "997816352",
      "billing_code": "997816352",
      "default_shipping": true,
      "default_billing": true,
      "type": "both",
      "country": "United States"
    }
  ],
  "allow_bulk": false,
  "surcharge": 0,
  "discount": 0,
  "customer_groups": [
    "56e9f7cb307b958202051c23",
    "premium"
  ],
  "currency_code": "USD",
  "active": true,
  "payment_terms": "Net 30",
  "credit_status": "S",
  "warehouse": "5553913f834dc25c6469e1d8",
  "legal_file": "ABCDE",
  "_id": "59af25379042bd00013b7996",
  "__sortable_name": "beauty poet",
  "schema_id": "537bcbd716af5274043a0993",
  "user_connections": [
    {
      "name": "Reece Test Buyer",
      "email": "reece.harrison+buyer@lightspeedhq.com",
      "reps": [
        {
          "name": "Sales Rep",
          "email": "Sales.Rep@nuorder.com",
          "ref": "537b8fb62585fcd3447e7a4d",
          "_id": "574e15f83c92227914b0185c"
        }
      ],
      "title": "Head Buyer",
      "phone_office": "(555) 867-5309",
      "phone_cell": "(555) 867-5309",
      "_id": "574e15f83c92227914b0185b",
      "ref": "537b901f2585fcd3447e7ba9",
      "linesheets": [],
      "last_viewed": "2017-02-01T07:13:04.083Z"
    }
  ],
  "__connected_brand_users": [
    "[537b8fb62585fcd3447e7a4d]"
  ],
  "__filter_key": [
    "[test]"
  ],
  "__search_key": [
    "[beuty,poet,950661308]"
  ],
  "created_on": "2017-09-05T22:29:11.987Z",
  "default_discount": 0,
  "default_surcharge": 0,
  "pricing_template": "Wholesale USD"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "company name"
    },
    "code": {
      "type": "string",
      "description": "company code"
    },
    "reps": {
      "type": "array",
      "description": "Sales Reps"
    },
    "addresses": {
      "type": "array",
      "description": "company addresses"
    },
    "allow_bulk": {
      "type": "boolean",
      "description": "whether company allowed to send bulk orders"
    },
    "surcharge": {
      "type": "number",
      "description": "company's surcharge"
    },
    "discount": {
      "type": "number",
      "description": "company's discount"
    },
    "customer_groups": {
      "type": "array",
      "description": "company groups"
    },
    "currency_code": {
      "type": "string",
      "description": "company currency code"
    },
    "active": {
      "type": "boolean",
      "description": "whether company is active"
    },
    "payment_terms": {
      "type": "string",
      "description": "company's payment terms"
    },
    "credit_status": {
      "type": "string",
      "description": "company's credit status"
    },
    "warehouse": {
      "type": "string",
      "description": "warehouse name or ID"
    },
    "legal_file": {
      "type": "string",
      "description": "Order Confirmation Terms file"
    },
    "_id": {
      "type": "string",
      "description": "company ID"
    },
    "__sortable_name": {
      "type": "string",
      "description": "sortable name"
    },
    "schema_id": {
      "type": "string",
      "description": "company schema ID"
    },
    "user_connections": {
      "type": "array",
      "description": "company users"
    },
    "__connected_brand_users": {
      "type": "array",
      "description": "IDs of connected brand users"
    },
    "__filter_key": {
      "type": "array",
      "description": "filter keys"
    },
    "__search_key": {
      "type": "array",
      "description": "keys that company could be found by"
    },
    "created_on": {
      "type": "string",
      "description": "date company was created"
    },
    "default_discount": {
      "type": "number",
      "description": "alias of company's discount"
    },
    "default_surcharge": {
      "type": "number",
      "description": "alias of company's surcharge"
    },
    "pricing_template": {
      "type": "string",
      "description": "pricesheet assigned to a company"
    }
  },
  "required": [
    "name",
    "currency_code"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Validation error messages'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
    code: 409,
    message: 'Another company already exists with the given company code.'
}

Create/Update Company
PUT`/api/company/new/force`

Example URI

PUT https://nuorder.com/api/company/new/force

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "name": "Beauty Poet",
  "code": "950661308",
  "reps": [
    "salesrep@nuorder.com",
    "salesrep2@nuorder.com"
  ],
  "addresses": [
    {
      "display_name": "Beauty Poet- San Luis Obispo",
      "line_1": "1920 Broad Street",
      "city": "San Luis Obispo",
      "state": "CA",
      "zip": "93401",
      "shipping_code": "997816352",
      "billing_code": "997816352",
      "default_shipping": true,
      "default_billing": true,
      "type": "billing",
      "country": "United States"
    }
  ],
  "allow_bulk": false,
  "surcharge": 0,
  "discount": 0,
  "customer_groups": [
    "56e9f7cb307b958202051c23",
    "premium"
  ],
  "currency_code": "USD",
  "active": true,
  "payment_terms": "Net 30",
  "credit_status": "S",
  "warehouse": "5553913f834dc25c6469e1d8",
  "legal_file": "ABCDE"
}

Schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "company name"
    },
    "code": {
      "type": "string",
      "description": "company code"
    },
    "reps": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Sales Reps"
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "display_name": {
            "type": "string",
            "description": "address name"
          },
          "line_1": {
            "type": "string",
            "description": "line 1"
          },
          "city": {
            "type": "string",
            "description": "City"
          },
          "state": {
            "type": "string",
            "description": "State code"
          },
          "zip": {
            "type": "string",
            "description": "zip code"
          },
          "shipping_code": {
            "type": "string",
            "description": "shipping code"
          },
          "billing_code": {
            "type": "string",
            "description": "billing code"
          },
          "default_shipping": {
            "type": "boolean",
            "description": "is default shipping address"
          },
          "default_billing": {
            "type": "boolean",
            "description": "is default billing address"
          },
          "type": {
            "enum": [
              "billing",
              "shipping"
            ],
            "description": "address type: billing, shipping or both"
          },
          "country": {
            "type": "string",
            "description": "country"
          }
        },
        "required": [
          "line_1"
        ]
      },
      "description": "company addresses"
    },
    "allow_bulk": {
      "type": "boolean",
      "description": "whether company allowed to send bulk orders"
    },
    "surcharge": {
      "type": "number",
      "description": "company's surcharge"
    },
    "discount": {
      "type": "number",
      "description": "company's discount"
    },
    "customer_groups": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "company groups"
    },
    "currency_code": {
      "type": "string",
      "description": "company currency code"
    },
    "active": {
      "type": "boolean",
      "description": "whether company is active"
    },
    "payment_terms": {
      "type": "string",
      "description": "company's payment terms"
    },
    "credit_status": {
      "type": "string",
      "description": "company's credit status"
    },
    "warehouse": {
      "type": "string",
      "description": "warehouse name or ID"
    },
    "legal_file": {
      "type": "string",
      "description": "Order Confirmation Terms file. Set empty string or null to reset"
    }
  },
  "required": [
    "name",
    "currency_code"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "Beauty Poet",
  "code": "950661308",
  "reps": [
    {
      "name": "Sales Rep",
      "email": "Sales.Rep@nuorder.com",
      "ref": "537b8fb62585fcd3447e7a4d",
      "_id": "574e15f83c92227914b0185c"
    }
  ],
  "addresses": [
    {
      "display_name": "Beauty Poet- San Luis Obispo",
      "line_1": "1920 Broad Street",
      "city": "San Luis Obispo",
      "state": "CA",
      "zip": "93401",
      "shipping_code": "997816352",
      "billing_code": "997816352",
      "default_shipping": true,
      "default_billing": true,
      "type": "both",
      "country": "United States"
    }
  ],
  "allow_bulk": false,
  "surcharge": 0,
  "discount": 0,
  "customer_groups": [
    "56e9f7cb307b958202051c23",
    "premium"
  ],
  "currency_code": "USD",
  "active": true,
  "payment_terms": "Net 30",
  "credit_status": "S",
  "warehouse": "5553913f834dc25c6469e1d8",
  "legal_file": "ABCDE",
  "_id": "59af25379042bd00013b7996",
  "__sortable_name": "beauty poet",
  "schema_id": "537bcbd716af5274043a0993",
  "user_connections": [
    {
      "name": "Reece Test Buyer",
      "email": "reece.harrison+buyer@lightspeedhq.com",
      "reps": [
        {
          "name": "Sales Rep",
          "email": "Sales.Rep@nuorder.com",
          "ref": "537b8fb62585fcd3447e7a4d",
          "_id": "574e15f83c92227914b0185c"
        }
      ],
      "title": "Head Buyer",
      "phone_office": "(555) 867-5309",
      "phone_cell": "(555) 867-5309",
      "_id": "574e15f83c92227914b0185b",
      "ref": "537b901f2585fcd3447e7ba9",
      "linesheets": [],
      "last_viewed": "2017-02-01T07:13:04.083Z"
    }
  ],
  "__connected_brand_users": [
    "[537b8fb62585fcd3447e7a4d]"
  ],
  "__filter_key": [
    "[test]"
  ],
  "__search_key": [
    "[beuty,poet,950661308]"
  ],
  "created_on": "2017-09-05T22:29:11.987Z",
  "default_discount": 0,
  "default_surcharge": 0,
  "pricing_template": "Wholesale USD"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "company name"
    },
    "code": {
      "type": "string",
      "description": "company code"
    },
    "reps": {
      "type": "array",
      "description": "Sales Reps"
    },
    "addresses": {
      "type": "array",
      "description": "company addresses"
    },
    "allow_bulk": {
      "type": "boolean",
      "description": "whether company allowed to send bulk orders"
    },
    "surcharge": {
      "type": "number",
      "description": "company's surcharge"
    },
    "discount": {
      "type": "number",
      "description": "company's discount"
    },
    "customer_groups": {
      "type": "array",
      "description": "company groups"
    },
    "currency_code": {
      "type": "string",
      "description": "company currency code"
    },
    "active": {
      "type": "boolean",
      "description": "whether company is active"
    },
    "payment_terms": {
      "type": "string",
      "description": "company's payment terms"
    },
    "credit_status": {
      "type": "string",
      "description": "company's credit status"
    },
    "warehouse": {
      "type": "string",
      "description": "warehouse name or ID"
    },
    "legal_file": {
      "type": "string",
      "description": "Order Confirmation Terms file"
    },
    "_id": {
      "type": "string",
      "description": "company ID"
    },
    "__sortable_name": {
      "type": "string",
      "description": "sortable name"
    },
    "schema_id": {
      "type": "string",
      "description": "company schema ID"
    },
    "user_connections": {
      "type": "array",
      "description": "company users"
    },
    "__connected_brand_users": {
      "type": "array",
      "description": "IDs of connected brand users"
    },
    "__filter_key": {
      "type": "array",
      "description": "filter keys"
    },
    "__search_key": {
      "type": "array",
      "description": "keys that company could be found by"
    },
    "created_on": {
      "type": "string",
      "description": "date company was created"
    },
    "default_discount": {
      "type": "number",
      "description": "alias of company's discount"
    },
    "default_surcharge": {
      "type": "number",
      "description": "alias of company's surcharge"
    },
    "pricing_template": {
      "type": "string",
      "description": "pricesheet assigned to a company"
    }
  },
  "required": [
    "name",
    "currency_code"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Validation error messages'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Update Company by ID
POST`/api/company/{id}`

Example URI

POST https://nuorder.com/api/company/59af25379042bd00013b7996

URI Parameters

HideShow

id: string (required) Example: 59af25379042bd00013b7996
company id

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "name": "Beauty Poet",
  "code": "950661308",
  "reps": [
    {
      "email": "Sales.Rep@nuorder.com"
    }
  ],
  "addresses": [
    {
      "display_name": "Beauty Poet- San Luis Obispo",
      "line_1": "1920 Broad Street",
      "city": "San Luis Obispo",
      "state": "CA",
      "zip": "93401",
      "shipping_code": "997816352",
      "billing_code": "997816352",
      "default_shipping": true,
      "default_billing": true,
      "type": "billing",
      "country": "United States"
    }
  ],
  "allow_bulk": false,
  "surcharge": 0,
  "discount": 0,
  "customer_groups": [
    "56e9f7cb307b958202051c23",
    "premium"
  ],
  "currency_code": "USD",
  "active": true,
  "payment_terms": "Net 30",
  "credit_status": "S",
  "warehouse": "5553913f834dc25c6469e1d8",
  "legal_file": "ABCDE"
}

Schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "company name"
    },
    "code": {
      "type": "string",
      "description": "company code"
    },
    "reps": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "Sales Rep Email"
          }
        }
      },
      "description": "Sales Reps"
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "display_name": {
            "type": "string",
            "description": "address name"
          },
          "line_1": {
            "type": "string",
            "description": "line 1"
          },
          "city": {
            "type": "string",
            "description": "City"
          },
          "state": {
            "type": "string",
            "description": "State code"
          },
          "zip": {
            "type": "string",
            "description": "zip code"
          },
          "shipping_code": {
            "type": "string",
            "description": "shipping code"
          },
          "billing_code": {
            "type": "string",
            "description": "billing code"
          },
          "default_shipping": {
            "type": "boolean",
            "description": "is default shipping address"
          },
          "default_billing": {
            "type": "boolean",
            "description": "is default billing address"
          },
          "type": {
            "enum": [
              "billing",
              "shipping"
            ],
            "description": "address type: billing, shipping or both"
          },
          "country": {
            "type": "string",
            "description": "country"
          }
        },
        "required": [
          "line_1"
        ]
      },
      "description": "company addresses"
    },
    "allow_bulk": {
      "type": "boolean",
      "description": "whether company allowed to send bulk orders"
    },
    "surcharge": {
      "type": "number",
      "description": "company's surcharge"
    },
    "discount": {
      "type": "number",
      "description": "company's discount"
    },
    "customer_groups": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "company groups"
    },
    "currency_code": {
      "type": "string",
      "description": "company currency code"
    },
    "active": {
      "type": "boolean",
      "description": "whether company is active"
    },
    "payment_terms": {
      "type": "string",
      "description": "company's payment terms"
    },
    "credit_status": {
      "type": "string",
      "description": "company's credit status"
    },
    "warehouse": {
      "type": "string",
      "description": "warehouse name or ID"
    },
    "legal_file": {
      "type": "string",
      "description": "Order Confirmation Terms file. Set empty string or null to reset"
    }
  },
  "required": [
    "name",
    "currency_code"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "Beauty Poet",
  "code": "950661308",
  "reps": [
    {
      "name": "Sales Rep",
      "email": "Sales.Rep@nuorder.com",
      "ref": "537b8fb62585fcd3447e7a4d",
      "_id": "574e15f83c92227914b0185c"
    }
  ],
  "addresses": [
    {
      "display_name": "Beauty Poet- San Luis Obispo",
      "line_1": "1920 Broad Street",
      "city": "San Luis Obispo",
      "state": "CA",
      "zip": "93401",
      "shipping_code": "997816352",
      "billing_code": "997816352",
      "default_shipping": true,
      "default_billing": true,
      "type": "both",
      "country": "United States"
    }
  ],
  "allow_bulk": false,
  "surcharge": 0,
  "discount": 0,
  "customer_groups": [
    "56e9f7cb307b958202051c23",
    "premium"
  ],
  "currency_code": "USD",
  "active": true,
  "payment_terms": "Net 30",
  "credit_status": "S",
  "warehouse": "5553913f834dc25c6469e1d8",
  "legal_file": "ABCDE",
  "_id": "59af25379042bd00013b7996",
  "__sortable_name": "beauty poet",
  "schema_id": "537bcbd716af5274043a0993",
  "user_connections": [
    {
      "name": "Reece Test Buyer",
      "email": "reece.harrison+buyer@lightspeedhq.com",
      "reps": [
        {
          "name": "Sales Rep",
          "email": "Sales.Rep@nuorder.com",
          "ref": "537b8fb62585fcd3447e7a4d",
          "_id": "574e15f83c92227914b0185c"
        }
      ],
      "title": "Head Buyer",
      "phone_office": "(555) 867-5309",
      "phone_cell": "(555) 867-5309",
      "_id": "574e15f83c92227914b0185b",
      "ref": "537b901f2585fcd3447e7ba9",
      "linesheets": [],
      "last_viewed": "2017-02-01T07:13:04.083Z"
    }
  ],
  "__connected_brand_users": [
    "[537b8fb62585fcd3447e7a4d]"
  ],
  "__filter_key": [
    "[test]"
  ],
  "__search_key": [
    "[beuty,poet,950661308]"
  ],
  "created_on": "2017-09-05T22:29:11.987Z",
  "default_discount": 0,
  "default_surcharge": 0,
  "pricing_template": "Wholesale USD"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "company name"
    },
    "code": {
      "type": "string",
      "description": "company code"
    },
    "reps": {
      "type": "array",
      "description": "Sales Reps"
    },
    "addresses": {
      "type": "array",
      "description": "company addresses"
    },
    "allow_bulk": {
      "type": "boolean",
      "description": "whether company allowed to send bulk orders"
    },
    "surcharge": {
      "type": "number",
      "description": "company's surcharge"
    },
    "discount": {
      "type": "number",
      "description": "company's discount"
    },
    "customer_groups": {
      "type": "array",
      "description": "company groups"
    },
    "currency_code": {
      "type": "string",
      "description": "company currency code"
    },
    "active": {
      "type": "boolean",
      "description": "whether company is active"
    },
    "payment_terms": {
      "type": "string",
      "description": "company's payment terms"
    },
    "credit_status": {
      "type": "string",
      "description": "company's credit status"
    },
    "warehouse": {
      "type": "string",
      "description": "warehouse name or ID"
    },
    "legal_file": {
      "type": "string",
      "description": "Order Confirmation Terms file"
    },
    "_id": {
      "type": "string",
      "description": "company ID"
    },
    "__sortable_name": {
      "type": "string",
      "description": "sortable name"
    },
    "schema_id": {
      "type": "string",
      "description": "company schema ID"
    },
    "user_connections": {
      "type": "array",
      "description": "company users"
    },
    "__connected_brand_users": {
      "type": "array",
      "description": "IDs of connected brand users"
    },
    "__filter_key": {
      "type": "array",
      "description": "filter keys"
    },
    "__search_key": {
      "type": "array",
      "description": "keys that company could be found by"
    },
    "created_on": {
      "type": "string",
      "description": "date company was created"
    },
    "default_discount": {
      "type": "number",
      "description": "alias of company's discount"
    },
    "default_surcharge": {
      "type": "number",
      "description": "alias of company's surcharge"
    },
    "pricing_template": {
      "type": "string",
      "description": "pricesheet assigned to a company"
    }
  },
  "required": [
    "name",
    "currency_code"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Validation error messages'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'company not found'
}

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
    code: 409,
    message: 'Another company already exists with the given company code.'
}

Update Company by company Code
POST`/api/company/code/{code}`

Example URI

POST https://nuorder.com/api/company/code/31301

URI Parameters

HideShow

code: string (required) Example: 31301
company id

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "name": "Beauty Poet",
  "code": "950661308",
  "reps": [
    {
      "email": "Sales.Rep@nuorder.com"
    }
  ],
  "addresses": [
    {
      "display_name": "Beauty Poet- San Luis Obispo",
      "line_1": "1920 Broad Street",
      "city": "San Luis Obispo",
      "state": "CA",
      "zip": "93401",
      "shipping_code": "997816352",
      "billing_code": "997816352",
      "default_shipping": true,
      "default_billing": true,
      "type": "billing",
      "country": "United States"
    }
  ],
  "allow_bulk": false,
  "surcharge": 0,
  "discount": 0,
  "customer_groups": [
    "56e9f7cb307b958202051c23",
    "premium"
  ],
  "currency_code": "USD",
  "active": true,
  "payment_terms": "Net 30",
  "credit_status": "S",
  "warehouse": "5553913f834dc25c6469e1d8",
  "legal_file": "ABCDE"
}

Schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "company name"
    },
    "code": {
      "type": "string",
      "description": "company code"
    },
    "reps": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "Sales Rep Email"
          }
        }
      },
      "description": "Sales Reps"
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "display_name": {
            "type": "string",
            "description": "address name"
          },
          "line_1": {
            "type": "string",
            "description": "line 1"
          },
          "city": {
            "type": "string",
            "description": "City"
          },
          "state": {
            "type": "string",
            "description": "State code"
          },
          "zip": {
            "type": "string",
            "description": "zip code"
          },
          "shipping_code": {
            "type": "string",
            "description": "shipping code"
          },
          "billing_code": {
            "type": "string",
            "description": "billing code"
          },
          "default_shipping": {
            "type": "boolean",
            "description": "is default shipping address"
          },
          "default_billing": {
            "type": "boolean",
            "description": "is default billing address"
          },
          "type": {
            "enum": [
              "billing",
              "shipping"
            ],
            "description": "address type: billing, shipping or both"
          },
          "country": {
            "type": "string",
            "description": "country"
          }
        },
        "required": [
          "line_1"
        ]
      },
      "description": "company addresses"
    },
    "allow_bulk": {
      "type": "boolean",
      "description": "whether company allowed to send bulk orders"
    },
    "surcharge": {
      "type": "number",
      "description": "company's surcharge"
    },
    "discount": {
      "type": "number",
      "description": "company's discount"
    },
    "customer_groups": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "company groups"
    },
    "currency_code": {
      "type": "string",
      "description": "company currency code"
    },
    "active": {
      "type": "boolean",
      "description": "whether company is active"
    },
    "payment_terms": {
      "type": "string",
      "description": "company's payment terms"
    },
    "credit_status": {
      "type": "string",
      "description": "company's credit status"
    },
    "warehouse": {
      "type": "string",
      "description": "warehouse name or ID"
    },
    "legal_file": {
      "type": "string",
      "description": "Order Confirmation Terms file. Set empty string or null to reset"
    }
  },
  "required": [
    "name",
    "currency_code"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "name": "Beauty Poet",
  "code": "950661308",
  "reps": [
    {
      "name": "Sales Rep",
      "email": "Sales.Rep@nuorder.com",
      "ref": "537b8fb62585fcd3447e7a4d",
      "_id": "574e15f83c92227914b0185c"
    }
  ],
  "addresses": [
    {
      "display_name": "Beauty Poet- San Luis Obispo",
      "line_1": "1920 Broad Street",
      "city": "San Luis Obispo",
      "state": "CA",
      "zip": "93401",
      "shipping_code": "997816352",
      "billing_code": "997816352",
      "default_shipping": true,
      "default_billing": true,
      "type": "both",
      "country": "United States"
    }
  ],
  "allow_bulk": false,
  "surcharge": 0,
  "discount": 0,
  "customer_groups": [
    "56e9f7cb307b958202051c23",
    "premium"
  ],
  "currency_code": "USD",
  "active": true,
  "payment_terms": "Net 30",
  "credit_status": "S",
  "warehouse": "5553913f834dc25c6469e1d8",
  "legal_file": "ABCDE",
  "_id": "59af25379042bd00013b7996",
  "__sortable_name": "beauty poet",
  "schema_id": "537bcbd716af5274043a0993",
  "user_connections": [
    {
      "name": "Reece Test Buyer",
      "email": "reece.harrison+buyer@lightspeedhq.com",
      "reps": [
        {
          "name": "Sales Rep",
          "email": "Sales.Rep@nuorder.com",
          "ref": "537b8fb62585fcd3447e7a4d",
          "_id": "574e15f83c92227914b0185c"
        }
      ],
      "title": "Head Buyer",
      "phone_office": "(555) 867-5309",
      "phone_cell": "(555) 867-5309",
      "_id": "574e15f83c92227914b0185b",
      "ref": "537b901f2585fcd3447e7ba9",
      "linesheets": [],
      "last_viewed": "2017-02-01T07:13:04.083Z"
    }
  ],
  "__connected_brand_users": [
    "[537b8fb62585fcd3447e7a4d]"
  ],
  "__filter_key": [
    "[test]"
  ],
  "__search_key": [
    "[beuty,poet,950661308]"
  ],
  "created_on": "2017-09-05T22:29:11.987Z",
  "default_discount": 0,
  "default_surcharge": 0,
  "pricing_template": "Wholesale USD"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "company name"
    },
    "code": {
      "type": "string",
      "description": "company code"
    },
    "reps": {
      "type": "array",
      "description": "Sales Reps"
    },
    "addresses": {
      "type": "array",
      "description": "company addresses"
    },
    "allow_bulk": {
      "type": "boolean",
      "description": "whether company allowed to send bulk orders"
    },
    "surcharge": {
      "type": "number",
      "description": "company's surcharge"
    },
    "discount": {
      "type": "number",
      "description": "company's discount"
    },
    "customer_groups": {
      "type": "array",
      "description": "company groups"
    },
    "currency_code": {
      "type": "string",
      "description": "company currency code"
    },
    "active": {
      "type": "boolean",
      "description": "whether company is active"
    },
    "payment_terms": {
      "type": "string",
      "description": "company's payment terms"
    },
    "credit_status": {
      "type": "string",
      "description": "company's credit status"
    },
    "warehouse": {
      "type": "string",
      "description": "warehouse name or ID"
    },
    "legal_file": {
      "type": "string",
      "description": "Order Confirmation Terms file"
    },
    "_id": {
      "type": "string",
      "description": "company ID"
    },
    "__sortable_name": {
      "type": "string",
      "description": "sortable name"
    },
    "schema_id": {
      "type": "string",
      "description": "company schema ID"
    },
    "user_connections": {
      "type": "array",
      "description": "company users"
    },
    "__connected_brand_users": {
      "type": "array",
      "description": "IDs of connected brand users"
    },
    "__filter_key": {
      "type": "array",
      "description": "filter keys"
    },
    "__search_key": {
      "type": "array",
      "description": "keys that company could be found by"
    },
    "created_on": {
      "type": "string",
      "description": "date company was created"
    },
    "default_discount": {
      "type": "number",
      "description": "alias of company's discount"
    },
    "default_surcharge": {
      "type": "number",
      "description": "alias of company's surcharge"
    },
    "pricing_template": {
      "type": "string",
      "description": "pricesheet assigned to a company"
    }
  },
  "required": [
    "name",
    "currency_code"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Validation error messages'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'company not found'
}

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
    code: 409,
    message: 'Another company already exists with the given company code.'
}

Archive/Unarchive Company by ID
POST`/api/company/{status}/{id}`

Example URI

POST https://nuorder.com/api/company/archive/59af25379042bd00013b7996

URI Parameters

HideShow

status

enum (required) Example: archive

new company status

Choices: archive unarchive

id

string (required) Example: 59af25379042bd00013b7996

company id

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    'success': true
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'company not found'
}

Archive/Unarchive Company by company Code
POST`/api/company/{status}/code/{code}`

Example URI

POST https://nuorder.com/api/company/archive/code/31301

URI Parameters

HideShow

status

enum (required) Example: archive

new company status

Choices: archive unarchive

code

string (required) Example: 31301

company id

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    'success': true
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'company not found'
}

Customer Groups Collection ¶

APIs for managing your Customer / User Groups.

Get List Customer Groups
GET`/api/v2.0/customer-groups`

Example URI

GET https://nuorder.com/api/v2.0/customer-groups

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "_id": "5eb4749ef8d4341f1773bae7",
    "name": "premium",
    "type": "whitelist",
    "product_filter_values": [
      {
        "field": "season",
        "values": [
          "core",
          "fall 2018"
        ]
      }
    ]
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Get Customer Group
GET`/api/v2.0/customer-groups/{groupName}`

Example URI

GET https://nuorder.com/api/v2.0/customer-groups/premium_customers

URI Parameters

HideShow

groupName: string (required) Example: premium_customers
customer group name

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "5eb4749ef8d4341f1773bae7",
  "name": "premium",
  "type": "whitelist",
  "product_filter_values": [
    {
      "field": "season",
      "values": [
        "core",
        "fall 2018"
      ]
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "customer group ID"
    },
    "name": {
      "type": "string",
      "description": "customer group name"
    },
    "type": {
      "type": "string",
      "description": "customer group type"
    },
    "product_filter_values": {
      "type": "array",
      "description": "group filters"
    }
  }
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Customer group not found'
}

Create or Edit a Customer Group
PUT`/api/v2.0/customer-groups/{groupName}`

Example URI

PUT https://nuorder.com/api/v2.0/customer-groups/premium_customers

URI Parameters

HideShow

groupName: string (required) Example: premium_customers
customer group name

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "5eb4749ef8d4341f1773bae7",
  "name": "premium",
  "type": "whitelist",
  "product_filter_values": [
    {
      "field": "season",
      "values": [
        "core",
        "fall 2018"
      ]
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "customer group ID"
    },
    "name": {
      "type": "string",
      "description": "customer group name"
    },
    "type": {
      "type": "string",
      "description": "customer group type"
    },
    "product_filter_values": {
      "type": "array",
      "description": "group filters"
    }
  }
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: "Validation error"
    errors: ["'department' is not a filterable product field"]
}

Delete Customer Group
DELETE`/api/v2.0/customer-groups/{groupName}`

Example URI

DELETE https://nuorder.com/api/v2.0/customer-groups/premium_customers

URI Parameters

HideShow

groupName: string (required) Example: premium_customers
customer group name

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    success: true
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Customer group not found'
}

Inventory Collection ¶

APIs for managing your Inventory.

Get Inventory by ID
GET`/api/inventory/{id}`

Example URI

GET https://nuorder.com/api/inventory/59f0cdde949776162469a73f

URI Parameters

HideShow

id: string (required) Example: 59f0cdde949776162469a73f
product id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "inventory": [
    {
      "warehouse": "Main",
      "prebook": false,
      "wip": [
        {
          "name": "2018/10/01",
          "sizes": [
            {
              "size": "small",
              "upc": "123456789",
              "quantity": 10
            }
          ]
        }
      ]
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "inventory": {
      "type": "array",
      "description": "inventory data"
    }
  }
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403,
    message: 'No permissions for inventory management'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'product not found'
}

Get Inventory by External ID
GET`/api/inventory/external_id/{id}`

Example URI

GET https://nuorder.com/api/inventory/external_id/5555

URI Parameters

HideShow

id: string (required) Example: 5555
external product id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "inventory": [
    {
      "warehouse": "Main",
      "prebook": false,
      "wip": [
        {
          "name": "2018/10/01",
          "sizes": [
            {
              "size": "small",
              "upc": "123456789",
              "quantity": 10
            }
          ]
        }
      ]
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "inventory": {
      "type": "array",
      "description": "inventory data"
    }
  }
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403,
    message: 'No permissions for inventory management'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'product not found'
}

Get Inventory by Grouping
GET`/api/inventory/{grouping}/{value}`

Example URI

GET https://nuorder.com/api/inventory/season/fall

URI Parameters

HideShow

grouping

enum (required) Example: season

product grouping

Choices: season department division category

value

string (required) Example: fall

product grouping value

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "group": "season",
  "value": "fall",
  "products": [
    {
      "_id": "59f0cf8e949776162469a740",
      "brand_id": "5555",
      "inventory": {
        "inventory": [
          {
            "warehouse": "Main",
            "prebook": false,
            "wip": [
              {
                "name": "2018/10/01",
                "sizes": [
                  {
                    "size": "small",
                    "upc": "123456789",
                    "quantity": 10
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "group": {
      "type": "string",
      "description": "product group"
    },
    "value": {
      "type": "string",
      "description": "product group value"
    },
    "products": {
      "type": "array",
      "description": "product inventory data"
    }
  }
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403,
    message: 'No permissions for inventory management'
}

Update Inventory by ID
POST`/api/inventory/{id}`

Example URI

POST https://nuorder.com/api/inventory/59f0cdde949776162469a73f

URI Parameters

HideShow

id: string (required) Example: 59f0cdde949776162469a73f
product id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "inventory": [
    {
      "warehouse": "Main",
      "prebook": false,
      "wip": [
        {
          "name": "2018/10/01",
          "sizes": [
            {
              "size": "small",
              "upc": "123456789",
              "quantity": 10
            }
          ]
        }
      ]
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "inventory": {
      "type": "array",
      "description": "inventory data"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "inventory": [
    {
      "warehouse": "Main",
      "prebook": false,
      "wip": [
        {
          "name": "2018/10/01",
          "sizes": [
            {
              "size": "small",
              "upc": "123456789",
              "quantity": 10
            }
          ]
        }
      ]
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "inventory": {
      "type": "array",
      "description": "inventory data"
    }
  }
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403,
    message: 'No permissions for inventory management'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'product not found'
}

Update Inventory by External ID
POST`/api/inventory/external_id/{id}`

Example URI

POST https://nuorder.com/api/inventory/external_id/5555

URI Parameters

HideShow

id: string (required) Example: 5555
product external id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "inventory": [
    {
      "warehouse": "Main",
      "prebook": false,
      "wip": [
        {
          "name": "2018/10/01",
          "sizes": [
            {
              "size": "small",
              "upc": "123456789",
              "quantity": 10
            }
          ]
        }
      ]
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "inventory": {
      "type": "array",
      "description": "inventory data"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "inventory": [
    {
      "warehouse": "Main",
      "prebook": false,
      "wip": [
        {
          "name": "2018/10/01",
          "sizes": [
            {
              "size": "small",
              "upc": "123456789",
              "quantity": 10
            }
          ]
        }
      ]
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "inventory": {
      "type": "array",
      "description": "inventory data"
    }
  }
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403,
    message: 'No permissions for inventory management'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'product not found'
}

Delete Inventory by ID
DELETE`/api/inventory/{id}`

Example URI

DELETE https://nuorder.com/api/inventory/59f0cdde949776162469a73f

URI Parameters

HideShow

id: string (required) Example: 59f0cdde949776162469a73f
product id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    success: true
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403,
    message: 'No permissions for inventory management'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'product not found'
}

Delete Inventory by External ID
DELETE`/api/inventory/external_id/{id}`

Example URI

DELETE https://nuorder.com/api/inventory/external_id/5555

URI Parameters

HideShow

id: string (required) Example: 5555
external product id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    success: true
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403,
    message: 'No permissions for inventory management'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'product not found'
}

Invoice Collection ¶

APIs for managing your Invoices.

List Invoices
POST`/api/v3.0/payment/invoices/list`

Example URI

POST https://nuorder.com/api/v3.0/payment/invoices/list

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "limit": 50,
  "sort": "due_at",
  "order": "asc",
  "filters": [
    {
      "field": "brand.name",
      "operator": "eq",
      "value": "NuOrder Brand"
    },
    {
      "logicalOperator": "$or",
      "filters": [
        {
          "logicalOperator": "$and",
          "filters": [
            {
              "field": "status_override",
              "operator": "in",
              "value": [
                "pending"
              ]
            },
            {
              "field": "due_at",
              "operator": "lte",
              "value": "2024-12-31T05:09:55.574Z"
            }
          ]
        },
        {
          "logicalOperator": "$and",
          "filters": [
            {
              "field": "amount",
              "operator": "gte",
              "value": 500
            },
            {
              "field": "currency",
              "operator": "eq",
              "value": "USD"
            }
          ]
        }
      ]
    }
  ],
  "lastSortValue": "2024-10-31T05:09:55.574Z",
  "populatePaymentGroups": true
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": "593fec4a8f113256c806ac59",
      "brand": {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "name": "John Doe",
        "email": "john.doe@example.com"
      },
      "company": {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "name": "John Doe",
        "email": "john.doe@example.com"
      },
      "buyer": {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "name": "John Doe",
        "email": "john.doe@example.com"
      },
      "created_by": {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "name": "John Doe",
        "email": "john.doe@example.com"
      },
      "invoice_number": "INV-12345",
      "currency": "USD",
      "pdfs": [
        {
          "id": "5cdeb35ef0c7ae0337a6779e",
          "generation_date": 1558098782447,
          "url": "https://example.com/invoice.pdf"
        }
      ],
      "legacy_id": "5cdeb35ef0c7ae0337a6779e",
      "external_fields": [
        {
          "number": "INV-23",
          "reference": "123456"
        }
      ],
      "payment_groups": [
        "Hello, world!"
      ],
      "order": [
        {
          "order_amount": 100,
          "payment_balance": 50,
          "payment_total": 25.35,
          "order_id": "5cdeb35ef0c7ae0337a6779e"
        }
      ],
      "status_override": "Paid",
      "status_override_by": {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "name": "John Doe",
        "email": "john.doe@example.com"
      },
      "status_override_at": 1558098782447,
      "amount_override": 900,
      "due_at": 1558098782447,
      "notes": "Some notes",
      "exported_on": 1558098782447,
      "status": "Pending",
      "latest_pdf": {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "generation_date": 1558098782447,
        "url": "https://example.com/invoice.pdf"
      }
    }
  ],
  "nextCursor": "2024-12-31T05:09:55.574Z"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "List of invoices"
    },
    "nextCursor": {
      "type": "string",
      "description": "(Optional) Value to access next batch of documents"
    }
  }
}

Find Invoice
GET`/api/v3.0/payment/invoices/find`

Example URI

GET https://nuorder.com/api/v3.0/payment/invoices/find

URI Parameters

HideShow

attribute

enum (required)

The attribute to search by

Choices: _id _id_or_legacy_id invoice_number invoice_number_ext

value

string (required)

The value of the specified attribute

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": "593fec4a8f113256c806ac59",
  "brand": {
    "id": "5cdeb35ef0c7ae0337a6779e",
    "name": "John Doe",
    "email": "john.doe@example.com"
  },
  "company": {
    "id": "5cdeb35ef0c7ae0337a6779e",
    "name": "John Doe",
    "email": "john.doe@example.com"
  },
  "buyer": {
    "id": "5cdeb35ef0c7ae0337a6779e",
    "name": "John Doe",
    "email": "john.doe@example.com"
  },
  "created_by": {
    "id": "5cdeb35ef0c7ae0337a6779e",
    "name": "John Doe",
    "email": "john.doe@example.com"
  },
  "invoice_number": "INV-12345",
  "currency": "USD",
  "pdfs": [
    {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "generation_date": 1558098782447,
      "url": "https://example.com/invoice.pdf"
    }
  ],
  "legacy_id": "5cdeb35ef0c7ae0337a6779e",
  "external_fields": [
    {
      "number": "INV-23",
      "reference": "123456"
    }
  ],
  "payment_groups": [
    "Hello, world!"
  ],
  "order": [
    {
      "order_amount": 100,
      "payment_balance": 50,
      "payment_total": 25.35,
      "order_id": "5cdeb35ef0c7ae0337a6779e"
    }
  ],
  "status_override": "Paid",
  "status_override_by": {
    "id": "5cdeb35ef0c7ae0337a6779e",
    "name": "John Doe",
    "email": "john.doe@example.com"
  },
  "status_override_at": 1558098782447,
  "amount_override": 900,
  "due_at": 1558098782447,
  "notes": "Some notes",
  "exported_on": 1558098782447,
  "status": "Pending",
  "latest_pdf": {
    "id": "5cdeb35ef0c7ae0337a6779e",
    "generation_date": 1558098782447,
    "url": "https://example.com/invoice.pdf"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Invoice ID (24 character hex string)"
    },
    "brand": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Metadata ID (24 character hex string)"
        },
        "name": {
          "type": "string",
          "description": "Name"
        },
        "email": {
          "type": "string",
          "description": "Email"
        }
      },
      "description": "Brand metadata"
    },
    "company": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Metadata ID (24 character hex string)"
        },
        "name": {
          "type": "string",
          "description": "Name"
        },
        "email": {
          "type": "string",
          "description": "Email"
        }
      },
      "description": "Company metadata"
    },
    "buyer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Metadata ID (24 character hex string)"
        },
        "name": {
          "type": "string",
          "description": "Name"
        },
        "email": {
          "type": "string",
          "description": "Email"
        }
      },
      "description": "Buyer metadata"
    },
    "created_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Metadata ID (24 character hex string)"
        },
        "name": {
          "type": "string",
          "description": "Name"
        },
        "email": {
          "type": "string",
          "description": "Email"
        }
      },
      "description": "Metadata of the creator"
    },
    "invoice_number": {
      "type": "string",
      "description": "Invoice number"
    },
    "currency": {
      "type": "string",
      "description": "Currency code"
    },
    "pdfs": {
      "type": "array",
      "description": "Array of PDFs associated with the invoice"
    },
    "legacy_id": {
      "type": "string",
      "description": "Legacy ID (24 character hex string)"
    },
    "external_fields": {
      "type": "array",
      "description": "External fields"
    },
    "payment_groups": {
      "type": "array",
      "description": "Array of payment group IDs (24 character hex string)"
    },
    "order": {
      "type": "array",
      "description": "Order details"
    },
    "status_override": {
      "type": "string",
      "description": "(Optional) Status override"
    },
    "status_override_by": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Metadata ID (24 character hex string)"
        },
        "name": {
          "type": "string",
          "description": "Name"
        },
        "email": {
          "type": "string",
          "description": "Email"
        }
      },
      "description": "Metadata of the person who overrode the status"
    },
    "status_override_at": {
      "type": "number",
      "description": "(Optional) Timestamp of status override"
    },
    "amount_override": {
      "type": "number",
      "description": "(Optional) Amount override"
    },
    "due_at": {
      "type": "number",
      "description": "Due date timestamp"
    },
    "notes": {
      "type": "string",
      "description": "(Optional) Additional notes"
    },
    "exported_on": {
      "type": "number",
      "description": "(Optional) Exported on timestamp"
    },
    "status": {
      "type": "string",
      "description": "Calculated status"
    },
    "latest_pdf": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "PDF ID (24 character hex string)"
        },
        "generation_date": {
          "type": "number",
          "description": "Generation date timestamp"
        },
        "url": {
          "type": "string",
          "description": "URL to the PDF"
        }
      },
      "description": "Latest PDF"
    }
  }
}

Send Invoice Email
POST`/api/v3.0/payment/invoices/{orderId}/sendInvoiceEmail`

Example URI

POST https://nuorder.com/api/v3.0/payment/invoices/59af25379042bd00013b7996/sendInvoiceEmail

URI Parameters

HideShow

orderId: string (required) Example: 59af25379042bd00013b7996
The ID of the order

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "requestedAmount": 50,
  "requestedDate": "2024-12-04T05:09:55.574Z",
  "notes": "Outstanding amount",
  "invoiceNumber": "INV-001",
  "pdfLink": "https://example.com/invoice.pdf",
  "ref": "99af25379042bd11113b7996"
}

Schema

{
  "type": "object",
  "properties": {
    "requestedAmount": {
      "type": "number",
      "description": "(Optional) The amount requested. If no amount is specified, defaults to the pending balance on the order."
    },
    "requestedDate": {
      "type": "string",
      "description": "(Optional) The date requested. If no date is specified, defaults to the current date."
    },
    "notes": {
      "type": "string",
      "description": "(Optional) Additional notes"
    },
    "invoiceNumber": {
      "type": "string",
      "description": "(Optional) The invoice number. If no invoice number is provided, an auto-generated number will be assigned to the invoice. Must be unique."
    },
    "pdfLink": {
      "type": "string",
      "description": "(Optional) Link to the PDF version of the invoice. If no pdfLink is provided, an invoice PDF will be generated."
    },
    "ref": {
      "type": "string",
      "description": "(Optional) Reference information. If you provide an identifier that was used for an existing invoice, that invoice will be resent to the buyer."
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "order": {
    "id": "593fec4a8f113256c806ac59",
    "ship_start": "Jan 01, 2023",
    "ship_end": "Jan 10, 2023",
    "created_on": "Dec 25, 2022",
    "has_billing_address": true,
    "has_shipping_address": true,
    "billing_address": {
      "line_1": "123 Main St",
      "line_2": "PH1000",
      "city": "New York",
      "zip": "10001",
      "code": "NY",
      "state": "New York",
      "country": "USA"
    },
    "shipping_address": {
      "line_1": "123 Main St",
      "line_2": "PH1000",
      "city": "New York",
      "zip": "10001",
      "code": "NY",
      "state": "New York",
      "country": "USA"
    },
    "total_shipping_amount": 50,
    "total_in_payment_due_email": 1050,
    "total_balance": 1000,
    "balance_paid": 500,
    "balance_pending": 500,
    "items_total": 900,
    "items_total_no_discount": 1000,
    "surcharge_amount": 90,
    "discount_amount": 100,
    "line_items": [
      {
        "id": "593fec4a8f113256c806ac59",
        "total": 100
      }
    ]
  },
  "invoice": {
    "id": "593fec4a8f113256c806ac59",
    "brand": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "company": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "buyer": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "created_by": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "invoice_number": "INV-12345",
    "currency": "USD",
    "pdfs": [
      {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "generation_date": 1558098782447,
        "url": "https://example.com/invoice.pdf"
      }
    ],
    "legacy_id": "5cdeb35ef0c7ae0337a6779e",
    "external_fields": [
      {
        "number": "INV-23",
        "reference": "123456"
      }
    ],
    "payment_groups": [
      "Hello, world!"
    ],
    "order": [
      {
        "order_amount": 100,
        "payment_balance": 50,
        "payment_total": 25.35,
        "order_id": "5cdeb35ef0c7ae0337a6779e"
      }
    ],
    "status_override": "Paid",
    "status_override_by": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "status_override_at": 1558098782447,
    "amount_override": 900,
    "due_at": 1558098782447,
    "notes": "Some notes",
    "exported_on": 1558098782447,
    "status": "Pending",
    "latest_pdf": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "generation_date": 1558098782447,
      "url": "https://example.com/invoice.pdf"
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Is submission successful"
    },
    "order": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Order ID (24 character hex string)"
        },
        "ship_start": {
          "type": "string",
          "description": "(Optional) Ship start date"
        },
        "ship_end": {
          "type": "string",
          "description": "(Optional) Ship end date"
        },
        "created_on": {
          "type": "string",
          "description": "Order creation date"
        },
        "has_billing_address": {
          "type": "boolean",
          "description": "Indicates if billing address is present"
        },
        "has_shipping_address": {
          "type": "boolean",
          "description": "Indicates if shipping address is present"
        },
        "billing_address": {
          "type": "object",
          "properties": {
            "line_1": {
              "type": "string",
              "description": "(Optional) Address line 1"
            },
            "line_2": {
              "type": "string",
              "description": "(Optional) Address line 2"
            },
            "city": {
              "type": "string",
              "description": "(Optional) City"
            },
            "zip": {
              "type": "string",
              "description": "(Optional) ZIP code"
            },
            "code": {
              "type": "string",
              "description": "(Optional) State code"
            },
            "state": {
              "type": "string",
              "description": "(Optional) State"
            },
            "country": {
              "type": "string",
              "description": "(Optional) Country"
            }
          },
          "description": "Filtered billing address"
        },
        "shipping_address": {
          "type": "object",
          "properties": {
            "line_1": {
              "type": "string",
              "description": "(Optional) Address line 1"
            },
            "line_2": {
              "type": "string",
              "description": "(Optional) Address line 2"
            },
            "city": {
              "type": "string",
              "description": "(Optional) City"
            },
            "zip": {
              "type": "string",
              "description": "(Optional) ZIP code"
            },
            "code": {
              "type": "string",
              "description": "(Optional) State code"
            },
            "state": {
              "type": "string",
              "description": "(Optional) State"
            },
            "country": {
              "type": "string",
              "description": "(Optional) Country"
            }
          },
          "description": "Filtered shipping address"
        },
        "total_shipping_amount": {
          "type": "number",
          "description": "Total shipping amount"
        },
        "total_in_payment_due_email": {
          "type": "number",
          "description": "Total amount in payment due email"
        },
        "total_balance": {
          "type": "number",
          "description": "Total balance"
        },
        "balance_paid": {
          "type": "number",
          "description": "Balance paid"
        },
        "balance_pending": {
          "type": "number",
          "description": "Balance pending"
        },
        "items_total": {
          "type": "number",
          "description": "Total items amount"
        },
        "items_total_no_discount": {
          "type": "number",
          "description": "Total items amount without discount"
        },
        "surcharge_amount": {
          "type": "number",
          "description": "Surcharge amount"
        },
        "discount_amount": {
          "type": "number",
          "description": "Discount amount"
        },
        "line_items": {
          "type": "array",
          "description": "Array of line items"
        }
      },
      "description": "Order tied to invoice"
    },
    "invoice": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Invoice ID (24 character hex string)"
        },
        "brand": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Metadata ID (24 character hex string)"
            },
            "name": {
              "type": "string",
              "description": "Name"
            },
            "email": {
              "type": "string",
              "description": "Email"
            }
          },
          "description": "Brand metadata"
        },
        "company": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Metadata ID (24 character hex string)"
            },
            "name": {
              "type": "string",
              "description": "Name"
            },
            "email": {
              "type": "string",
              "description": "Email"
            }
          },
          "description": "Company metadata"
        },
        "buyer": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Metadata ID (24 character hex string)"
            },
            "name": {
              "type": "string",
              "description": "Name"
            },
            "email": {
              "type": "string",
              "description": "Email"
            }
          },
          "description": "Buyer metadata"
        },
        "created_by": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Metadata ID (24 character hex string)"
            },
            "name": {
              "type": "string",
              "description": "Name"
            },
            "email": {
              "type": "string",
              "description": "Email"
            }
          },
          "description": "Metadata of the creator"
        },
        "invoice_number": {
          "type": "string",
          "description": "Invoice number"
        },
        "currency": {
          "type": "string",
          "description": "Currency code"
        },
        "pdfs": {
          "type": "array",
          "description": "Array of PDFs associated with the invoice"
        },
        "legacy_id": {
          "type": "string",
          "description": "Legacy ID (24 character hex string)"
        },
        "external_fields": {
          "type": "array",
          "description": "External fields"
        },
        "payment_groups": {
          "type": "array",
          "description": "Array of payment group IDs (24 character hex string)"
        },
        "order": {
          "type": "array",
          "description": "Order details"
        },
        "status_override": {
          "type": "string",
          "description": "(Optional) Status override"
        },
        "status_override_by": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Metadata ID (24 character hex string)"
            },
            "name": {
              "type": "string",
              "description": "Name"
            },
            "email": {
              "type": "string",
              "description": "Email"
            }
          },
          "description": "Metadata of the person who overrode the status"
        },
        "status_override_at": {
          "type": "number",
          "description": "(Optional) Timestamp of status override"
        },
        "amount_override": {
          "type": "number",
          "description": "(Optional) Amount override"
        },
        "due_at": {
          "type": "number",
          "description": "Due date timestamp"
        },
        "notes": {
          "type": "string",
          "description": "(Optional) Additional notes"
        },
        "exported_on": {
          "type": "number",
          "description": "(Optional) Exported on timestamp"
        },
        "status": {
          "type": "string",
          "description": "Calculated status"
        },
        "latest_pdf": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "PDF ID (24 character hex string)"
            },
            "generation_date": {
              "type": "number",
              "description": "Generation date timestamp"
            },
            "url": {
              "type": "string",
              "description": "URL to the PDF"
            }
          },
          "description": "Latest PDF"
        }
      },
      "description": "Invoice"
    }
  }
}

Resend Invoice via Email
POST`/api/v3.0/payment/invoices/resendInvoiceEmail`

Example URI

POST https://nuorder.com/api/v3.0/payment/invoices/resendInvoiceEmail

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "orderId": "59af25379042bd00013b7996",
  "invoiceId": "19af153569042bd00013b7996",
  "subject": "Outstanding balance",
  "cc": "buyer@company.com"
}

Schema

{
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "description": "The ID of the order"
    },
    "invoiceId": {
      "type": "string",
      "description": "The ID of the invoice"
    },
    "subject": {
      "type": "string",
      "description": "(Optional) Subject of the email"
    },
    "cc": {
      "type": "string",
      "description": "(Optional) CC recipients"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "order": {
    "id": "593fec4a8f113256c806ac59",
    "ship_start": "Jan 01, 2023",
    "ship_end": "Jan 10, 2023",
    "created_on": "Dec 25, 2022",
    "has_billing_address": true,
    "has_shipping_address": true,
    "billing_address": {
      "line_1": "123 Main St",
      "line_2": "PH1000",
      "city": "New York",
      "zip": "10001",
      "code": "NY",
      "state": "New York",
      "country": "USA"
    },
    "shipping_address": {
      "line_1": "123 Main St",
      "line_2": "PH1000",
      "city": "New York",
      "zip": "10001",
      "code": "NY",
      "state": "New York",
      "country": "USA"
    },
    "total_shipping_amount": 50,
    "total_in_payment_due_email": 1050,
    "total_balance": 1000,
    "balance_paid": 500,
    "balance_pending": 500,
    "items_total": 900,
    "items_total_no_discount": 1000,
    "surcharge_amount": 90,
    "discount_amount": 100,
    "line_items": [
      {
        "id": "593fec4a8f113256c806ac59",
        "total": 100
      }
    ]
  },
  "invoice": {
    "id": "593fec4a8f113256c806ac59",
    "brand": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "company": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "buyer": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "created_by": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "invoice_number": "INV-12345",
    "currency": "USD",
    "pdfs": [
      {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "generation_date": 1558098782447,
        "url": "https://example.com/invoice.pdf"
      }
    ],
    "legacy_id": "5cdeb35ef0c7ae0337a6779e",
    "external_fields": [
      {
        "number": "INV-23",
        "reference": "123456"
      }
    ],
    "payment_groups": [
      "Hello, world!"
    ],
    "order": [
      {
        "order_amount": 100,
        "payment_balance": 50,
        "payment_total": 25.35,
        "order_id": "5cdeb35ef0c7ae0337a6779e"
      }
    ],
    "status_override": "Paid",
    "status_override_by": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "status_override_at": 1558098782447,
    "amount_override": 900,
    "due_at": 1558098782447,
    "notes": "Some notes",
    "exported_on": 1558098782447,
    "status": "Pending",
    "latest_pdf": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "generation_date": 1558098782447,
      "url": "https://example.com/invoice.pdf"
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Is submission successful"
    },
    "order": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Order ID (24 character hex string)"
        },
        "ship_start": {
          "type": "string",
          "description": "(Optional) Ship start date"
        },
        "ship_end": {
          "type": "string",
          "description": "(Optional) Ship end date"
        },
        "created_on": {
          "type": "string",
          "description": "Order creation date"
        },
        "has_billing_address": {
          "type": "boolean",
          "description": "Indicates if billing address is present"
        },
        "has_shipping_address": {
          "type": "boolean",
          "description": "Indicates if shipping address is present"
        },
        "billing_address": {
          "type": "object",
          "properties": {
            "line_1": {
              "type": "string",
              "description": "(Optional) Address line 1"
            },
            "line_2": {
              "type": "string",
              "description": "(Optional) Address line 2"
            },
            "city": {
              "type": "string",
              "description": "(Optional) City"
            },
            "zip": {
              "type": "string",
              "description": "(Optional) ZIP code"
            },
            "code": {
              "type": "string",
              "description": "(Optional) State code"
            },
            "state": {
              "type": "string",
              "description": "(Optional) State"
            },
            "country": {
              "type": "string",
              "description": "(Optional) Country"
            }
          },
          "description": "Filtered billing address"
        },
        "shipping_address": {
          "type": "object",
          "properties": {
            "line_1": {
              "type": "string",
              "description": "(Optional) Address line 1"
            },
            "line_2": {
              "type": "string",
              "description": "(Optional) Address line 2"
            },
            "city": {
              "type": "string",
              "description": "(Optional) City"
            },
            "zip": {
              "type": "string",
              "description": "(Optional) ZIP code"
            },
            "code": {
              "type": "string",
              "description": "(Optional) State code"
            },
            "state": {
              "type": "string",
              "description": "(Optional) State"
            },
            "country": {
              "type": "string",
              "description": "(Optional) Country"
            }
          },
          "description": "Filtered shipping address"
        },
        "total_shipping_amount": {
          "type": "number",
          "description": "Total shipping amount"
        },
        "total_in_payment_due_email": {
          "type": "number",
          "description": "Total amount in payment due email"
        },
        "total_balance": {
          "type": "number",
          "description": "Total balance"
        },
        "balance_paid": {
          "type": "number",
          "description": "Balance paid"
        },
        "balance_pending": {
          "type": "number",
          "description": "Balance pending"
        },
        "items_total": {
          "type": "number",
          "description": "Total items amount"
        },
        "items_total_no_discount": {
          "type": "number",
          "description": "Total items amount without discount"
        },
        "surcharge_amount": {
          "type": "number",
          "description": "Surcharge amount"
        },
        "discount_amount": {
          "type": "number",
          "description": "Discount amount"
        },
        "line_items": {
          "type": "array",
          "description": "Array of line items"
        }
      },
      "description": "Order tied to invoice"
    },
    "invoice": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Invoice ID (24 character hex string)"
        },
        "brand": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Metadata ID (24 character hex string)"
            },
            "name": {
              "type": "string",
              "description": "Name"
            },
            "email": {
              "type": "string",
              "description": "Email"
            }
          },
          "description": "Brand metadata"
        },
        "company": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Metadata ID (24 character hex string)"
            },
            "name": {
              "type": "string",
              "description": "Name"
            },
            "email": {
              "type": "string",
              "description": "Email"
            }
          },
          "description": "Company metadata"
        },
        "buyer": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Metadata ID (24 character hex string)"
            },
            "name": {
              "type": "string",
              "description": "Name"
            },
            "email": {
              "type": "string",
              "description": "Email"
            }
          },
          "description": "Buyer metadata"
        },
        "created_by": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Metadata ID (24 character hex string)"
            },
            "name": {
              "type": "string",
              "description": "Name"
            },
            "email": {
              "type": "string",
              "description": "Email"
            }
          },
          "description": "Metadata of the creator"
        },
        "invoice_number": {
          "type": "string",
          "description": "Invoice number"
        },
        "currency": {
          "type": "string",
          "description": "Currency code"
        },
        "pdfs": {
          "type": "array",
          "description": "Array of PDFs associated with the invoice"
        },
        "legacy_id": {
          "type": "string",
          "description": "Legacy ID (24 character hex string)"
        },
        "external_fields": {
          "type": "array",
          "description": "External fields"
        },
        "payment_groups": {
          "type": "array",
          "description": "Array of payment group IDs (24 character hex string)"
        },
        "order": {
          "type": "array",
          "description": "Order details"
        },
        "status_override": {
          "type": "string",
          "description": "(Optional) Status override"
        },
        "status_override_by": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Metadata ID (24 character hex string)"
            },
            "name": {
              "type": "string",
              "description": "Name"
            },
            "email": {
              "type": "string",
              "description": "Email"
            }
          },
          "description": "Metadata of the person who overrode the status"
        },
        "status_override_at": {
          "type": "number",
          "description": "(Optional) Timestamp of status override"
        },
        "amount_override": {
          "type": "number",
          "description": "(Optional) Amount override"
        },
        "due_at": {
          "type": "number",
          "description": "Due date timestamp"
        },
        "notes": {
          "type": "string",
          "description": "(Optional) Additional notes"
        },
        "exported_on": {
          "type": "number",
          "description": "(Optional) Exported on timestamp"
        },
        "status": {
          "type": "string",
          "description": "Calculated status"
        },
        "latest_pdf": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "PDF ID (24 character hex string)"
            },
            "generation_date": {
              "type": "number",
              "description": "Generation date timestamp"
            },
            "url": {
              "type": "string",
              "description": "URL to the PDF"
            }
          },
          "description": "Latest PDF"
        }
      },
      "description": "Invoice"
    }
  }
}

Update Invoice Exported On Date
PUT`/api/v3.0/payment/invoices/{invoiceId}/exported-on`

Example URI

PUT https://nuorder.com/api/v3.0/payment/invoices/59af25379042bd00013b7996/exported-on

URI Parameters

HideShow

invoiceId: string (required) Example: 59af25379042bd00013b7996
The ID of the invoice

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "date": "2024-12-31T05:09:55.574Z"
}

Schema

{
  "type": "object",
  "properties": {
    "date": {
      "type": "string",
      "description": "The date that the specified invoice was exported on"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true,
  "data": {
    "id": "593fec4a8f113256c806ac59",
    "brand": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "company": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "buyer": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "created_by": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "invoice_number": "INV-12345",
    "currency": "USD",
    "pdfs": [
      {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "generation_date": 1558098782447,
        "url": "https://example.com/invoice.pdf"
      }
    ],
    "legacy_id": "5cdeb35ef0c7ae0337a6779e",
    "external_fields": [
      {
        "number": "INV-23",
        "reference": "123456"
      }
    ],
    "payment_groups": [
      "Hello, world!"
    ],
    "order": [
      {
        "order_amount": 100,
        "payment_balance": 50,
        "payment_total": 25.35,
        "order_id": "5cdeb35ef0c7ae0337a6779e"
      }
    ],
    "status_override": "Paid",
    "status_override_by": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "name": "John Doe",
      "email": "john.doe@example.com"
    },
    "status_override_at": 1558098782447,
    "amount_override": 900,
    "due_at": 1558098782447,
    "notes": "Some notes",
    "exported_on": 1558098782447,
    "status": "Pending",
    "latest_pdf": {
      "id": "5cdeb35ef0c7ae0337a6779e",
      "generation_date": 1558098782447,
      "url": "https://example.com/invoice.pdf"
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Whether update was successful"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Invoice ID (24 character hex string)"
        },
        "brand": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Metadata ID (24 character hex string)"
            },
            "name": {
              "type": "string",
              "description": "Name"
            },
            "email": {
              "type": "string",
              "description": "Email"
            }
          },
          "description": "Brand metadata"
        },
        "company": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Metadata ID (24 character hex string)"
            },
            "name": {
              "type": "string",
              "description": "Name"
            },
            "email": {
              "type": "string",
              "description": "Email"
            }
          },
          "description": "Company metadata"
        },
        "buyer": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Metadata ID (24 character hex string)"
            },
            "name": {
              "type": "string",
              "description": "Name"
            },
            "email": {
              "type": "string",
              "description": "Email"
            }
          },
          "description": "Buyer metadata"
        },
        "created_by": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Metadata ID (24 character hex string)"
            },
            "name": {
              "type": "string",
              "description": "Name"
            },
            "email": {
              "type": "string",
              "description": "Email"
            }
          },
          "description": "Metadata of the creator"
        },
        "invoice_number": {
          "type": "string",
          "description": "Invoice number"
        },
        "currency": {
          "type": "string",
          "description": "Currency code"
        },
        "pdfs": {
          "type": "array",
          "description": "Array of PDFs associated with the invoice"
        },
        "legacy_id": {
          "type": "string",
          "description": "Legacy ID (24 character hex string)"
        },
        "external_fields": {
          "type": "array",
          "description": "External fields"
        },
        "payment_groups": {
          "type": "array",
          "description": "Array of payment group IDs (24 character hex string)"
        },
        "order": {
          "type": "array",
          "description": "Order details"
        },
        "status_override": {
          "type": "string",
          "description": "(Optional) Status override"
        },
        "status_override_by": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "Metadata ID (24 character hex string)"
            },
            "name": {
              "type": "string",
              "description": "Name"
            },
            "email": {
              "type": "string",
              "description": "Email"
            }
          },
          "description": "Metadata of the person who overrode the status"
        },
        "status_override_at": {
          "type": "number",
          "description": "(Optional) Timestamp of status override"
        },
        "amount_override": {
          "type": "number",
          "description": "(Optional) Amount override"
        },
        "due_at": {
          "type": "number",
          "description": "Due date timestamp"
        },
        "notes": {
          "type": "string",
          "description": "(Optional) Additional notes"
        },
        "exported_on": {
          "type": "number",
          "description": "(Optional) Exported on timestamp"
        },
        "status": {
          "type": "string",
          "description": "Calculated status"
        },
        "latest_pdf": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "PDF ID (24 character hex string)"
            },
            "generation_date": {
              "type": "number",
              "description": "Generation date timestamp"
            },
            "url": {
              "type": "string",
              "description": "URL to the PDF"
            }
          },
          "description": "Latest PDF"
        }
      },
      "description": "Invoice with updated exported_on date"
    }
  }
}

Get Invoices Requiring Export
GET`/api/v3.0/payment/invoices/requiresExport`

Example URI

GET https://nuorder.com/api/v3.0/payment/invoices/requiresExport

URI Parameters

HideShow

lastSortValue: string (required) Example: 2024-12-31T05:09:55.574Z
(Optional) Date of last exported record

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": "593fec4a8f113256c806ac59",
      "brand": {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "name": "John Doe",
        "email": "john.doe@example.com"
      },
      "company": {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "name": "John Doe",
        "email": "john.doe@example.com"
      },
      "buyer": {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "name": "John Doe",
        "email": "john.doe@example.com"
      },
      "created_by": {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "name": "John Doe",
        "email": "john.doe@example.com"
      },
      "invoice_number": "INV-12345",
      "currency": "USD",
      "pdfs": [
        {
          "id": "5cdeb35ef0c7ae0337a6779e",
          "generation_date": 1558098782447,
          "url": "https://example.com/invoice.pdf"
        }
      ],
      "legacy_id": "5cdeb35ef0c7ae0337a6779e",
      "external_fields": [
        {
          "number": "INV-23",
          "reference": "123456"
        }
      ],
      "payment_groups": [
        "Hello, world!"
      ],
      "order": [
        {
          "order_amount": 100,
          "payment_balance": 50,
          "payment_total": 25.35,
          "order_id": "5cdeb35ef0c7ae0337a6779e"
        }
      ],
      "status_override": "Paid",
      "status_override_by": {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "name": "John Doe",
        "email": "john.doe@example.com"
      },
      "status_override_at": 1558098782447,
      "amount_override": 900,
      "due_at": 1558098782447,
      "notes": "Some notes",
      "exported_on": 1558098782447,
      "status": "Pending",
      "latest_pdf": {
        "id": "5cdeb35ef0c7ae0337a6779e",
        "generation_date": 1558098782447,
        "url": "https://example.com/invoice.pdf"
      }
    }
  ],
  "nextCursor": "2024-12-31T05:09:55.574Z"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "List of invoices"
    },
    "nextCursor": {
      "type": "string",
      "description": "(Optional) Value to access next batch of documents"
    }
  }
}

Order Collection ¶

APIs for managing your Orders.

Order edits will lock your order from being edited in NuOrder UI.

Not sending line_items will cancel your order.

Get Order by ID
GET`/api/order/{id}{?__populate}`

Example URI

GET https://nuorder.com/api/order/5565fd0f1954192642d1db48?__populate=__payments

URI Parameters

HideShow

id

string (required) Example: 5565fd0f1954192642d1db48

Order id

__populate

enum (optional) Example: __payments

Populate options. __payments will include additional data related to order payments

Choices: __payments

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "order_number": "12345",
  "external_id": "888888",
  "customer_po_number": "po_number",
  "currency_code": "USD",
  "status": "approved",
  "product": {
    "brand_id": "888RED",
    "season": "Core",
    "style_number": "888",
    "color": "Red"
  },
  "discount": 0,
  "ship_start": "2017/10/01",
  "ship_end": "2017/10/31",
  "rep_code": "555",
  "rep_email": "testrep@nuorder.com",
  "notes": "A note at the order level",
  "billing_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "shipping_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "retailer": {
    "retailer_code": "777777",
    "buyer_email": "buyer@brand.com"
  },
  "line_items": [
    {
      "id": "ksadkmg",
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "discount": 0,
      "ship_start": "2017/10/01",
      "ship_end": "2017/10/31",
      "total_applied": -2,
      "original_total": 10,
      "discounted_total": 7.5122,
      "item_price_after_discount": 8,
      "subtotal": 8,
      "adjusted_wholesale_string": "$10.00",
      "retail_string": "$15.00",
      "total_adjustment": "-1.5951",
      "company_manual_discount_on_item": 0,
      "item_manual_discount_on_item": 0,
      "applied": [
        {
          "_id": "631ef10f0367f47036f86dc2",
          "name": "OrderLevelDiscount2",
          "description": "off $1",
          "discount": -13.5,
          "currency_code": "USD",
          "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
        }
      ],
      "notes": "A note at the line level",
      "warehouse": "100",
      "sizes": [
        {
          "size": "Small",
          "upc": "123456789",
          "quantity": 10,
          "units_per_pack": 2,
          "price": 25,
          "retail": 32,
          "price_precise": "25.00000",
          "original_price": 29,
          "discounts": {
            "total_discount": 12,
            "applied": [
              {
                "_id": "631ef10f0367f47036f86dc2",
                "name": "OrderLevelDiscount2",
                "description": "off $1",
                "discount": -13.5,
                "currency_code": "USD",
                "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
              }
            ]
          },
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ],
      "prebook": false,
      "surcharges": {
        "total_surcharge": "0",
        "applied": [
          {
            "name": "Setup Fee",
            "description": "Setup Fee Description",
            "price": "0",
            "currency_code": "USD",
            "price_code": "USD"
          }
        ]
      },
      "customizations": [
        {
          "id": "626af4fc76fae63e6e6174b7",
          "attribute_id": "6259bce43bb43e84f36d28d1",
          "external_id": "some string",
          "label": "Front Panel",
          "externalId": "FP",
          "type": "printed-image",
          "value_id": "5259bce43bb43e84f36d28d1",
          "value": "4630664466382748671",
          "display_value": "https://img.nuorder.com/c9lf9rkt3j8oinraci7g/serve",
          "value_key": "0",
          "print_type": "DIGITAL",
          "target": {
            "visualizer_id": "62598b4209b24a74bf3f6620",
            "destination_id": "6259bca2cc12b83b40ea8383",
            "rotation": 0
          },
          "child_attributes": [
            {}
          ],
          "image_file_name": "'image.png'",
          "image_attributes": [
            {
              "id": "626af4fc76fae63e6e6174b7",
              "attributeId": "626af4fc76fae63e6e6174b7",
              "externalId": "626af4fc76fae63e6e6174b7",
              "name": "Stitch count",
              "value": "\"8\""
            }
          ],
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ]
    }
  ],
  "order_discounts": {
    "discounted_total": 93.5,
    "original_total": 135,
    "total_after_line_item_discount": 111.5,
    "total_applied": -41.5,
    "applied": [
      {
        "_id": "631ef10f0367f47036f86dc2",
        "name": "OrderLevelDiscount2",
        "description": "off $1",
        "discount": -13.5,
        "currency_code": "USD",
        "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
      }
    ],
    "surcharge": 0,
    "company_manual_discount": 0,
    "surcharges": {
      "total_surcharge": "0",
      "applied": [
        {
          "name": "Setup Fee",
          "description": "Setup Fee Description",
          "price": "0",
          "currency_code": "USD",
          "price_code": "USD"
        }
      ]
    }
  },
  "shipping_information": {
    "service_type": "USPS Priority Mail",
    "service_code": "uspsPriorityMail",
    "carrier_code": "12345",
    "carrier_friendly_name": "United States Postal Service",
    "price": 25,
    "final_amount": 25
  },
  "total": 100
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string",
      "description": "The Order Number,"
    },
    "external_id": {
      "type": "string",
      "description": "External Order Number (from your system),"
    },
    "customer_po_number": {
      "type": "string",
      "description": "Customer's PO Number,"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency Code,"
    },
    "status": {
      "type": "string",
      "description": "Order Status (NuORDER, read-only field),"
    },
    "product": {
      "type": "object",
      "properties": {
        "brand_id": {
          "type": "string",
          "description": "External ID of the product"
        },
        "season": {
          "type": "string",
          "description": "Product season"
        },
        "style_number": {
          "type": "string",
          "description": "Product style number"
        },
        "color": {
          "type": "string",
          "description": "Product color"
        }
      },
      "description": "Product Information"
    },
    "discount": {
      "type": "number",
      "description": "Discount % (0 - 100),"
    },
    "ship_start": {
      "type": "string",
      "description": "Order Ship Start,"
    },
    "ship_end": {
      "type": "string",
      "description": "Order Ship End,"
    },
    "rep_code": {
      "type": "string",
      "description": "Sales rep code,"
    },
    "rep_email": {
      "type": "string",
      "description": "Sales rep email,"
    },
    "notes": {
      "type": "string",
      "description": "Order note,"
    },
    "billing_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Billing address,"
    },
    "shipping_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Shipping address,"
    },
    "retailer": {
      "type": "object",
      "properties": {
        "retailer_code": {
          "type": "string",
          "description": "The customer code"
        },
        "buyer_email": {
          "type": "string",
          "description": "The buyer email (must exist in NuORDER)"
        }
      },
      "required": [
        "retailer_code",
        "buyer_email"
      ],
      "description": "Retailer information,"
    },
    "line_items": {
      "type": "array",
      "description": "Line items,"
    },
    "order_discounts": {
      "type": "object",
      "properties": {
        "discounted_total": {
          "type": "number",
          "description": "Discounted Total,"
        },
        "original_total": {
          "type": "number",
          "description": "Original Total,"
        },
        "total_after_line_item_discount": {
          "type": "number",
          "description": "Total after Line Item Discount,"
        },
        "total_applied": {
          "type": "number",
          "description": "Total Discount Applied on Order,"
        },
        "applied": {
          "type": "array",
          "description": "Applied Discount Objects,"
        },
        "surcharge": {
          "type": "number",
          "description": "Surcharge Applied on Order,"
        },
        "company_manual_discount": {
          "type": "number",
          "description": "Company Manual Discount,"
        },
        "surcharges": {
          "type": "object",
          "properties": {
            "total_surcharge": {
              "type": "string",
              "description": "Price of all surcharges of the entity (order, line item, size) combined"
            },
            "applied": {
              "type": "array",
              "description": "Individual surcharges applied to the entity (order, line item, size)"
            }
          },
          "required": [
            "total_surcharge",
            "applied"
          ],
          "description": "Surcharges, that were accounted for the order"
        }
      },
      "description": "Order Discounts,"
    },
    "shipping_information": {
      "type": "object",
      "properties": {
        "service_type": {
          "type": "string",
          "description": "type of service"
        },
        "service_code": {
          "type": "string",
          "description": "service code"
        },
        "carrier_code": {
          "type": "string",
          "description": "carrier code"
        },
        "carrier_friendly_name": {
          "type": "string",
          "description": "carrier friendly name"
        },
        "price": {
          "type": "number",
          "description": "price displayed in the ui"
        },
        "final_amount": {
          "type": "number",
          "description": "price of shipping used for recalculation"
        }
      },
      "description": "Shipping Information,"
    },
    "total": {
      "type": "number",
      "description": "Order total,"
    }
  },
  "required": [
    "order_number",
    "currency_code",
    "ship_start",
    "ship_end",
    "line_items"
  ]
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    'code': 404,
    'message': 'order not found'
}

Get Order by Number
GET`/api/order/number/{number}{?__populate}`

Example URI

GET https://nuorder.com/api/order/number/19985624?__populate=__payments

URI Parameters

HideShow

number

string (required) Example: 19985624

Order id

__populate

enum (optional) Example: __payments

Populate options. __payments will include additional data related to order payments

Choices: __payments

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "order_number": "12345",
  "external_id": "888888",
  "customer_po_number": "po_number",
  "currency_code": "USD",
  "status": "approved",
  "discount": 0,
  "ship_start": "2017/10/01",
  "ship_end": "2017/10/31",
  "rep_code": "555",
  "rep_email": "testrep@nuorder.com",
  "notes": "A note at the order level",
  "use_advanced_promotions": true,
  "billing_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "shipping_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "retailer": {
    "retailer_code": "777777",
    "buyer_email": "buyer@brand.com"
  },
  "line_items": [
    {
      "id": "ksadkmg",
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "discount": 0,
      "ship_start": "2017/10/01",
      "ship_end": "2017/10/31",
      "total_applied": -2,
      "original_total": 10,
      "discounted_total": 7.5122,
      "item_price_after_discount": 8,
      "subtotal": 8,
      "adjusted_wholesale_string": "$10.00",
      "retail_string": "$15.00",
      "total_adjustment": "-1.5951",
      "company_manual_discount_on_item": 0,
      "item_manual_discount_on_item": 0,
      "applied": [
        {
          "_id": "631ef10f0367f47036f86dc2",
          "name": "OrderLevelDiscount2",
          "description": "off $1",
          "discount": -13.5,
          "currency_code": "USD",
          "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
        }
      ],
      "notes": "A note at the line level",
      "warehouse": "100",
      "sizes": [
        {
          "size": "Small",
          "upc": "123456789",
          "quantity": 10,
          "units_per_pack": 2,
          "price": 25,
          "retail": 32,
          "price_precise": "25.00000",
          "original_price": 29,
          "discounts": {
            "total_discount": 12,
            "applied": [
              {
                "_id": "631ef10f0367f47036f86dc2",
                "name": "OrderLevelDiscount2",
                "description": "off $1",
                "discount": -13.5,
                "currency_code": "USD",
                "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
              }
            ]
          },
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ],
      "prebook": false,
      "surcharges": {
        "total_surcharge": "0",
        "applied": [
          {
            "name": "Setup Fee",
            "description": "Setup Fee Description",
            "price": "0",
            "currency_code": "USD",
            "price_code": "USD"
          }
        ]
      },
      "customizations": [
        {
          "id": "626af4fc76fae63e6e6174b7",
          "attribute_id": "6259bce43bb43e84f36d28d1",
          "external_id": "some string",
          "label": "Front Panel",
          "externalId": "FP",
          "type": "printed-image",
          "value_id": "5259bce43bb43e84f36d28d1",
          "value": "4630664466382748671",
          "display_value": "https://img.nuorder.com/c9lf9rkt3j8oinraci7g/serve",
          "value_key": "0",
          "print_type": "DIGITAL",
          "target": {
            "visualizer_id": "62598b4209b24a74bf3f6620",
            "destination_id": "6259bca2cc12b83b40ea8383",
            "rotation": 0
          },
          "child_attributes": [
            {}
          ],
          "image_file_name": "'image.png'",
          "image_attributes": [
            {
              "id": "626af4fc76fae63e6e6174b7",
              "attributeId": "626af4fc76fae63e6e6174b7",
              "externalId": "626af4fc76fae63e6e6174b7",
              "name": "Stitch count",
              "value": "\"8\""
            }
          ],
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ]
    }
  ],
  "order_discounts": {
    "discounted_total": 93.5,
    "original_total": 135,
    "total_after_line_item_discount": 111.5,
    "total_applied": -41.5,
    "applied": [
      {
        "_id": "631ef10f0367f47036f86dc2",
        "name": "OrderLevelDiscount2",
        "description": "off $1",
        "discount": -13.5,
        "currency_code": "USD",
        "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
      }
    ],
    "surcharge": 0,
    "company_manual_discount": 0,
    "surcharges": {
      "total_surcharge": "0",
      "applied": [
        {
          "name": "Setup Fee",
          "description": "Setup Fee Description",
          "price": "0",
          "currency_code": "USD",
          "price_code": "USD"
        }
      ]
    }
  },
  "shipping_information": {
    "service_type": "USPS Priority Mail",
    "service_code": "uspsPriorityMail",
    "carrier_code": "12345",
    "carrier_friendly_name": "United States Postal Service",
    "price": 25,
    "final_amount": 25
  },
  "total": 100,
  "shipments": [
    {
      "line_items": [
        {
          "brand_id": "888RED",
          "season": "Core",
          "style_number": "888",
          "color": "Red",
          "sizes": "array[OrderShipmentLineSize]"
        }
      ],
      "type": "fedex",
      "tracking_numbers": [
        "[ '1Z0000000001' ]"
      ],
      "status": "packing",
      "shipment_date": "2017-09-12 00:00:00.000Z"
    }
  ],
  "__metadata": {
    "payments": {
      "credit_card_on_file": "5aabd0fafa217edddeaab15b",
      "payment_status": "Not Paid",
      "payment_methods_allowed": [
        "['credit-card']"
      ]
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string",
      "description": "The Order Number,"
    },
    "external_id": {
      "type": "string",
      "description": "External Order Number (from your system),"
    },
    "customer_po_number": {
      "type": "string",
      "description": "Customer's PO Number,"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency Code,"
    },
    "status": {
      "type": "string",
      "description": "Order Status (NuORDER, read-only field),"
    },
    "discount": {
      "type": "number",
      "description": "Discount % (0 - 100),"
    },
    "ship_start": {
      "type": "string",
      "description": "Order Ship Start,"
    },
    "ship_end": {
      "type": "string",
      "description": "Order Ship End,"
    },
    "rep_code": {
      "type": "string",
      "description": "Sales rep code,"
    },
    "rep_email": {
      "type": "string",
      "description": "Sales rep email,"
    },
    "notes": {
      "type": "string",
      "description": "Order note,"
    },
    "use_advanced_promotions": {
      "type": "boolean",
      "description": "Prices are taken from API and promotions are calculated by the NuORDER platform,"
    },
    "billing_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Billing address,"
    },
    "shipping_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Shipping address,"
    },
    "retailer": {
      "type": "object",
      "properties": {
        "retailer_code": {
          "type": "string",
          "description": "The customer code"
        },
        "buyer_email": {
          "type": "string",
          "description": "The buyer email (must exist in NuORDER)"
        }
      },
      "required": [
        "retailer_code",
        "buyer_email"
      ],
      "description": "Retailer information,"
    },
    "line_items": {
      "type": "array",
      "description": "Line items,"
    },
    "order_discounts": {
      "type": "object",
      "properties": {
        "discounted_total": {
          "type": "number",
          "description": "Discounted Total,"
        },
        "original_total": {
          "type": "number",
          "description": "Original Total,"
        },
        "total_after_line_item_discount": {
          "type": "number",
          "description": "Total after Line Item Discount,"
        },
        "total_applied": {
          "type": "number",
          "description": "Total Discount Applied on Order,"
        },
        "applied": {
          "type": "array",
          "description": "Applied Discount Objects,"
        },
        "surcharge": {
          "type": "number",
          "description": "Surcharge Applied on Order,"
        },
        "company_manual_discount": {
          "type": "number",
          "description": "Company Manual Discount,"
        },
        "surcharges": {
          "type": "object",
          "properties": {
            "total_surcharge": {
              "type": "string",
              "description": "Price of all surcharges of the entity (order, line item, size) combined"
            },
            "applied": {
              "type": "array",
              "description": "Individual surcharges applied to the entity (order, line item, size)"
            }
          },
          "required": [
            "total_surcharge",
            "applied"
          ],
          "description": "Surcharges, that were accounted for the order"
        }
      },
      "description": "Order Discounts,"
    },
    "shipping_information": {
      "type": "object",
      "properties": {
        "service_type": {
          "type": "string",
          "description": "type of service"
        },
        "service_code": {
          "type": "string",
          "description": "service code"
        },
        "carrier_code": {
          "type": "string",
          "description": "carrier code"
        },
        "carrier_friendly_name": {
          "type": "string",
          "description": "carrier friendly name"
        },
        "price": {
          "type": "number",
          "description": "price displayed in the ui"
        },
        "final_amount": {
          "type": "number",
          "description": "price of shipping used for recalculation"
        }
      },
      "description": "Shipping Information,"
    },
    "total": {
      "type": "number",
      "description": "Order total,"
    },
    "shipments": {
      "type": "array",
      "description": "NuORDER shipments (read-only)"
    },
    "__metadata": {
      "type": "object",
      "properties": {
        "payments": {
          "type": "object",
          "properties": {
            "credit_card_on_file": {
              "type": "string",
              "description": "credit card ID"
            },
            "payment_status": {
              "type": "string",
              "description": "Order Payment Status"
            },
            "payment_methods_allowed": {
              "type": "array",
              "description": "Array containing all allowed payment methods for the order\n\nCases and array values:\n    1. Order cannot use payments: \"payment_methods_allowed\":[]\n    2. order can only use credit cards: \"payment_methods_allowed\":[“credit-card”]\n    3. order is optional to pay by credit card: \"payment_methods_allowed\":[“credit-card”]\n    4. order is on a brand not using payments of any kind: \"payment_methods_allowed\":[]"
            }
          },
          "description": "Payment data for the order"
        }
      },
      "description": "Metadata for the order, available based on the request (read-only)"
    }
  },
  "required": [
    "order_number",
    "external_id",
    "currency_code",
    "ship_start",
    "ship_end",
    "line_items"
  ]
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    'code': 404,
    'message': 'order not found'
}

Get Orders By Status
GET`/api/orders/{status}/detail{?__populate}`

Example URI

GET https://nuorder.com/api/orders/approved/detail?__populate=__payments

URI Parameters

HideShow

status

enum (required) Example: approved

Order Status

Choices: draft review pending approved processed shipped cancelled

__populate

enum (optional) Example: __payments

Populate options. __payments will include additional data related to order payments

Choices: __payments

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "order_number": "12345",
    "external_id": "888888",
    "customer_po_number": "po_number",
    "currency_code": "USD",
    "status": "approved",
    "discount": 0,
    "ship_start": "2017/10/01",
    "ship_end": "2017/10/31",
    "rep_code": "555",
    "rep_email": "testrep@nuorder.com",
    "notes": "A note at the order level",
    "use_advanced_promotions": true,
    "billing_address": {
      "code": "123",
      "line_1": "444 Testing Lane",
      "line_2": "Suite C",
      "city": "Atlanta",
      "state": "GA",
      "zip": "30345",
      "country": "US"
    },
    "shipping_address": {
      "code": "123",
      "line_1": "444 Testing Lane",
      "line_2": "Suite C",
      "city": "Atlanta",
      "state": "GA",
      "zip": "30345",
      "country": "US"
    },
    "retailer": {
      "retailer_code": "777777",
      "buyer_email": "buyer@brand.com"
    },
    "line_items": [
      {
        "id": "ksadkmg",
        "brand_id": "888RED",
        "season": "Core",
        "style_number": "888",
        "color": "Red",
        "discount": 0,
        "ship_start": "2017/10/01",
        "ship_end": "2017/10/31",
        "total_applied": -2,
        "original_total": 10,
        "discounted_total": 7.5122,
        "item_price_after_discount": 8,
        "subtotal": 8,
        "adjusted_wholesale_string": "$10.00",
        "retail_string": "$15.00",
        "total_adjustment": "-1.5951",
        "company_manual_discount_on_item": 0,
        "item_manual_discount_on_item": 0,
        "applied": [
          {
            "_id": "631ef10f0367f47036f86dc2",
            "name": "OrderLevelDiscount2",
            "description": "off $1",
            "discount": -13.5,
            "currency_code": "USD",
            "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
          }
        ],
        "notes": "A note at the line level",
        "warehouse": "100",
        "sizes": [
          {
            "size": "Small",
            "upc": "123456789",
            "quantity": 10,
            "units_per_pack": 2,
            "price": 25,
            "retail": 32,
            "price_precise": "25.00000",
            "original_price": 29,
            "discounts": {
              "total_discount": 12,
              "applied": [
                {
                  "_id": "631ef10f0367f47036f86dc2",
                  "name": "OrderLevelDiscount2",
                  "description": "off $1",
                  "discount": -13.5,
                  "currency_code": "USD",
                  "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
                }
              ]
            },
            "surcharges": {
              "total_surcharge": "0",
              "applied": [
                {
                  "name": "Setup Fee",
                  "description": "Setup Fee Description",
                  "price": "0",
                  "currency_code": "USD",
                  "price_code": "USD"
                }
              ]
            }
          }
        ],
        "prebook": false,
        "surcharges": {
          "total_surcharge": "0",
          "applied": [
            {
              "name": "Setup Fee",
              "description": "Setup Fee Description",
              "price": "0",
              "currency_code": "USD",
              "price_code": "USD"
            }
          ]
        },
        "customizations": [
          {
            "id": "626af4fc76fae63e6e6174b7",
            "attribute_id": "6259bce43bb43e84f36d28d1",
            "external_id": "some string",
            "label": "Front Panel",
            "externalId": "FP",
            "type": "printed-image",
            "value_id": "5259bce43bb43e84f36d28d1",
            "value": "4630664466382748671",
            "display_value": "https://img.nuorder.com/c9lf9rkt3j8oinraci7g/serve",
            "value_key": "0",
            "print_type": "DIGITAL",
            "target": {
              "visualizer_id": "62598b4209b24a74bf3f6620",
              "destination_id": "6259bca2cc12b83b40ea8383",
              "rotation": 0
            },
            "child_attributes": [
              {}
            ],
            "image_file_name": "'image.png'",
            "image_attributes": [
              {
                "id": "626af4fc76fae63e6e6174b7",
                "attributeId": "626af4fc76fae63e6e6174b7",
                "externalId": "626af4fc76fae63e6e6174b7",
                "name": "Stitch count",
                "value": "\"8\""
              }
            ],
            "surcharges": {
              "total_surcharge": "0",
              "applied": [
                {
                  "name": "Setup Fee",
                  "description": "Setup Fee Description",
                  "price": "0",
                  "currency_code": "USD",
                  "price_code": "USD"
                }
              ]
            }
          }
        ]
      }
    ],
    "order_discounts": {
      "discounted_total": 93.5,
      "original_total": 135,
      "total_after_line_item_discount": 111.5,
      "total_applied": -41.5,
      "applied": [
        {
          "_id": "631ef10f0367f47036f86dc2",
          "name": "OrderLevelDiscount2",
          "description": "off $1",
          "discount": -13.5,
          "currency_code": "USD",
          "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
        }
      ],
      "surcharge": 0,
      "company_manual_discount": 0,
      "surcharges": {
        "total_surcharge": "0",
        "applied": [
          {
            "name": "Setup Fee",
            "description": "Setup Fee Description",
            "price": "0",
            "currency_code": "USD",
            "price_code": "USD"
          }
        ]
      }
    },
    "shipping_information": {
      "service_type": "USPS Priority Mail",
      "service_code": "uspsPriorityMail",
      "carrier_code": "12345",
      "carrier_friendly_name": "United States Postal Service",
      "price": 25,
      "final_amount": 25
    },
    "total": 100,
    "shipments": [
      {
        "line_items": [
          {
            "brand_id": "888RED",
            "season": "Core",
            "style_number": "888",
            "color": "Red",
            "sizes": "array[OrderShipmentLineSize]"
          }
        ],
        "type": "fedex",
        "tracking_numbers": [
          "[ '1Z0000000001' ]"
        ],
        "status": "packing"
      }
    ],
    "__metadata": {
      "payments": {
        "credit_card_on_file": "5aabd0fafa217edddeaab15b",
        "payment_status": "Not Paid",
        "payment_methods_allowed": [
          "['credit-card']"
        ]
      }
    }
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

List Orders By Status
GET`/api/orders/{status}/list`

Example URI

GET https://nuorder.com/api/orders/approved/list

URI Parameters

HideShow

status

enum (required) Example: approved

Order Status

Choices: draft review pending approved processed shipped cancelled

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  "5a782a638f03db00276f7754",
  "5a7842207bd24c0013bfffbc",
  "5a70c8de3a22b00001218fd1",
  "5a7842207bd24c0013bfffba"
]

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

List Orders By Modified Date
GET`/api/orders/list{?start_date}`

The API response includes a list of all Order ID’s of Orders that have been modified in the specified time in the GET request. Start and End date and time are expected as UTC datetime.

Example URI

GET https://nuorder.com/api/orders/list?start_date=2022-05-27

URI Parameters

HideShow

start_date: string (required) Example: 2022-05-27
Start date of the search request for modified orders
end_date: string (required) Example: 2022-07-15
End date of the search request for modified orders
start_time: string (optional) Example: 11:39:43
Start time of the search request for modified orders If time is not specified then the default time used should be Midnight or 00:00:00 of the start date
end_time: string (optional) Example: 18:33:43
End time of the search request for modified orders If time is not specified then the default time used should be Midnight or 23:59:59 of the specified end date

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  "5a782a638f03db00276f7754",
  "5a7842207bd24c0013bfffbc",
  "5a70c8de3a22b00001218fd1",
  "5a7842207bd24c0013bfffba"
]

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error: Bad params. startDate and endDate are required. Format YYYY-MM-DD. startTime and endTime are optional. Format: HH:MM:SS'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Create
PUT`/api/order/new`

Example URI

PUT https://nuorder.com/api/order/new

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "order_number": "12345",
  "external_id": "888888",
  "customer_po_number": "po_number",
  "currency_code": "USD",
  "status": "approved",
  "discount": 0,
  "ship_start": "2017/10/01",
  "ship_end": "2017/10/31",
  "rep_code": "555",
  "rep_email": "testrep@nuorder.com",
  "notes": "A note at the order level",
  "use_advanced_promotions": true,
  "billing_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "shipping_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "retailer": {
    "retailer_code": "777777",
    "buyer_email": "buyer@brand.com"
  },
  "line_items": [
    {
      "id": "ksadkmg",
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "discount": 0,
      "ship_start": "2017/10/01",
      "ship_end": "2017/10/31",
      "total_applied": -2,
      "original_total": 10,
      "discounted_total": 7.5122,
      "item_price_after_discount": 8,
      "subtotal": 8,
      "adjusted_wholesale_string": "$10.00",
      "retail_string": "$15.00",
      "total_adjustment": "-1.5951",
      "company_manual_discount_on_item": 0,
      "item_manual_discount_on_item": 0,
      "applied": [
        {
          "_id": "631ef10f0367f47036f86dc2",
          "name": "OrderLevelDiscount2",
          "description": "off $1",
          "discount": -13.5,
          "currency_code": "USD",
          "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
        }
      ],
      "notes": "A note at the line level",
      "warehouse": "100",
      "sizes": [
        {
          "size": "Small",
          "upc": "123456789",
          "quantity": 10,
          "units_per_pack": 2,
          "price": 25,
          "retail": 32,
          "price_precise": "25.00000",
          "original_price": 29,
          "discounts": {
            "total_discount": 12,
            "applied": [
              {
                "_id": "631ef10f0367f47036f86dc2",
                "name": "OrderLevelDiscount2",
                "description": "off $1",
                "discount": -13.5,
                "currency_code": "USD",
                "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
              }
            ]
          },
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ],
      "prebook": false,
      "surcharges": {
        "total_surcharge": "0",
        "applied": [
          {
            "name": "Setup Fee",
            "description": "Setup Fee Description",
            "price": "0",
            "currency_code": "USD",
            "price_code": "USD"
          }
        ]
      },
      "customizations": [
        {
          "id": "626af4fc76fae63e6e6174b7",
          "attribute_id": "6259bce43bb43e84f36d28d1",
          "external_id": "some string",
          "label": "Front Panel",
          "externalId": "FP",
          "type": "printed-image",
          "value_id": "5259bce43bb43e84f36d28d1",
          "value": "4630664466382748671",
          "display_value": "https://img.nuorder.com/c9lf9rkt3j8oinraci7g/serve",
          "value_key": "0",
          "print_type": "DIGITAL",
          "target": {
            "visualizer_id": "62598b4209b24a74bf3f6620",
            "destination_id": "6259bca2cc12b83b40ea8383",
            "rotation": 0
          },
          "child_attributes": [
            {}
          ],
          "image_file_name": "'image.png'",
          "image_attributes": [
            {
              "id": "626af4fc76fae63e6e6174b7",
              "attributeId": "626af4fc76fae63e6e6174b7",
              "externalId": "626af4fc76fae63e6e6174b7",
              "name": "Stitch count",
              "value": "\"8\""
            }
          ],
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ]
    }
  ],
  "order_discounts": {
    "discounted_total": 93.5,
    "original_total": 135,
    "total_after_line_item_discount": 111.5,
    "total_applied": -41.5,
    "applied": [
      {
        "_id": "631ef10f0367f47036f86dc2",
        "name": "OrderLevelDiscount2",
        "description": "off $1",
        "discount": -13.5,
        "currency_code": "USD",
        "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
      }
    ],
    "surcharge": 0,
    "company_manual_discount": 0,
    "surcharges": {
      "total_surcharge": "0",
      "applied": [
        {
          "name": "Setup Fee",
          "description": "Setup Fee Description",
          "price": "0",
          "currency_code": "USD",
          "price_code": "USD"
        }
      ]
    }
  },
  "shipping_information": {
    "service_type": "USPS Priority Mail",
    "service_code": "uspsPriorityMail",
    "carrier_code": "12345",
    "carrier_friendly_name": "United States Postal Service",
    "price": 25,
    "final_amount": 25
  },
  "total": 100
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string",
      "description": "The Order Number,"
    },
    "external_id": {
      "type": "string",
      "description": "External Order Number (from your system),"
    },
    "customer_po_number": {
      "type": "string",
      "description": "Customer's PO Number,"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency Code,"
    },
    "status": {
      "type": "string",
      "description": "Order Status (NuORDER, read-only field),"
    },
    "discount": {
      "type": "number",
      "description": "Discount % (0 - 100),"
    },
    "ship_start": {
      "type": "string",
      "description": "Order Ship Start,"
    },
    "ship_end": {
      "type": "string",
      "description": "Order Ship End,"
    },
    "rep_code": {
      "type": "string",
      "description": "Sales rep code,"
    },
    "rep_email": {
      "type": "string",
      "description": "Sales rep email,"
    },
    "notes": {
      "type": "string",
      "description": "Order note,"
    },
    "use_advanced_promotions": {
      "type": "boolean",
      "description": "Prices are taken from API and promotions are calculated by the NuORDER platform,"
    },
    "billing_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Billing address,"
    },
    "shipping_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Shipping address,"
    },
    "retailer": {
      "type": "object",
      "properties": {
        "retailer_code": {
          "type": "string",
          "description": "The customer code"
        },
        "buyer_email": {
          "type": "string",
          "description": "The buyer email (must exist in NuORDER)"
        }
      },
      "required": [
        "retailer_code",
        "buyer_email"
      ],
      "description": "Retailer information,"
    },
    "line_items": {
      "type": "array",
      "description": "Line items,"
    },
    "order_discounts": {
      "type": "object",
      "properties": {
        "discounted_total": {
          "type": "number",
          "description": "Discounted Total,"
        },
        "original_total": {
          "type": "number",
          "description": "Original Total,"
        },
        "total_after_line_item_discount": {
          "type": "number",
          "description": "Total after Line Item Discount,"
        },
        "total_applied": {
          "type": "number",
          "description": "Total Discount Applied on Order,"
        },
        "applied": {
          "type": "array",
          "description": "Applied Discount Objects,"
        },
        "surcharge": {
          "type": "number",
          "description": "Surcharge Applied on Order,"
        },
        "company_manual_discount": {
          "type": "number",
          "description": "Company Manual Discount,"
        },
        "surcharges": {
          "type": "object",
          "properties": {
            "total_surcharge": {
              "type": "string",
              "description": "Price of all surcharges of the entity (order, line item, size) combined"
            },
            "applied": {
              "type": "array",
              "description": "Individual surcharges applied to the entity (order, line item, size)"
            }
          },
          "required": [
            "total_surcharge",
            "applied"
          ],
          "description": "Surcharges, that were accounted for the order"
        }
      },
      "description": "Order Discounts,"
    },
    "shipping_information": {
      "type": "object",
      "properties": {
        "service_type": {
          "type": "string",
          "description": "type of service"
        },
        "service_code": {
          "type": "string",
          "description": "service code"
        },
        "carrier_code": {
          "type": "string",
          "description": "carrier code"
        },
        "carrier_friendly_name": {
          "type": "string",
          "description": "carrier friendly name"
        },
        "price": {
          "type": "number",
          "description": "price displayed in the ui"
        },
        "final_amount": {
          "type": "number",
          "description": "price of shipping used for recalculation"
        }
      },
      "description": "Shipping Information,"
    },
    "total": {
      "type": "number",
      "description": "Order total,"
    }
  },
  "required": [
    "order_number",
    "external_id",
    "currency_code",
    "ship_start",
    "ship_end",
    "line_items"
  ]
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "order_number": "12345",
  "external_id": "888888",
  "customer_po_number": "po_number",
  "currency_code": "USD",
  "status": "approved",
  "discount": 0,
  "ship_start": "2017/10/01",
  "ship_end": "2017/10/31",
  "rep_code": "555",
  "rep_email": "testrep@nuorder.com",
  "notes": "A note at the order level",
  "use_advanced_promotions": true,
  "billing_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "shipping_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "retailer": {
    "retailer_code": "777777",
    "buyer_email": "buyer@brand.com"
  },
  "line_items": [
    {
      "id": "ksadkmg",
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "discount": 0,
      "ship_start": "2017/10/01",
      "ship_end": "2017/10/31",
      "total_applied": -2,
      "original_total": 10,
      "discounted_total": 7.5122,
      "item_price_after_discount": 8,
      "subtotal": 8,
      "adjusted_wholesale_string": "$10.00",
      "retail_string": "$15.00",
      "total_adjustment": "-1.5951",
      "company_manual_discount_on_item": 0,
      "item_manual_discount_on_item": 0,
      "applied": [
        {
          "_id": "631ef10f0367f47036f86dc2",
          "name": "OrderLevelDiscount2",
          "description": "off $1",
          "discount": -13.5,
          "currency_code": "USD",
          "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
        }
      ],
      "notes": "A note at the line level",
      "warehouse": "100",
      "sizes": [
        {
          "size": "Small",
          "upc": "123456789",
          "quantity": 10,
          "units_per_pack": 2,
          "price": 25,
          "retail": 32,
          "price_precise": "25.00000",
          "original_price": 29,
          "discounts": {
            "total_discount": 12,
            "applied": [
              {
                "_id": "631ef10f0367f47036f86dc2",
                "name": "OrderLevelDiscount2",
                "description": "off $1",
                "discount": -13.5,
                "currency_code": "USD",
                "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
              }
            ]
          },
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ],
      "prebook": false,
      "surcharges": {
        "total_surcharge": "0",
        "applied": [
          {
            "name": "Setup Fee",
            "description": "Setup Fee Description",
            "price": "0",
            "currency_code": "USD",
            "price_code": "USD"
          }
        ]
      },
      "customizations": [
        {
          "id": "626af4fc76fae63e6e6174b7",
          "attribute_id": "6259bce43bb43e84f36d28d1",
          "external_id": "some string",
          "label": "Front Panel",
          "externalId": "FP",
          "type": "printed-image",
          "value_id": "5259bce43bb43e84f36d28d1",
          "value": "4630664466382748671",
          "display_value": "https://img.nuorder.com/c9lf9rkt3j8oinraci7g/serve",
          "value_key": "0",
          "print_type": "DIGITAL",
          "target": {
            "visualizer_id": "62598b4209b24a74bf3f6620",
            "destination_id": "6259bca2cc12b83b40ea8383",
            "rotation": 0
          },
          "child_attributes": [
            {}
          ],
          "image_file_name": "'image.png'",
          "image_attributes": [
            {
              "id": "626af4fc76fae63e6e6174b7",
              "attributeId": "626af4fc76fae63e6e6174b7",
              "externalId": "626af4fc76fae63e6e6174b7",
              "name": "Stitch count",
              "value": "\"8\""
            }
          ],
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ]
    }
  ],
  "order_discounts": {
    "discounted_total": 93.5,
    "original_total": 135,
    "total_after_line_item_discount": 111.5,
    "total_applied": -41.5,
    "applied": [
      {
        "_id": "631ef10f0367f47036f86dc2",
        "name": "OrderLevelDiscount2",
        "description": "off $1",
        "discount": -13.5,
        "currency_code": "USD",
        "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
      }
    ],
    "surcharge": 0,
    "company_manual_discount": 0,
    "surcharges": {
      "total_surcharge": "0",
      "applied": [
        {
          "name": "Setup Fee",
          "description": "Setup Fee Description",
          "price": "0",
          "currency_code": "USD",
          "price_code": "USD"
        }
      ]
    }
  },
  "shipping_information": {
    "service_type": "USPS Priority Mail",
    "service_code": "uspsPriorityMail",
    "carrier_code": "12345",
    "carrier_friendly_name": "United States Postal Service",
    "price": 25,
    "final_amount": 25
  },
  "total": 100,
  "shipments": [
    {
      "line_items": [
        {
          "brand_id": "888RED",
          "season": "Core",
          "style_number": "888",
          "color": "Red",
          "sizes": "array[OrderShipmentLineSize]"
        }
      ],
      "type": "fedex",
      "tracking_numbers": [
        "[ '1Z0000000001' ]"
      ],
      "status": "packing",
      "shipment_date": "2017-09-12 00:00:00.000Z"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string",
      "description": "The Order Number,"
    },
    "external_id": {
      "type": "string",
      "description": "External Order Number (from your system),"
    },
    "customer_po_number": {
      "type": "string",
      "description": "Customer's PO Number,"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency Code,"
    },
    "status": {
      "type": "string",
      "description": "Order Status (NuORDER, read-only field),"
    },
    "discount": {
      "type": "number",
      "description": "Discount % (0 - 100),"
    },
    "ship_start": {
      "type": "string",
      "description": "Order Ship Start,"
    },
    "ship_end": {
      "type": "string",
      "description": "Order Ship End,"
    },
    "rep_code": {
      "type": "string",
      "description": "Sales rep code,"
    },
    "rep_email": {
      "type": "string",
      "description": "Sales rep email,"
    },
    "notes": {
      "type": "string",
      "description": "Order note,"
    },
    "use_advanced_promotions": {
      "type": "boolean",
      "description": "Prices are taken from API and promotions are calculated by the NuORDER platform,"
    },
    "billing_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Billing address,"
    },
    "shipping_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Shipping address,"
    },
    "retailer": {
      "type": "object",
      "properties": {
        "retailer_code": {
          "type": "string",
          "description": "The customer code"
        },
        "buyer_email": {
          "type": "string",
          "description": "The buyer email (must exist in NuORDER)"
        }
      },
      "required": [
        "retailer_code",
        "buyer_email"
      ],
      "description": "Retailer information,"
    },
    "line_items": {
      "type": "array",
      "description": "Line items,"
    },
    "order_discounts": {
      "type": "object",
      "properties": {
        "discounted_total": {
          "type": "number",
          "description": "Discounted Total,"
        },
        "original_total": {
          "type": "number",
          "description": "Original Total,"
        },
        "total_after_line_item_discount": {
          "type": "number",
          "description": "Total after Line Item Discount,"
        },
        "total_applied": {
          "type": "number",
          "description": "Total Discount Applied on Order,"
        },
        "applied": {
          "type": "array",
          "description": "Applied Discount Objects,"
        },
        "surcharge": {
          "type": "number",
          "description": "Surcharge Applied on Order,"
        },
        "company_manual_discount": {
          "type": "number",
          "description": "Company Manual Discount,"
        },
        "surcharges": {
          "type": "object",
          "properties": {
            "total_surcharge": {
              "type": "string",
              "description": "Price of all surcharges of the entity (order, line item, size) combined"
            },
            "applied": {
              "type": "array",
              "description": "Individual surcharges applied to the entity (order, line item, size)"
            }
          },
          "required": [
            "total_surcharge",
            "applied"
          ],
          "description": "Surcharges, that were accounted for the order"
        }
      },
      "description": "Order Discounts,"
    },
    "shipping_information": {
      "type": "object",
      "properties": {
        "service_type": {
          "type": "string",
          "description": "type of service"
        },
        "service_code": {
          "type": "string",
          "description": "service code"
        },
        "carrier_code": {
          "type": "string",
          "description": "carrier code"
        },
        "carrier_friendly_name": {
          "type": "string",
          "description": "carrier friendly name"
        },
        "price": {
          "type": "number",
          "description": "price displayed in the ui"
        },
        "final_amount": {
          "type": "number",
          "description": "price of shipping used for recalculation"
        }
      },
      "description": "Shipping Information,"
    },
    "total": {
      "type": "number",
      "description": "Order total,"
    },
    "shipments": {
      "type": "array",
      "description": "NuORDER shipments (read-only)"
    }
  },
  "required": [
    "order_number",
    "external_id",
    "currency_code",
    "ship_start",
    "ship_end",
    "line_items"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error message with what field(s) need to be corrected',
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403
    message: 'You do not have permission to create orders'
}

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
    code: 409,
    message: 'An order already exists'
}

Update Order
POST`/api/order/{id}`

Example URI

POST https://nuorder.com/api/order/59e4eeca3d58e0000123a346

URI Parameters

HideShow

id: string (required) Example: 59e4eeca3d58e0000123a346
order id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "order_number": "12345",
  "external_id": "888888",
  "customer_po_number": "po_number",
  "currency_code": "USD",
  "status": "approved",
  "discount": 0,
  "ship_start": "2017/10/01",
  "ship_end": "2017/10/31",
  "rep_code": "555",
  "rep_email": "testrep@nuorder.com",
  "notes": "A note at the order level",
  "use_advanced_promotions": true,
  "billing_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "shipping_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "retailer": {
    "retailer_code": "777777",
    "buyer_email": "buyer@brand.com"
  },
  "line_items": [
    {
      "id": "ksadkmg",
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "discount": 0,
      "ship_start": "2017/10/01",
      "ship_end": "2017/10/31",
      "total_applied": -2,
      "original_total": 10,
      "discounted_total": 7.5122,
      "item_price_after_discount": 8,
      "subtotal": 8,
      "adjusted_wholesale_string": "$10.00",
      "retail_string": "$15.00",
      "total_adjustment": "-1.5951",
      "company_manual_discount_on_item": 0,
      "item_manual_discount_on_item": 0,
      "applied": [
        {
          "_id": "631ef10f0367f47036f86dc2",
          "name": "OrderLevelDiscount2",
          "description": "off $1",
          "discount": -13.5,
          "currency_code": "USD",
          "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
        }
      ],
      "notes": "A note at the line level",
      "warehouse": "100",
      "sizes": [
        {
          "size": "Small",
          "upc": "123456789",
          "quantity": 10,
          "units_per_pack": 2,
          "price": 25,
          "retail": 32,
          "price_precise": "25.00000",
          "original_price": 29,
          "discounts": {
            "total_discount": 12,
            "applied": [
              {
                "_id": "631ef10f0367f47036f86dc2",
                "name": "OrderLevelDiscount2",
                "description": "off $1",
                "discount": -13.5,
                "currency_code": "USD",
                "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
              }
            ]
          },
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ],
      "prebook": false,
      "surcharges": {
        "total_surcharge": "0",
        "applied": [
          {
            "name": "Setup Fee",
            "description": "Setup Fee Description",
            "price": "0",
            "currency_code": "USD",
            "price_code": "USD"
          }
        ]
      },
      "customizations": [
        {
          "id": "626af4fc76fae63e6e6174b7",
          "attribute_id": "6259bce43bb43e84f36d28d1",
          "external_id": "some string",
          "label": "Front Panel",
          "externalId": "FP",
          "type": "printed-image",
          "value_id": "5259bce43bb43e84f36d28d1",
          "value": "4630664466382748671",
          "display_value": "https://img.nuorder.com/c9lf9rkt3j8oinraci7g/serve",
          "value_key": "0",
          "print_type": "DIGITAL",
          "target": {
            "visualizer_id": "62598b4209b24a74bf3f6620",
            "destination_id": "6259bca2cc12b83b40ea8383",
            "rotation": 0
          },
          "child_attributes": [
            {}
          ],
          "image_file_name": "'image.png'",
          "image_attributes": [
            {
              "id": "626af4fc76fae63e6e6174b7",
              "attributeId": "626af4fc76fae63e6e6174b7",
              "externalId": "626af4fc76fae63e6e6174b7",
              "name": "Stitch count",
              "value": "\"8\""
            }
          ],
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ]
    }
  ],
  "order_discounts": {
    "discounted_total": 93.5,
    "original_total": 135,
    "total_after_line_item_discount": 111.5,
    "total_applied": -41.5,
    "applied": [
      {
        "_id": "631ef10f0367f47036f86dc2",
        "name": "OrderLevelDiscount2",
        "description": "off $1",
        "discount": -13.5,
        "currency_code": "USD",
        "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
      }
    ],
    "surcharge": 0,
    "company_manual_discount": 0,
    "surcharges": {
      "total_surcharge": "0",
      "applied": [
        {
          "name": "Setup Fee",
          "description": "Setup Fee Description",
          "price": "0",
          "currency_code": "USD",
          "price_code": "USD"
        }
      ]
    }
  },
  "shipping_information": {
    "service_type": "USPS Priority Mail",
    "service_code": "uspsPriorityMail",
    "carrier_code": "12345",
    "carrier_friendly_name": "United States Postal Service",
    "price": 25,
    "final_amount": 25
  },
  "total": 100
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string",
      "description": "The Order Number,"
    },
    "external_id": {
      "type": "string",
      "description": "External Order Number (from your system),"
    },
    "customer_po_number": {
      "type": "string",
      "description": "Customer's PO Number,"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency Code,"
    },
    "status": {
      "type": "string",
      "description": "Order Status (NuORDER, read-only field),"
    },
    "discount": {
      "type": "number",
      "description": "Discount % (0 - 100),"
    },
    "ship_start": {
      "type": "string",
      "description": "Order Ship Start,"
    },
    "ship_end": {
      "type": "string",
      "description": "Order Ship End,"
    },
    "rep_code": {
      "type": "string",
      "description": "Sales rep code,"
    },
    "rep_email": {
      "type": "string",
      "description": "Sales rep email,"
    },
    "notes": {
      "type": "string",
      "description": "Order note,"
    },
    "use_advanced_promotions": {
      "type": "boolean",
      "description": "Prices are taken from API and promotions are calculated by the NuORDER platform,"
    },
    "billing_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Billing address,"
    },
    "shipping_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Shipping address,"
    },
    "retailer": {
      "type": "object",
      "properties": {
        "retailer_code": {
          "type": "string",
          "description": "The customer code"
        },
        "buyer_email": {
          "type": "string",
          "description": "The buyer email (must exist in NuORDER)"
        }
      },
      "required": [
        "retailer_code",
        "buyer_email"
      ],
      "description": "Retailer information,"
    },
    "line_items": {
      "type": "array",
      "description": "Line items,"
    },
    "order_discounts": {
      "type": "object",
      "properties": {
        "discounted_total": {
          "type": "number",
          "description": "Discounted Total,"
        },
        "original_total": {
          "type": "number",
          "description": "Original Total,"
        },
        "total_after_line_item_discount": {
          "type": "number",
          "description": "Total after Line Item Discount,"
        },
        "total_applied": {
          "type": "number",
          "description": "Total Discount Applied on Order,"
        },
        "applied": {
          "type": "array",
          "description": "Applied Discount Objects,"
        },
        "surcharge": {
          "type": "number",
          "description": "Surcharge Applied on Order,"
        },
        "company_manual_discount": {
          "type": "number",
          "description": "Company Manual Discount,"
        },
        "surcharges": {
          "type": "object",
          "properties": {
            "total_surcharge": {
              "type": "string",
              "description": "Price of all surcharges of the entity (order, line item, size) combined"
            },
            "applied": {
              "type": "array",
              "description": "Individual surcharges applied to the entity (order, line item, size)"
            }
          },
          "required": [
            "total_surcharge",
            "applied"
          ],
          "description": "Surcharges, that were accounted for the order"
        }
      },
      "description": "Order Discounts,"
    },
    "shipping_information": {
      "type": "object",
      "properties": {
        "service_type": {
          "type": "string",
          "description": "type of service"
        },
        "service_code": {
          "type": "string",
          "description": "service code"
        },
        "carrier_code": {
          "type": "string",
          "description": "carrier code"
        },
        "carrier_friendly_name": {
          "type": "string",
          "description": "carrier friendly name"
        },
        "price": {
          "type": "number",
          "description": "price displayed in the ui"
        },
        "final_amount": {
          "type": "number",
          "description": "price of shipping used for recalculation"
        }
      },
      "description": "Shipping Information,"
    },
    "total": {
      "type": "number",
      "description": "Order total (We recommend not including this field so that NuORDER can automatically calculate the order total based on the line item quantity and price. This represents the ORDER TOTAL at the Header Level.),"
    }
  },
  "required": [
    "order_number",
    "external_id",
    "currency_code",
    "ship_start",
    "ship_end",
    "line_items"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    'success': true,
    'message': 'Order Cancelled'
}

Response 304

HideShow

Headers

Content-Type: application/json

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Order not found'
}

Update Order by Number
POST`/api/order/number/{id}`

Example URI

POST https://nuorder.com/api/order/number/12345

URI Parameters

HideShow

id: string (required) Example: 12345
Order Number or External ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "order_number": "12345",
  "external_id": "888888",
  "customer_po_number": "po_number",
  "currency_code": "USD",
  "status": "approved",
  "discount": 0,
  "ship_start": "2017/10/01",
  "ship_end": "2017/10/31",
  "rep_code": "555",
  "rep_email": "testrep@nuorder.com",
  "notes": "A note at the order level",
  "use_advanced_promotions": true,
  "billing_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "shipping_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "retailer": {
    "retailer_code": "777777",
    "buyer_email": "buyer@brand.com"
  },
  "line_items": [
    {
      "id": "ksadkmg",
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "discount": 0,
      "ship_start": "2017/10/01",
      "ship_end": "2017/10/31",
      "total_applied": -2,
      "original_total": 10,
      "discounted_total": 7.5122,
      "item_price_after_discount": 8,
      "subtotal": 8,
      "adjusted_wholesale_string": "$10.00",
      "retail_string": "$15.00",
      "total_adjustment": "-1.5951",
      "company_manual_discount_on_item": 0,
      "item_manual_discount_on_item": 0,
      "applied": [
        {
          "_id": "631ef10f0367f47036f86dc2",
          "name": "OrderLevelDiscount2",
          "description": "off $1",
          "discount": -13.5,
          "currency_code": "USD",
          "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
        }
      ],
      "notes": "A note at the line level",
      "warehouse": "100",
      "sizes": [
        {
          "size": "Small",
          "upc": "123456789",
          "quantity": 10,
          "units_per_pack": 2,
          "price": 25,
          "retail": 32,
          "price_precise": "25.00000",
          "original_price": 29,
          "discounts": {
            "total_discount": 12,
            "applied": [
              {
                "_id": "631ef10f0367f47036f86dc2",
                "name": "OrderLevelDiscount2",
                "description": "off $1",
                "discount": -13.5,
                "currency_code": "USD",
                "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
              }
            ]
          },
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ],
      "prebook": false,
      "surcharges": {
        "total_surcharge": "0",
        "applied": [
          {
            "name": "Setup Fee",
            "description": "Setup Fee Description",
            "price": "0",
            "currency_code": "USD",
            "price_code": "USD"
          }
        ]
      },
      "customizations": [
        {
          "id": "626af4fc76fae63e6e6174b7",
          "attribute_id": "6259bce43bb43e84f36d28d1",
          "external_id": "some string",
          "label": "Front Panel",
          "externalId": "FP",
          "type": "printed-image",
          "value_id": "5259bce43bb43e84f36d28d1",
          "value": "4630664466382748671",
          "display_value": "https://img.nuorder.com/c9lf9rkt3j8oinraci7g/serve",
          "value_key": "0",
          "print_type": "DIGITAL",
          "target": {
            "visualizer_id": "62598b4209b24a74bf3f6620",
            "destination_id": "6259bca2cc12b83b40ea8383",
            "rotation": 0
          },
          "child_attributes": [
            {}
          ],
          "image_file_name": "'image.png'",
          "image_attributes": [
            {
              "id": "626af4fc76fae63e6e6174b7",
              "attributeId": "626af4fc76fae63e6e6174b7",
              "externalId": "626af4fc76fae63e6e6174b7",
              "name": "Stitch count",
              "value": "\"8\""
            }
          ],
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ]
    }
  ],
  "order_discounts": {
    "discounted_total": 93.5,
    "original_total": 135,
    "total_after_line_item_discount": 111.5,
    "total_applied": -41.5,
    "applied": [
      {
        "_id": "631ef10f0367f47036f86dc2",
        "name": "OrderLevelDiscount2",
        "description": "off $1",
        "discount": -13.5,
        "currency_code": "USD",
        "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
      }
    ],
    "surcharge": 0,
    "company_manual_discount": 0,
    "surcharges": {
      "total_surcharge": "0",
      "applied": [
        {
          "name": "Setup Fee",
          "description": "Setup Fee Description",
          "price": "0",
          "currency_code": "USD",
          "price_code": "USD"
        }
      ]
    }
  },
  "shipping_information": {
    "service_type": "USPS Priority Mail",
    "service_code": "uspsPriorityMail",
    "carrier_code": "12345",
    "carrier_friendly_name": "United States Postal Service",
    "price": 25,
    "final_amount": 25
  },
  "total": 100
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string",
      "description": "The Order Number,"
    },
    "external_id": {
      "type": "string",
      "description": "External Order Number (from your system),"
    },
    "customer_po_number": {
      "type": "string",
      "description": "Customer's PO Number,"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency Code,"
    },
    "status": {
      "type": "string",
      "description": "Order Status (NuORDER, read-only field),"
    },
    "discount": {
      "type": "number",
      "description": "Discount % (0 - 100),"
    },
    "ship_start": {
      "type": "string",
      "description": "Order Ship Start,"
    },
    "ship_end": {
      "type": "string",
      "description": "Order Ship End,"
    },
    "rep_code": {
      "type": "string",
      "description": "Sales rep code,"
    },
    "rep_email": {
      "type": "string",
      "description": "Sales rep email,"
    },
    "notes": {
      "type": "string",
      "description": "Order note,"
    },
    "use_advanced_promotions": {
      "type": "boolean",
      "description": "Prices are taken from API and promotions are calculated by the NuORDER platform,"
    },
    "billing_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Billing address,"
    },
    "shipping_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Shipping address,"
    },
    "retailer": {
      "type": "object",
      "properties": {
        "retailer_code": {
          "type": "string",
          "description": "The customer code"
        },
        "buyer_email": {
          "type": "string",
          "description": "The buyer email (must exist in NuORDER)"
        }
      },
      "required": [
        "retailer_code",
        "buyer_email"
      ],
      "description": "Retailer information,"
    },
    "line_items": {
      "type": "array",
      "description": "Line items,"
    },
    "order_discounts": {
      "type": "object",
      "properties": {
        "discounted_total": {
          "type": "number",
          "description": "Discounted Total,"
        },
        "original_total": {
          "type": "number",
          "description": "Original Total,"
        },
        "total_after_line_item_discount": {
          "type": "number",
          "description": "Total after Line Item Discount,"
        },
        "total_applied": {
          "type": "number",
          "description": "Total Discount Applied on Order,"
        },
        "applied": {
          "type": "array",
          "description": "Applied Discount Objects,"
        },
        "surcharge": {
          "type": "number",
          "description": "Surcharge Applied on Order,"
        },
        "company_manual_discount": {
          "type": "number",
          "description": "Company Manual Discount,"
        },
        "surcharges": {
          "type": "object",
          "properties": {
            "total_surcharge": {
              "type": "string",
              "description": "Price of all surcharges of the entity (order, line item, size) combined"
            },
            "applied": {
              "type": "array",
              "description": "Individual surcharges applied to the entity (order, line item, size)"
            }
          },
          "required": [
            "total_surcharge",
            "applied"
          ],
          "description": "Surcharges, that were accounted for the order"
        }
      },
      "description": "Order Discounts,"
    },
    "shipping_information": {
      "type": "object",
      "properties": {
        "service_type": {
          "type": "string",
          "description": "type of service"
        },
        "service_code": {
          "type": "string",
          "description": "service code"
        },
        "carrier_code": {
          "type": "string",
          "description": "carrier code"
        },
        "carrier_friendly_name": {
          "type": "string",
          "description": "carrier friendly name"
        },
        "price": {
          "type": "number",
          "description": "price displayed in the ui"
        },
        "final_amount": {
          "type": "number",
          "description": "price of shipping used for recalculation"
        }
      },
      "description": "Shipping Information,"
    },
    "total": {
      "type": "number",
      "description": "Order total (We recommend not including this field so that NuORDER can automatically calculate the order total based on the line item quantity and price. This represents the ORDER TOTAL at the Header Level.),"
    }
  },
  "required": [
    "order_number",
    "currency_code",
    "ship_start",
    "ship_end",
    "line_items"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "order_number": "12345",
  "external_id": "888888",
  "customer_po_number": "po_number",
  "currency_code": "USD",
  "status": "approved",
  "discount": 0,
  "ship_start": "2017/10/01",
  "ship_end": "2017/10/31",
  "rep_code": "555",
  "rep_email": "testrep@nuorder.com",
  "notes": "A note at the order level",
  "use_advanced_promotions": true,
  "billing_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "shipping_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "retailer": {
    "retailer_code": "777777",
    "buyer_email": "buyer@brand.com"
  },
  "line_items": [
    {
      "id": "ksadkmg",
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "discount": 0,
      "ship_start": "2017/10/01",
      "ship_end": "2017/10/31",
      "total_applied": -2,
      "original_total": 10,
      "discounted_total": 7.5122,
      "item_price_after_discount": 8,
      "subtotal": 8,
      "adjusted_wholesale_string": "$10.00",
      "retail_string": "$15.00",
      "total_adjustment": "-1.5951",
      "company_manual_discount_on_item": 0,
      "item_manual_discount_on_item": 0,
      "applied": [
        {
          "_id": "631ef10f0367f47036f86dc2",
          "name": "OrderLevelDiscount2",
          "description": "off $1",
          "discount": -13.5,
          "currency_code": "USD",
          "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
        }
      ],
      "notes": "A note at the line level",
      "warehouse": "100",
      "sizes": [
        {
          "size": "Small",
          "upc": "123456789",
          "quantity": 10,
          "units_per_pack": 2,
          "price": 25,
          "retail": 32,
          "price_precise": "25.00000",
          "original_price": 29,
          "discounts": {
            "total_discount": 12,
            "applied": [
              {
                "_id": "631ef10f0367f47036f86dc2",
                "name": "OrderLevelDiscount2",
                "description": "off $1",
                "discount": -13.5,
                "currency_code": "USD",
                "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
              }
            ]
          },
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ],
      "prebook": false,
      "surcharges": {
        "total_surcharge": "0",
        "applied": [
          {
            "name": "Setup Fee",
            "description": "Setup Fee Description",
            "price": "0",
            "currency_code": "USD",
            "price_code": "USD"
          }
        ]
      },
      "customizations": [
        {
          "id": "626af4fc76fae63e6e6174b7",
          "attribute_id": "6259bce43bb43e84f36d28d1",
          "external_id": "some string",
          "label": "Front Panel",
          "externalId": "FP",
          "type": "printed-image",
          "value_id": "5259bce43bb43e84f36d28d1",
          "value": "4630664466382748671",
          "display_value": "https://img.nuorder.com/c9lf9rkt3j8oinraci7g/serve",
          "value_key": "0",
          "print_type": "DIGITAL",
          "target": {
            "visualizer_id": "62598b4209b24a74bf3f6620",
            "destination_id": "6259bca2cc12b83b40ea8383",
            "rotation": 0
          },
          "child_attributes": [
            {}
          ],
          "image_file_name": "'image.png'",
          "image_attributes": [
            {
              "id": "626af4fc76fae63e6e6174b7",
              "attributeId": "626af4fc76fae63e6e6174b7",
              "externalId": "626af4fc76fae63e6e6174b7",
              "name": "Stitch count",
              "value": "\"8\""
            }
          ],
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ]
    }
  ],
  "order_discounts": {
    "discounted_total": 93.5,
    "original_total": 135,
    "total_after_line_item_discount": 111.5,
    "total_applied": -41.5,
    "applied": [
      {
        "_id": "631ef10f0367f47036f86dc2",
        "name": "OrderLevelDiscount2",
        "description": "off $1",
        "discount": -13.5,
        "currency_code": "USD",
        "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
      }
    ],
    "surcharge": 0,
    "company_manual_discount": 0,
    "surcharges": {
      "total_surcharge": "0",
      "applied": [
        {
          "name": "Setup Fee",
          "description": "Setup Fee Description",
          "price": "0",
          "currency_code": "USD",
          "price_code": "USD"
        }
      ]
    }
  },
  "shipping_information": {
    "service_type": "USPS Priority Mail",
    "service_code": "uspsPriorityMail",
    "carrier_code": "12345",
    "carrier_friendly_name": "United States Postal Service",
    "price": 25,
    "final_amount": 25
  },
  "total": 100,
  "shipments": [
    {
      "line_items": [
        {
          "brand_id": "888RED",
          "season": "Core",
          "style_number": "888",
          "color": "Red",
          "sizes": "array[OrderShipmentLineSize]"
        }
      ],
      "type": "fedex",
      "tracking_numbers": [
        "[ '1Z0000000001' ]"
      ],
      "status": "packing",
      "shipment_date": "2017-09-12 00:00:00.000Z"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string",
      "description": "The Order Number,"
    },
    "external_id": {
      "type": "string",
      "description": "External Order Number (from your system),"
    },
    "customer_po_number": {
      "type": "string",
      "description": "Customer's PO Number,"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency Code,"
    },
    "status": {
      "type": "string",
      "description": "Order Status (NuORDER, read-only field),"
    },
    "discount": {
      "type": "number",
      "description": "Discount % (0 - 100),"
    },
    "ship_start": {
      "type": "string",
      "description": "Order Ship Start,"
    },
    "ship_end": {
      "type": "string",
      "description": "Order Ship End,"
    },
    "rep_code": {
      "type": "string",
      "description": "Sales rep code,"
    },
    "rep_email": {
      "type": "string",
      "description": "Sales rep email,"
    },
    "notes": {
      "type": "string",
      "description": "Order note,"
    },
    "use_advanced_promotions": {
      "type": "boolean",
      "description": "Prices are taken from API and promotions are calculated by the NuORDER platform,"
    },
    "billing_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Billing address,"
    },
    "shipping_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Shipping address,"
    },
    "retailer": {
      "type": "object",
      "properties": {
        "retailer_code": {
          "type": "string",
          "description": "The customer code"
        },
        "buyer_email": {
          "type": "string",
          "description": "The buyer email (must exist in NuORDER)"
        }
      },
      "required": [
        "retailer_code",
        "buyer_email"
      ],
      "description": "Retailer information,"
    },
    "line_items": {
      "type": "array",
      "description": "Line items,"
    },
    "order_discounts": {
      "type": "object",
      "properties": {
        "discounted_total": {
          "type": "number",
          "description": "Discounted Total,"
        },
        "original_total": {
          "type": "number",
          "description": "Original Total,"
        },
        "total_after_line_item_discount": {
          "type": "number",
          "description": "Total after Line Item Discount,"
        },
        "total_applied": {
          "type": "number",
          "description": "Total Discount Applied on Order,"
        },
        "applied": {
          "type": "array",
          "description": "Applied Discount Objects,"
        },
        "surcharge": {
          "type": "number",
          "description": "Surcharge Applied on Order,"
        },
        "company_manual_discount": {
          "type": "number",
          "description": "Company Manual Discount,"
        },
        "surcharges": {
          "type": "object",
          "properties": {
            "total_surcharge": {
              "type": "string",
              "description": "Price of all surcharges of the entity (order, line item, size) combined"
            },
            "applied": {
              "type": "array",
              "description": "Individual surcharges applied to the entity (order, line item, size)"
            }
          },
          "required": [
            "total_surcharge",
            "applied"
          ],
          "description": "Surcharges, that were accounted for the order"
        }
      },
      "description": "Order Discounts,"
    },
    "shipping_information": {
      "type": "object",
      "properties": {
        "service_type": {
          "type": "string",
          "description": "type of service"
        },
        "service_code": {
          "type": "string",
          "description": "service code"
        },
        "carrier_code": {
          "type": "string",
          "description": "carrier code"
        },
        "carrier_friendly_name": {
          "type": "string",
          "description": "carrier friendly name"
        },
        "price": {
          "type": "number",
          "description": "price displayed in the ui"
        },
        "final_amount": {
          "type": "number",
          "description": "price of shipping used for recalculation"
        }
      },
      "description": "Shipping Information,"
    },
    "total": {
      "type": "number",
      "description": "Order total,"
    },
    "shipments": {
      "type": "array",
      "description": "NuORDER shipments (read-only)"
    }
  },
  "required": [
    "order_number",
    "external_id",
    "currency_code",
    "ship_start",
    "ship_end",
    "line_items"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error message with what field(s) need to be corrected',
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
        code: 403
        message: 'You do not have permission to edit orders'
    }

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
        code: 404,
        message: 'Order not found'
    }

Update Order Status by Order ID
POST`/api/order/{id}/{status}`

Example URI

POST https://nuorder.com/api/order/59e4eeca3d58e0000123a346/approved

URI Parameters

HideShow

id

string (required) Example: 59e4eeca3d58e0000123a346

order id

status

enum (required) Example: approved

Order Status

Choices: review pending approved processed shipped cancelled

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "order_number": "12345",
  "external_id": "888888",
  "customer_po_number": "po_number",
  "currency_code": "USD",
  "status": "approved",
  "discount": 0,
  "ship_start": "2017/10/01",
  "ship_end": "2017/10/31",
  "rep_code": "555",
  "rep_email": "testrep@nuorder.com",
  "notes": "A note at the order level",
  "use_advanced_promotions": true,
  "billing_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "shipping_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "retailer": {
    "retailer_code": "777777",
    "buyer_email": "buyer@brand.com"
  },
  "line_items": [
    {
      "id": "ksadkmg",
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "discount": 0,
      "ship_start": "2017/10/01",
      "ship_end": "2017/10/31",
      "total_applied": -2,
      "original_total": 10,
      "discounted_total": 7.5122,
      "item_price_after_discount": 8,
      "subtotal": 8,
      "adjusted_wholesale_string": "$10.00",
      "retail_string": "$15.00",
      "total_adjustment": "-1.5951",
      "company_manual_discount_on_item": 0,
      "item_manual_discount_on_item": 0,
      "applied": [
        {
          "_id": "631ef10f0367f47036f86dc2",
          "name": "OrderLevelDiscount2",
          "description": "off $1",
          "discount": -13.5,
          "currency_code": "USD",
          "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
        }
      ],
      "notes": "A note at the line level",
      "warehouse": "100",
      "sizes": [
        {
          "size": "Small",
          "upc": "123456789",
          "quantity": 10,
          "units_per_pack": 2,
          "price": 25,
          "retail": 32,
          "price_precise": "25.00000",
          "original_price": 29,
          "discounts": {
            "total_discount": 12,
            "applied": [
              {
                "_id": "631ef10f0367f47036f86dc2",
                "name": "OrderLevelDiscount2",
                "description": "off $1",
                "discount": -13.5,
                "currency_code": "USD",
                "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
              }
            ]
          },
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ],
      "prebook": false,
      "surcharges": {
        "total_surcharge": "0",
        "applied": [
          {
            "name": "Setup Fee",
            "description": "Setup Fee Description",
            "price": "0",
            "currency_code": "USD",
            "price_code": "USD"
          }
        ]
      },
      "customizations": [
        {
          "id": "626af4fc76fae63e6e6174b7",
          "attribute_id": "6259bce43bb43e84f36d28d1",
          "external_id": "some string",
          "label": "Front Panel",
          "externalId": "FP",
          "type": "printed-image",
          "value_id": "5259bce43bb43e84f36d28d1",
          "value": "4630664466382748671",
          "display_value": "https://img.nuorder.com/c9lf9rkt3j8oinraci7g/serve",
          "value_key": "0",
          "print_type": "DIGITAL",
          "target": {
            "visualizer_id": "62598b4209b24a74bf3f6620",
            "destination_id": "6259bca2cc12b83b40ea8383",
            "rotation": 0
          },
          "child_attributes": [
            {}
          ],
          "image_file_name": "'image.png'",
          "image_attributes": [
            {
              "id": "626af4fc76fae63e6e6174b7",
              "attributeId": "626af4fc76fae63e6e6174b7",
              "externalId": "626af4fc76fae63e6e6174b7",
              "name": "Stitch count",
              "value": "\"8\""
            }
          ],
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ]
    }
  ],
  "order_discounts": {
    "discounted_total": 93.5,
    "original_total": 135,
    "total_after_line_item_discount": 111.5,
    "total_applied": -41.5,
    "applied": [
      {
        "_id": "631ef10f0367f47036f86dc2",
        "name": "OrderLevelDiscount2",
        "description": "off $1",
        "discount": -13.5,
        "currency_code": "USD",
        "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
      }
    ],
    "surcharge": 0,
    "company_manual_discount": 0,
    "surcharges": {
      "total_surcharge": "0",
      "applied": [
        {
          "name": "Setup Fee",
          "description": "Setup Fee Description",
          "price": "0",
          "currency_code": "USD",
          "price_code": "USD"
        }
      ]
    }
  },
  "shipping_information": {
    "service_type": "USPS Priority Mail",
    "service_code": "uspsPriorityMail",
    "carrier_code": "12345",
    "carrier_friendly_name": "United States Postal Service",
    "price": 25,
    "final_amount": 25
  },
  "total": 100,
  "shipments": [
    {
      "line_items": [
        {
          "brand_id": "888RED",
          "season": "Core",
          "style_number": "888",
          "color": "Red",
          "sizes": "array[OrderShipmentLineSize]"
        }
      ],
      "type": "fedex",
      "tracking_numbers": [
        "[ '1Z0000000001' ]"
      ],
      "status": "packing",
      "shipment_date": "2017-09-12 00:00:00.000Z"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string",
      "description": "The Order Number,"
    },
    "external_id": {
      "type": "string",
      "description": "External Order Number (from your system),"
    },
    "customer_po_number": {
      "type": "string",
      "description": "Customer's PO Number,"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency Code,"
    },
    "status": {
      "type": "string",
      "description": "Order Status (NuORDER, read-only field),"
    },
    "discount": {
      "type": "number",
      "description": "Discount % (0 - 100),"
    },
    "ship_start": {
      "type": "string",
      "description": "Order Ship Start,"
    },
    "ship_end": {
      "type": "string",
      "description": "Order Ship End,"
    },
    "rep_code": {
      "type": "string",
      "description": "Sales rep code,"
    },
    "rep_email": {
      "type": "string",
      "description": "Sales rep email,"
    },
    "notes": {
      "type": "string",
      "description": "Order note,"
    },
    "use_advanced_promotions": {
      "type": "boolean",
      "description": "Prices are taken from API and promotions are calculated by the NuORDER platform,"
    },
    "billing_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Billing address,"
    },
    "shipping_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Shipping address,"
    },
    "retailer": {
      "type": "object",
      "properties": {
        "retailer_code": {
          "type": "string",
          "description": "The customer code"
        },
        "buyer_email": {
          "type": "string",
          "description": "The buyer email (must exist in NuORDER)"
        }
      },
      "required": [
        "retailer_code",
        "buyer_email"
      ],
      "description": "Retailer information,"
    },
    "line_items": {
      "type": "array",
      "description": "Line items,"
    },
    "order_discounts": {
      "type": "object",
      "properties": {
        "discounted_total": {
          "type": "number",
          "description": "Discounted Total,"
        },
        "original_total": {
          "type": "number",
          "description": "Original Total,"
        },
        "total_after_line_item_discount": {
          "type": "number",
          "description": "Total after Line Item Discount,"
        },
        "total_applied": {
          "type": "number",
          "description": "Total Discount Applied on Order,"
        },
        "applied": {
          "type": "array",
          "description": "Applied Discount Objects,"
        },
        "surcharge": {
          "type": "number",
          "description": "Surcharge Applied on Order,"
        },
        "company_manual_discount": {
          "type": "number",
          "description": "Company Manual Discount,"
        },
        "surcharges": {
          "type": "object",
          "properties": {
            "total_surcharge": {
              "type": "string",
              "description": "Price of all surcharges of the entity (order, line item, size) combined"
            },
            "applied": {
              "type": "array",
              "description": "Individual surcharges applied to the entity (order, line item, size)"
            }
          },
          "required": [
            "total_surcharge",
            "applied"
          ],
          "description": "Surcharges, that were accounted for the order"
        }
      },
      "description": "Order Discounts,"
    },
    "shipping_information": {
      "type": "object",
      "properties": {
        "service_type": {
          "type": "string",
          "description": "type of service"
        },
        "service_code": {
          "type": "string",
          "description": "service code"
        },
        "carrier_code": {
          "type": "string",
          "description": "carrier code"
        },
        "carrier_friendly_name": {
          "type": "string",
          "description": "carrier friendly name"
        },
        "price": {
          "type": "number",
          "description": "price displayed in the ui"
        },
        "final_amount": {
          "type": "number",
          "description": "price of shipping used for recalculation"
        }
      },
      "description": "Shipping Information,"
    },
    "total": {
      "type": "number",
      "description": "Order total,"
    },
    "shipments": {
      "type": "array",
      "description": "NuORDER shipments (read-only)"
    }
  },
  "required": [
    "order_number",
    "external_id",
    "currency_code",
    "ship_start",
    "ship_end",
    "line_items"
  ]
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
        code: 404,
        message: 'order not found'
    }

Update Order Status by Order Number
POST`/api/order/number/{number}/{status}`

Example URI

POST https://nuorder.com/api/order/number/234233/approved

URI Parameters

HideShow

number

string (required) Example: 234233

Order number

status

enum (required) Example: approved

Order Status

Choices: review pending approved processed shipped cancelled

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "order_number": "12345",
  "external_id": "888888",
  "customer_po_number": "po_number",
  "currency_code": "USD",
  "status": "approved",
  "discount": 0,
  "ship_start": "2017/10/01",
  "ship_end": "2017/10/31",
  "rep_code": "555",
  "rep_email": "testrep@nuorder.com",
  "notes": "A note at the order level",
  "use_advanced_promotions": true,
  "billing_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "shipping_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "retailer": {
    "retailer_code": "777777",
    "buyer_email": "buyer@brand.com"
  },
  "line_items": [
    {
      "id": "ksadkmg",
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "discount": 0,
      "ship_start": "2017/10/01",
      "ship_end": "2017/10/31",
      "total_applied": -2,
      "original_total": 10,
      "discounted_total": 7.5122,
      "item_price_after_discount": 8,
      "subtotal": 8,
      "adjusted_wholesale_string": "$10.00",
      "retail_string": "$15.00",
      "total_adjustment": "-1.5951",
      "company_manual_discount_on_item": 0,
      "item_manual_discount_on_item": 0,
      "applied": [
        {
          "_id": "631ef10f0367f47036f86dc2",
          "name": "OrderLevelDiscount2",
          "description": "off $1",
          "discount": -13.5,
          "currency_code": "USD",
          "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
        }
      ],
      "notes": "A note at the line level",
      "warehouse": "100",
      "sizes": [
        {
          "size": "Small",
          "upc": "123456789",
          "quantity": 10,
          "units_per_pack": 2,
          "price": 25,
          "retail": 32,
          "price_precise": "25.00000",
          "original_price": 29,
          "discounts": {
            "total_discount": 12,
            "applied": [
              {
                "_id": "631ef10f0367f47036f86dc2",
                "name": "OrderLevelDiscount2",
                "description": "off $1",
                "discount": -13.5,
                "currency_code": "USD",
                "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
              }
            ]
          },
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ],
      "prebook": false,
      "surcharges": {
        "total_surcharge": "0",
        "applied": [
          {
            "name": "Setup Fee",
            "description": "Setup Fee Description",
            "price": "0",
            "currency_code": "USD",
            "price_code": "USD"
          }
        ]
      },
      "customizations": [
        {
          "id": "626af4fc76fae63e6e6174b7",
          "attribute_id": "6259bce43bb43e84f36d28d1",
          "external_id": "some string",
          "label": "Front Panel",
          "externalId": "FP",
          "type": "printed-image",
          "value_id": "5259bce43bb43e84f36d28d1",
          "value": "4630664466382748671",
          "display_value": "https://img.nuorder.com/c9lf9rkt3j8oinraci7g/serve",
          "value_key": "0",
          "print_type": "DIGITAL",
          "target": {
            "visualizer_id": "62598b4209b24a74bf3f6620",
            "destination_id": "6259bca2cc12b83b40ea8383",
            "rotation": 0
          },
          "child_attributes": [
            {}
          ],
          "image_file_name": "'image.png'",
          "image_attributes": [
            {
              "id": "626af4fc76fae63e6e6174b7",
              "attributeId": "626af4fc76fae63e6e6174b7",
              "externalId": "626af4fc76fae63e6e6174b7",
              "name": "Stitch count",
              "value": "\"8\""
            }
          ],
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ]
    }
  ],
  "order_discounts": {
    "discounted_total": 93.5,
    "original_total": 135,
    "total_after_line_item_discount": 111.5,
    "total_applied": -41.5,
    "applied": [
      {
        "_id": "631ef10f0367f47036f86dc2",
        "name": "OrderLevelDiscount2",
        "description": "off $1",
        "discount": -13.5,
        "currency_code": "USD",
        "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
      }
    ],
    "surcharge": 0,
    "company_manual_discount": 0,
    "surcharges": {
      "total_surcharge": "0",
      "applied": [
        {
          "name": "Setup Fee",
          "description": "Setup Fee Description",
          "price": "0",
          "currency_code": "USD",
          "price_code": "USD"
        }
      ]
    }
  },
  "shipping_information": {
    "service_type": "USPS Priority Mail",
    "service_code": "uspsPriorityMail",
    "carrier_code": "12345",
    "carrier_friendly_name": "United States Postal Service",
    "price": 25,
    "final_amount": 25
  },
  "total": 100,
  "shipments": [
    {
      "line_items": [
        {
          "brand_id": "888RED",
          "season": "Core",
          "style_number": "888",
          "color": "Red",
          "sizes": "array[OrderShipmentLineSize]"
        }
      ],
      "type": "fedex",
      "tracking_numbers": [
        "[ '1Z0000000001' ]"
      ],
      "status": "packing",
      "shipment_date": "2017-09-12 00:00:00.000Z"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string",
      "description": "The Order Number,"
    },
    "external_id": {
      "type": "string",
      "description": "External Order Number (from your system),"
    },
    "customer_po_number": {
      "type": "string",
      "description": "Customer's PO Number,"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency Code,"
    },
    "status": {
      "type": "string",
      "description": "Order Status (NuORDER, read-only field),"
    },
    "discount": {
      "type": "number",
      "description": "Discount % (0 - 100),"
    },
    "ship_start": {
      "type": "string",
      "description": "Order Ship Start,"
    },
    "ship_end": {
      "type": "string",
      "description": "Order Ship End,"
    },
    "rep_code": {
      "type": "string",
      "description": "Sales rep code,"
    },
    "rep_email": {
      "type": "string",
      "description": "Sales rep email,"
    },
    "notes": {
      "type": "string",
      "description": "Order note,"
    },
    "use_advanced_promotions": {
      "type": "boolean",
      "description": "Prices are taken from API and promotions are calculated by the NuORDER platform,"
    },
    "billing_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Billing address,"
    },
    "shipping_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Shipping address,"
    },
    "retailer": {
      "type": "object",
      "properties": {
        "retailer_code": {
          "type": "string",
          "description": "The customer code"
        },
        "buyer_email": {
          "type": "string",
          "description": "The buyer email (must exist in NuORDER)"
        }
      },
      "required": [
        "retailer_code",
        "buyer_email"
      ],
      "description": "Retailer information,"
    },
    "line_items": {
      "type": "array",
      "description": "Line items,"
    },
    "order_discounts": {
      "type": "object",
      "properties": {
        "discounted_total": {
          "type": "number",
          "description": "Discounted Total,"
        },
        "original_total": {
          "type": "number",
          "description": "Original Total,"
        },
        "total_after_line_item_discount": {
          "type": "number",
          "description": "Total after Line Item Discount,"
        },
        "total_applied": {
          "type": "number",
          "description": "Total Discount Applied on Order,"
        },
        "applied": {
          "type": "array",
          "description": "Applied Discount Objects,"
        },
        "surcharge": {
          "type": "number",
          "description": "Surcharge Applied on Order,"
        },
        "company_manual_discount": {
          "type": "number",
          "description": "Company Manual Discount,"
        },
        "surcharges": {
          "type": "object",
          "properties": {
            "total_surcharge": {
              "type": "string",
              "description": "Price of all surcharges of the entity (order, line item, size) combined"
            },
            "applied": {
              "type": "array",
              "description": "Individual surcharges applied to the entity (order, line item, size)"
            }
          },
          "required": [
            "total_surcharge",
            "applied"
          ],
          "description": "Surcharges, that were accounted for the order"
        }
      },
      "description": "Order Discounts,"
    },
    "shipping_information": {
      "type": "object",
      "properties": {
        "service_type": {
          "type": "string",
          "description": "type of service"
        },
        "service_code": {
          "type": "string",
          "description": "service code"
        },
        "carrier_code": {
          "type": "string",
          "description": "carrier code"
        },
        "carrier_friendly_name": {
          "type": "string",
          "description": "carrier friendly name"
        },
        "price": {
          "type": "number",
          "description": "price displayed in the ui"
        },
        "final_amount": {
          "type": "number",
          "description": "price of shipping used for recalculation"
        }
      },
      "description": "Shipping Information,"
    },
    "total": {
      "type": "number",
      "description": "Order total,"
    },
    "shipments": {
      "type": "array",
      "description": "NuORDER shipments (read-only)"
    }
  },
  "required": [
    "order_number",
    "external_id",
    "currency_code",
    "ship_start",
    "ship_end",
    "line_items"
  ]
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
        code: 404,
        message: 'order not found'
    }

Update Order Locked Status by Order ID
POST`/api/order/{id}/lock`

Example URI

POST https://nuorder.com/api/order/59e4eeca3d58e0000123a346/lock

URI Parameters

HideShow

id: string (required) Example: 59e4eeca3d58e0000123a346
order id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "locked": false
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "locked": {
      "type": "boolean",
      "description": "New 'locked' status for order"
    }
  },
  "required": [
    "locked"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    'success': true
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403,
    message: 'Not allowed'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Not found'
}

Update Order Locked Status by Order Number
POST`/api/order/number/{number}/lock`

Example URI

POST https://nuorder.com/api/order/number/234233/lock

URI Parameters

HideShow

number: string (required) Example: 234233
order number

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "locked": false
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "locked": {
      "type": "boolean",
      "description": "New 'locked' status for order"
    }
  },
  "required": [
    "locked"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    'success': true
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403,
    message: 'Not allowed'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Not found'
}

Patch Order field
POST`/api/order/{id}/set/{field}/{value}`

Example URI

POST https://nuorder.com/api/order/59e4eeca3d58e0000123a346/set/external_id/value

URI Parameters

HideShow

id

string (required) Example: 59e4eeca3d58e0000123a346

order id

field

string (required) Example: external_id

name of field to be patched

Choices: external_id

value

string (required) Example: value

new value for the field

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "order_number": "12345",
  "external_id": "888888",
  "customer_po_number": "po_number",
  "currency_code": "USD",
  "status": "approved",
  "discount": 0,
  "ship_start": "2017/10/01",
  "ship_end": "2017/10/31",
  "rep_code": "555",
  "rep_email": "testrep@nuorder.com",
  "notes": "A note at the order level",
  "use_advanced_promotions": true,
  "billing_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "shipping_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "retailer": {
    "retailer_code": "777777",
    "buyer_email": "buyer@brand.com"
  },
  "line_items": [
    {
      "id": "ksadkmg",
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "discount": 0,
      "ship_start": "2017/10/01",
      "ship_end": "2017/10/31",
      "total_applied": -2,
      "original_total": 10,
      "discounted_total": 7.5122,
      "item_price_after_discount": 8,
      "subtotal": 8,
      "adjusted_wholesale_string": "$10.00",
      "retail_string": "$15.00",
      "total_adjustment": "-1.5951",
      "company_manual_discount_on_item": 0,
      "item_manual_discount_on_item": 0,
      "applied": [
        {
          "_id": "631ef10f0367f47036f86dc2",
          "name": "OrderLevelDiscount2",
          "description": "off $1",
          "discount": -13.5,
          "currency_code": "USD",
          "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
        }
      ],
      "notes": "A note at the line level",
      "warehouse": "100",
      "sizes": [
        {
          "size": "Small",
          "upc": "123456789",
          "quantity": 10,
          "units_per_pack": 2,
          "price": 25,
          "retail": 32,
          "price_precise": "25.00000",
          "original_price": 29,
          "discounts": {
            "total_discount": 12,
            "applied": [
              {
                "_id": "631ef10f0367f47036f86dc2",
                "name": "OrderLevelDiscount2",
                "description": "off $1",
                "discount": -13.5,
                "currency_code": "USD",
                "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
              }
            ]
          },
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ],
      "prebook": false,
      "surcharges": {
        "total_surcharge": "0",
        "applied": [
          {
            "name": "Setup Fee",
            "description": "Setup Fee Description",
            "price": "0",
            "currency_code": "USD",
            "price_code": "USD"
          }
        ]
      },
      "customizations": [
        {
          "id": "626af4fc76fae63e6e6174b7",
          "attribute_id": "6259bce43bb43e84f36d28d1",
          "external_id": "some string",
          "label": "Front Panel",
          "externalId": "FP",
          "type": "printed-image",
          "value_id": "5259bce43bb43e84f36d28d1",
          "value": "4630664466382748671",
          "display_value": "https://img.nuorder.com/c9lf9rkt3j8oinraci7g/serve",
          "value_key": "0",
          "print_type": "DIGITAL",
          "target": {
            "visualizer_id": "62598b4209b24a74bf3f6620",
            "destination_id": "6259bca2cc12b83b40ea8383",
            "rotation": 0
          },
          "child_attributes": [
            {}
          ],
          "image_file_name": "'image.png'",
          "image_attributes": [
            {
              "id": "626af4fc76fae63e6e6174b7",
              "attributeId": "626af4fc76fae63e6e6174b7",
              "externalId": "626af4fc76fae63e6e6174b7",
              "name": "Stitch count",
              "value": "\"8\""
            }
          ],
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ]
    }
  ],
  "order_discounts": {
    "discounted_total": 93.5,
    "original_total": 135,
    "total_after_line_item_discount": 111.5,
    "total_applied": -41.5,
    "applied": [
      {
        "_id": "631ef10f0367f47036f86dc2",
        "name": "OrderLevelDiscount2",
        "description": "off $1",
        "discount": -13.5,
        "currency_code": "USD",
        "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
      }
    ],
    "surcharge": 0,
    "company_manual_discount": 0,
    "surcharges": {
      "total_surcharge": "0",
      "applied": [
        {
          "name": "Setup Fee",
          "description": "Setup Fee Description",
          "price": "0",
          "currency_code": "USD",
          "price_code": "USD"
        }
      ]
    }
  },
  "shipping_information": {
    "service_type": "USPS Priority Mail",
    "service_code": "uspsPriorityMail",
    "carrier_code": "12345",
    "carrier_friendly_name": "United States Postal Service",
    "price": 25,
    "final_amount": 25
  },
  "total": 100,
  "shipments": [
    {
      "line_items": [
        {
          "brand_id": "888RED",
          "season": "Core",
          "style_number": "888",
          "color": "Red",
          "sizes": "array[OrderShipmentLineSize]"
        }
      ],
      "type": "fedex",
      "tracking_numbers": [
        "[ '1Z0000000001' ]"
      ],
      "status": "packing",
      "shipment_date": "2017-09-12 00:00:00.000Z"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string",
      "description": "The Order Number,"
    },
    "external_id": {
      "type": "string",
      "description": "External Order Number (from your system),"
    },
    "customer_po_number": {
      "type": "string",
      "description": "Customer's PO Number,"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency Code,"
    },
    "status": {
      "type": "string",
      "description": "Order Status (NuORDER, read-only field),"
    },
    "discount": {
      "type": "number",
      "description": "Discount % (0 - 100),"
    },
    "ship_start": {
      "type": "string",
      "description": "Order Ship Start,"
    },
    "ship_end": {
      "type": "string",
      "description": "Order Ship End,"
    },
    "rep_code": {
      "type": "string",
      "description": "Sales rep code,"
    },
    "rep_email": {
      "type": "string",
      "description": "Sales rep email,"
    },
    "notes": {
      "type": "string",
      "description": "Order note,"
    },
    "use_advanced_promotions": {
      "type": "boolean",
      "description": "Prices are taken from API and promotions are calculated by the NuORDER platform,"
    },
    "billing_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Billing address,"
    },
    "shipping_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Shipping address,"
    },
    "retailer": {
      "type": "object",
      "properties": {
        "retailer_code": {
          "type": "string",
          "description": "The customer code"
        },
        "buyer_email": {
          "type": "string",
          "description": "The buyer email (must exist in NuORDER)"
        }
      },
      "required": [
        "retailer_code",
        "buyer_email"
      ],
      "description": "Retailer information,"
    },
    "line_items": {
      "type": "array",
      "description": "Line items,"
    },
    "order_discounts": {
      "type": "object",
      "properties": {
        "discounted_total": {
          "type": "number",
          "description": "Discounted Total,"
        },
        "original_total": {
          "type": "number",
          "description": "Original Total,"
        },
        "total_after_line_item_discount": {
          "type": "number",
          "description": "Total after Line Item Discount,"
        },
        "total_applied": {
          "type": "number",
          "description": "Total Discount Applied on Order,"
        },
        "applied": {
          "type": "array",
          "description": "Applied Discount Objects,"
        },
        "surcharge": {
          "type": "number",
          "description": "Surcharge Applied on Order,"
        },
        "company_manual_discount": {
          "type": "number",
          "description": "Company Manual Discount,"
        },
        "surcharges": {
          "type": "object",
          "properties": {
            "total_surcharge": {
              "type": "string",
              "description": "Price of all surcharges of the entity (order, line item, size) combined"
            },
            "applied": {
              "type": "array",
              "description": "Individual surcharges applied to the entity (order, line item, size)"
            }
          },
          "required": [
            "total_surcharge",
            "applied"
          ],
          "description": "Surcharges, that were accounted for the order"
        }
      },
      "description": "Order Discounts,"
    },
    "shipping_information": {
      "type": "object",
      "properties": {
        "service_type": {
          "type": "string",
          "description": "type of service"
        },
        "service_code": {
          "type": "string",
          "description": "service code"
        },
        "carrier_code": {
          "type": "string",
          "description": "carrier code"
        },
        "carrier_friendly_name": {
          "type": "string",
          "description": "carrier friendly name"
        },
        "price": {
          "type": "number",
          "description": "price displayed in the ui"
        },
        "final_amount": {
          "type": "number",
          "description": "price of shipping used for recalculation"
        }
      },
      "description": "Shipping Information,"
    },
    "total": {
      "type": "number",
      "description": "Order total,"
    },
    "shipments": {
      "type": "array",
      "description": "NuORDER shipments (read-only)"
    }
  },
  "required": [
    "order_number",
    "external_id",
    "currency_code",
    "ship_start",
    "ship_end",
    "line_items"
  ]
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
        code: 404,
        message: 'order not found'
    }

Patch Order field by Order Number
POST`/api/order/number/{number}/set/{field}/{value}`

Example URI

POST https://nuorder.com/api/order/number/234233/set/external_id/value

URI Parameters

HideShow

number

string (required) Example: 234233

Order number

field

string (required) Example: external_id

name of field to be patched

Choices: external_id

value

string (required) Example: value

new value for the field

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "order_number": "12345",
  "external_id": "888888",
  "customer_po_number": "po_number",
  "currency_code": "USD",
  "status": "approved",
  "discount": 0,
  "ship_start": "2017/10/01",
  "ship_end": "2017/10/31",
  "rep_code": "555",
  "rep_email": "testrep@nuorder.com",
  "notes": "A note at the order level",
  "use_advanced_promotions": true,
  "billing_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "shipping_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "retailer": {
    "retailer_code": "777777",
    "buyer_email": "buyer@brand.com"
  },
  "line_items": [
    {
      "id": "ksadkmg",
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "discount": 0,
      "ship_start": "2017/10/01",
      "ship_end": "2017/10/31",
      "total_applied": -2,
      "original_total": 10,
      "discounted_total": 7.5122,
      "item_price_after_discount": 8,
      "subtotal": 8,
      "adjusted_wholesale_string": "$10.00",
      "retail_string": "$15.00",
      "total_adjustment": "-1.5951",
      "company_manual_discount_on_item": 0,
      "item_manual_discount_on_item": 0,
      "applied": [
        {
          "_id": "631ef10f0367f47036f86dc2",
          "name": "OrderLevelDiscount2",
          "description": "off $1",
          "discount": -13.5,
          "currency_code": "USD",
          "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
        }
      ],
      "notes": "A note at the line level",
      "warehouse": "100",
      "sizes": [
        {
          "size": "Small",
          "upc": "123456789",
          "quantity": 10,
          "units_per_pack": 2,
          "price": 25,
          "retail": 32,
          "price_precise": "25.00000",
          "original_price": 29,
          "discounts": {
            "total_discount": 12,
            "applied": [
              {
                "_id": "631ef10f0367f47036f86dc2",
                "name": "OrderLevelDiscount2",
                "description": "off $1",
                "discount": -13.5,
                "currency_code": "USD",
                "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
              }
            ]
          },
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ],
      "prebook": false,
      "surcharges": {
        "total_surcharge": "0",
        "applied": [
          {
            "name": "Setup Fee",
            "description": "Setup Fee Description",
            "price": "0",
            "currency_code": "USD",
            "price_code": "USD"
          }
        ]
      },
      "customizations": [
        {
          "id": "626af4fc76fae63e6e6174b7",
          "attribute_id": "6259bce43bb43e84f36d28d1",
          "external_id": "some string",
          "label": "Front Panel",
          "externalId": "FP",
          "type": "printed-image",
          "value_id": "5259bce43bb43e84f36d28d1",
          "value": "4630664466382748671",
          "display_value": "https://img.nuorder.com/c9lf9rkt3j8oinraci7g/serve",
          "value_key": "0",
          "print_type": "DIGITAL",
          "target": {
            "visualizer_id": "62598b4209b24a74bf3f6620",
            "destination_id": "6259bca2cc12b83b40ea8383",
            "rotation": 0
          },
          "child_attributes": [
            {}
          ],
          "image_file_name": "'image.png'",
          "image_attributes": [
            {
              "id": "626af4fc76fae63e6e6174b7",
              "attributeId": "626af4fc76fae63e6e6174b7",
              "externalId": "626af4fc76fae63e6e6174b7",
              "name": "Stitch count",
              "value": "\"8\""
            }
          ],
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ]
    }
  ],
  "order_discounts": {
    "discounted_total": 93.5,
    "original_total": 135,
    "total_after_line_item_discount": 111.5,
    "total_applied": -41.5,
    "applied": [
      {
        "_id": "631ef10f0367f47036f86dc2",
        "name": "OrderLevelDiscount2",
        "description": "off $1",
        "discount": -13.5,
        "currency_code": "USD",
        "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
      }
    ],
    "surcharge": 0,
    "company_manual_discount": 0,
    "surcharges": {
      "total_surcharge": "0",
      "applied": [
        {
          "name": "Setup Fee",
          "description": "Setup Fee Description",
          "price": "0",
          "currency_code": "USD",
          "price_code": "USD"
        }
      ]
    }
  },
  "shipping_information": {
    "service_type": "USPS Priority Mail",
    "service_code": "uspsPriorityMail",
    "carrier_code": "12345",
    "carrier_friendly_name": "United States Postal Service",
    "price": 25,
    "final_amount": 25
  },
  "total": 100,
  "shipments": [
    {
      "line_items": [
        {
          "brand_id": "888RED",
          "season": "Core",
          "style_number": "888",
          "color": "Red",
          "sizes": "array[OrderShipmentLineSize]"
        }
      ],
      "type": "fedex",
      "tracking_numbers": [
        "[ '1Z0000000001' ]"
      ],
      "status": "packing",
      "shipment_date": "2017-09-12 00:00:00.000Z"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string",
      "description": "The Order Number,"
    },
    "external_id": {
      "type": "string",
      "description": "External Order Number (from your system),"
    },
    "customer_po_number": {
      "type": "string",
      "description": "Customer's PO Number,"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency Code,"
    },
    "status": {
      "type": "string",
      "description": "Order Status (NuORDER, read-only field),"
    },
    "discount": {
      "type": "number",
      "description": "Discount % (0 - 100),"
    },
    "ship_start": {
      "type": "string",
      "description": "Order Ship Start,"
    },
    "ship_end": {
      "type": "string",
      "description": "Order Ship End,"
    },
    "rep_code": {
      "type": "string",
      "description": "Sales rep code,"
    },
    "rep_email": {
      "type": "string",
      "description": "Sales rep email,"
    },
    "notes": {
      "type": "string",
      "description": "Order note,"
    },
    "use_advanced_promotions": {
      "type": "boolean",
      "description": "Prices are taken from API and promotions are calculated by the NuORDER platform,"
    },
    "billing_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Billing address,"
    },
    "shipping_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Shipping address,"
    },
    "retailer": {
      "type": "object",
      "properties": {
        "retailer_code": {
          "type": "string",
          "description": "The customer code"
        },
        "buyer_email": {
          "type": "string",
          "description": "The buyer email (must exist in NuORDER)"
        }
      },
      "required": [
        "retailer_code",
        "buyer_email"
      ],
      "description": "Retailer information,"
    },
    "line_items": {
      "type": "array",
      "description": "Line items,"
    },
    "order_discounts": {
      "type": "object",
      "properties": {
        "discounted_total": {
          "type": "number",
          "description": "Discounted Total,"
        },
        "original_total": {
          "type": "number",
          "description": "Original Total,"
        },
        "total_after_line_item_discount": {
          "type": "number",
          "description": "Total after Line Item Discount,"
        },
        "total_applied": {
          "type": "number",
          "description": "Total Discount Applied on Order,"
        },
        "applied": {
          "type": "array",
          "description": "Applied Discount Objects,"
        },
        "surcharge": {
          "type": "number",
          "description": "Surcharge Applied on Order,"
        },
        "company_manual_discount": {
          "type": "number",
          "description": "Company Manual Discount,"
        },
        "surcharges": {
          "type": "object",
          "properties": {
            "total_surcharge": {
              "type": "string",
              "description": "Price of all surcharges of the entity (order, line item, size) combined"
            },
            "applied": {
              "type": "array",
              "description": "Individual surcharges applied to the entity (order, line item, size)"
            }
          },
          "required": [
            "total_surcharge",
            "applied"
          ],
          "description": "Surcharges, that were accounted for the order"
        }
      },
      "description": "Order Discounts,"
    },
    "shipping_information": {
      "type": "object",
      "properties": {
        "service_type": {
          "type": "string",
          "description": "type of service"
        },
        "service_code": {
          "type": "string",
          "description": "service code"
        },
        "carrier_code": {
          "type": "string",
          "description": "carrier code"
        },
        "carrier_friendly_name": {
          "type": "string",
          "description": "carrier friendly name"
        },
        "price": {
          "type": "number",
          "description": "price displayed in the ui"
        },
        "final_amount": {
          "type": "number",
          "description": "price of shipping used for recalculation"
        }
      },
      "description": "Shipping Information,"
    },
    "total": {
      "type": "number",
      "description": "Order total,"
    },
    "shipments": {
      "type": "array",
      "description": "NuORDER shipments (read-only)"
    }
  },
  "required": [
    "order_number",
    "external_id",
    "currency_code",
    "ship_start",
    "ship_end",
    "line_items"
  ]
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
        code: 404,
        message: 'order not found'
    }

Order Intents Collection ¶

APIs for managing your Order Intents.

List Order Intents
GET`/api/order-intents/list{?id}`

Example URI

GET https://nuorder.com/api/order-intents/list?id=59e4eeca3d58e0000123a346

URI Parameters

HideShow

id: string (optional) Example: 59e4eeca3d58e0000123a346
order intent id
version: number (optional) Example: 1
version of the order intent header
retailer_id: string (optional) Example: 3491800989944512512
retailer id of the order intent header
created_on_gte: number (optional) Example: 1721857721
to get order intents greater than specified date in Timestamp in seconds
created_on_lte: number (optional) Example: 1721857721
to get order intents lower than specified date in Timestamp in seconds
status: string (optional) Example: PROCESSED
status of the order intent

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": "669e0ff2c52050408d6530a8",
    "orderIntentId": "000292",
    "assortmentId": "5f7fdf85-ea10-4459-8749-ebf7bba759a0",
    "brandId": "5efd183ee3453b58e7b608ed",
    "retailerId": "3491800989944512512",
    "createdOn": "2024-07-22T07:53:22.873Z",
    "versions": [
      {
        "_id": "669e0ff2c52050408d6530a9",
        "assortment_name": "444d746e-87ff-495b-8b13-46a47fa83f95.assort",
        "version": 1,
        "retailer_name": "QA Retailer",
        "status": "SUCCESSFUL",
        "buyer_id": "5d3f7c76e560066c9eedae0f",
        "buyer_name": "Tech Assortments",
        "ship_start": null,
        "ship_end": null,
        "currency": "USD",
        "total_cost": 0,
        "notes": "e2e cypress test 52395",
        "date_submitted": "2024-07-22T07:53:22.467Z",
        "brand_contacts": [
          "nu.tech+whiteboards03@lightspeedhq.com"
        ],
        "poi_id": "j5gv03j02hfe1mu6827v",
        "created_on": "2024-07-22T07:53:22.879Z",
        "modified_on": "2024-07-22T07:53:23.044Z",
        "items": [
          {
            "_id": "60c72b4a4de82394274b5d55",
            "product_id": "60c72b4a4de82394274b5d55",
            "wholesale_cost": 0,
            "retail_price": 0,
            "total_units": 0,
            "assortment_fields": [
              {
                "name": "us_retail",
                "value": ""
              }
            ],
            "sizes": null,
            "style_number": "455871072",
            "color": "MULTI",
            "color_code": "2WBS",
            "season": "SPRING 2022",
            "created_on": "2021-06-14T10:11:22.086Z",
            "modified_on": "2023-12-22T13:52:34.781Z"
          },
          {
            "_id": "60dfab5dcf49d49f37925355",
            "product_id": "60dfab5dcf49d49f37925355",
            "wholesale_cost": 0,
            "retail_price": 0,
            "total_units": 0,
            "assortment_fields": [
              {
                "name": "total_retail",
                "value": ""
              }
            ],
            "sizes": null,
            "style_number": "800873586",
            "color": "BLACK",
            "color_code": "2WAH",
            "season": "SPRING 2022",
            "created_on": "2021-07-03T00:12:13.055Z",
            "modified_on": "2023-08-24T20:58:41.927Z"
          }
        ]
      }
    ]
  }
]

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'id should be a string'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'id is invalid'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'version should be a number'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'retailer_id should be a string'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'created_on_gte should be in Timestamp in seconds'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'created_on_lte should be in Timestamp in seconds'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Order Intent not found'
}

Get Order Intent by Id
GET`/api/order-intent/{id}`

Example URI

GET https://nuorder.com/api/order-intent/59e4eeca3d58e0000123a346

URI Parameters

HideShow

id: string (required) Example: 59e4eeca3d58e0000123a346
order intent header id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    "_id": "687a77ce7eb16988e942a3c2",
    "order_intent_id": "000000378",
    "brand": "5f31c4762c89570b27d58b73",
    "assortment_id": "1454d01e-2168-48b3-a895-8199e44a6a1b",
    "assortment_name": "A1.assort",
    "version": 1,
    "retailer_name": "retailer name",
    "retailer_id": "1794506880379256832",
    "status": "SUCCESSFUL",
    "buyer_id": "560acd2fe751dc09091bd8b3",
    "buyer_name": "Brand buyer name",
    "ship_start": null,
    "ship_end": null,
    "company": "",
    "company_code": "",
    "company_id": "",
    "currency": "USD",
    "total_cost": 0,
    "notes": "Checking export from panel",
    "date_submitted": "2025-07-18T16:35:25.782Z",
    "brand_contacts": [
        "brand_contact@test.com"
    ],
    "poi_id": "",
    "date_modified": "2025-07-18T16:35:27.096Z",
    "created_on": "2025-07-18T16:35:26.846Z",
    "modified_on": "2025-07-18T16:35:27.096Z",
    "items": [
        {
            "_id": "687a77cf7eb16988e942a3c4",
            "retail_price": 0,
            "total_units": 12,
            "wholesale_cost": 0,
            "product_id": "5f31d6b783c29c62b1c1a475",
            "style_number": "CC902205043",
            "brand_id": "",
            "season": "s21",
            "color": "neon pink",
            "color_code": "npk",
            "sizes": [
                {
                    "type": "BULK",
                    "size": "BULK",
                    "quantity": 12
                }
            ],
            "assortment_fields": [
                ...
            ]
        },
        {
            "_id": "687a77cf7eb16988e942a3c5",
            "retail_price": 0,
            "total_units": 15,
            "wholesale_cost": 0,
            "product_id": "5f31d6b783c29cfd85c1a486",
            "style_number": "CC902205043",
            "brand_id": "",
            "season": "s21",
            "color": "champagne",
            "color_code": "chmp",
            "sizes": [
                {
                    "type": "BULK",
                    "size": "BULK",
                    "quantity": 15
                }
            ],
            "assortment_fields": [
                ...
            ]
        }
    ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'id should be a string'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'id is invalid'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'version should be a number'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'retailer_id should be a string'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'created_on_gte should be in Timestamp in seconds'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'created_on_lte should be in Timestamp in seconds'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Order Intent not found'
}

Update Order Intent Header status
PATCH`/api/order-intent/{id}`

Example URI

PATCH https://nuorder.com/api/order-intent/59e4eeca3d58e0000123a346

URI Parameters

HideShow

id: string (required) Example: 59e4eeca3d58e0000123a346
order intent id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "order_intent_header_id": "5cafcc501aedea3950cf8047",
  "version": 1,
  "status": "PROCESSED"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "order_intent_header_id": {
      "type": "string",
      "description": "id of the order intent header to update"
    },
    "version": {
      "type": "number",
      "description": "version of the order intent header to update"
    },
    "status": {
      "type": "string",
      "description": "new status for order intent header"
    }
  },
  "required": [
    "status"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    'success': true,
    'message': 'Updated successfully'
}

Response 304

HideShow

Headers

Content-Type: application/json

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'id should be a string'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'id is invalid'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'order_intent_header_id should be a string'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'order_intent_header_id is invalid'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'status is required in request.body'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid status'
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'version or order_intent_header_id needs to be sent'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Order Intent not found'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Order Intent Header not found'
}

Payment Collection ¶

APIs for managing your Payments.

Payments are applied at the order_group level in NuORDER. An order_group is the aggregate of all of the orders that were submitted together (before order splitting).

In order to make a payment in NuORDER you must have two pieces of information:

order_group_id - The order group, which is stored on the Order object
payment_group_id - The payment group, which can be looked up with the order_group_id

A suggested workflow:

(1) Generally you have an order to charge against, so you would first make an API call to get the order_group_id:

GET - /api/order/{id} GET - /api/order/number/{number}

Response (order):

{
    _id: '5ab948c576618a86877056f7',
    order_number: '123456',
    order_group_id: '5ab948d476618a86877056fb',
    ...
}

(2) With the order_group_id you can call the payment-group route to get your payment_group_id:

GET - /api/order-group/{orderGroupId}/payment-group

Response (payment-group):

{
    _id: '5ab9492676618a8687705700',
    order_group_id: '5ab948d476618a86877056fb',
    ...
}

The _id in this payload is the payment_group_id you will need for all payment calls.

The following transaction types are supported by NuORDER:

authorize - Authorize a card for a specific amount
capture - Capture a previously Authorized transaction
refund - Refund a capture or a charge transaction
void - Void an Authorize transaction
charge - Charge a card without an prior Authorize transaction

Get Payment Group
GET`/api/order-group/{orderGroupId}/payment-group`

Example URI

GET https://nuorder.com/api/order-group/5aabe2b2fa217edddeaab187/payment-group

URI Parameters

HideShow

orderGroupId: string (required) Example: 5aabe2b2fa217edddeaab187
order group ID

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "5aabd8bff303cd00012e6af5",
  "payment_group_number": 135555,
  "brand": "5aabd936fa217edddeaab165",
  "order_group_id": "5aabd94bfa217edddeaab168",
  "company": "5aabd9fbfa217edddeaab16c",
  "created_by": "5aabda08fa217edddeaab172",
  "active": true,
  "currency_code": "USD",
  "status": "closed",
  "subtotal": 100,
  "total_balance": 100,
  "balance_pending": 0,
  "balance_paid": 0,
  "transactions": [
    {
      "_id": "5aabe18dfa217edddeaab17d",
      "transaction_client_token_ref": "d131dd02c5e6eec4",
      "client_invoice_ref": "INV100",
      "payment_method": "cc",
      "description": "transaction description",
      "status": "authorized",
      "authorized_amount": 100,
      "amount": 100,
      "currency_code": "USD",
      "cc": "5aabe218fa217edddeaab183",
      "card_type": "visa",
      "last_four": "1111",
      "detail": {
        "response": "{\"id\":\"1234\",\"status\":\"resolved\",\"amount\":100}",
        "ext_transaction_id": "W4kerqJarQtuMPEK87gPuVsX",
        "gateway_transaction_id": "555",
        "reject_code": "400",
        "reference_id": "5abba1f4713e9d01c39136e3"
      },
      "created_on": "2018-01-01T00:00:00.000Z",
      "modified_on": "2018-01-01T00:00:00.000Z"
    }
  ],
  "shipping_charges": [
    {
      "_id": "5aabdaeafa217edddeaab177",
      "amount": 5,
      "created_on": "2018-01-01T00:00:00.000Z"
    }
  ],
  "created_on": "2018-01-01T00:00:00.000Z",
  "modified_on": "2018-01-01T00:00:00.000Z"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "payment group ID"
    },
    "payment_group_number": {
      "type": "number",
      "description": "payment group number"
    },
    "brand": {
      "type": "string",
      "description": "brand ID"
    },
    "order_group_id": {
      "type": "string",
      "description": "order group ID"
    },
    "company": {
      "type": "string",
      "description": "company ID"
    },
    "created_by": {
      "type": "string",
      "description": "created by user ID"
    },
    "active": {
      "type": "boolean",
      "description": "payment group active status"
    },
    "currency_code": {
      "type": "string",
      "description": "payment group currency code"
    },
    "status": {
      "type": "string",
      "enum": [
        "closed"
      ],
      "description": "status"
    },
    "subtotal": {
      "type": "number",
      "description": "subtotal"
    },
    "total_balance": {
      "type": "number",
      "description": "total balance"
    },
    "balance_pending": {
      "type": "number",
      "description": "balance pending"
    },
    "balance_paid": {
      "type": "number",
      "description": "balance paid"
    },
    "transactions": {
      "type": "array",
      "description": "transactions"
    },
    "shipping_charges": {
      "type": "array",
      "description": "shipping charges"
    },
    "created_on": {
      "type": "string",
      "description": "date payment group was created"
    },
    "modified_on": {
      "type": "string",
      "description": "date payment group was last modified"
    }
  }
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Payment group not found'
}

Get Payment Orders
GET`/api/payment/orders{?since,until}`

This route allows you to query for orders by a date range & get back an object that contains the order and important payment information. It’s a convenience endpoint in theory, to hopefully make it easier to get the transaction status of orders that are ready to be fulfilled.

Please note that lastId & lastValue are used for pagination, and will be exposed as a “next” Header in the response. If there is not another page of data, this should be null.

Example URI

GET https://nuorder.com/api/payment/orders?since=1620925082343&until=1620925082343

URI Parameters

HideShow

since: number (required) Example: 1620925082343
Start date for looking for order’s “created_on” date
until: number (required) Example: 1620925082343
End date for looking for order’s “created_on” date
ship_start: 1620925082343 (number, optional) - Start date for looking for order's "ship_start" date: string (required)
ship_end: 1620925082343 (number, optional) - End date for looking for order's "ship_end" date: string (required)
status: array (optional) Example: ["pending"]
One or more valid order status strings
_id: string (optional) Example: 58bf12ef30c543013d31ef5d
Id of a specific order. Can also be array of ids
retailer: string (optional) Example: 58bf12ef30c543013d31ef5d
Will match against the retailer on a given order. Can also be an array of ids.
limit: number (optional) Example: 100
Amount of returned records (by default is 50)
lastId: string (optional) Example: 58bf12ef30c543013d31ef5d
ID of last resource fetched (used for fetching next records)
lastValue: string (optional) Example: 58bf12ef30c543013d31ef5d
value of last resource (pagination)
__populate: string (optional) Example: payments
populates the order’s allowed payment methods. Cases and array values:
1. Order cannot use payments: “payment_methods_allowed”:[]
2. order can only use credit cards: “payment_methods_allowed”:[“credit-card”]
3. order is optional to pay by credit card: “payment_methods_allowed”:[“credit-card”]
4. order is on a brand not using payments of any kind: “payment_methods_allowed”:[]

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "order_number": "12345",
  "external_id": "888888",
  "customer_po_number": "po_number",
  "currency_code": "USD",
  "status": "approved",
  "discount": 0,
  "ship_start": "2017/10/01",
  "ship_end": "2017/10/31",
  "rep_code": "555",
  "rep_email": "testrep@nuorder.com",
  "notes": "A note at the order level",
  "use_advanced_promotions": true,
  "billing_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "shipping_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "retailer": {
    "retailer_code": "777777",
    "buyer_email": "buyer@brand.com"
  },
  "line_items": [
    {
      "id": "ksadkmg",
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "discount": 0,
      "ship_start": "2017/10/01",
      "ship_end": "2017/10/31",
      "total_applied": -2,
      "original_total": 10,
      "discounted_total": 7.5122,
      "item_price_after_discount": 8,
      "subtotal": 8,
      "adjusted_wholesale_string": "$10.00",
      "retail_string": "$15.00",
      "total_adjustment": "-1.5951",
      "company_manual_discount_on_item": 0,
      "item_manual_discount_on_item": 0,
      "applied": [
        {
          "_id": "631ef10f0367f47036f86dc2",
          "name": "OrderLevelDiscount2",
          "description": "off $1",
          "discount": -13.5,
          "currency_code": "USD",
          "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
        }
      ],
      "notes": "A note at the line level",
      "warehouse": "100",
      "sizes": [
        {
          "size": "Small",
          "upc": "123456789",
          "quantity": 10,
          "units_per_pack": 2,
          "price": 25,
          "retail": 32,
          "price_precise": "25.00000",
          "original_price": 29,
          "discounts": {
            "total_discount": 12,
            "applied": [
              {
                "_id": "631ef10f0367f47036f86dc2",
                "name": "OrderLevelDiscount2",
                "description": "off $1",
                "discount": -13.5,
                "currency_code": "USD",
                "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
              }
            ]
          },
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ],
      "prebook": false,
      "surcharges": {
        "total_surcharge": "0",
        "applied": [
          {
            "name": "Setup Fee",
            "description": "Setup Fee Description",
            "price": "0",
            "currency_code": "USD",
            "price_code": "USD"
          }
        ]
      },
      "customizations": [
        {
          "id": "626af4fc76fae63e6e6174b7",
          "attribute_id": "6259bce43bb43e84f36d28d1",
          "external_id": "some string",
          "label": "Front Panel",
          "externalId": "FP",
          "type": "printed-image",
          "value_id": "5259bce43bb43e84f36d28d1",
          "value": "4630664466382748671",
          "display_value": "https://img.nuorder.com/c9lf9rkt3j8oinraci7g/serve",
          "value_key": "0",
          "print_type": "DIGITAL",
          "target": {
            "visualizer_id": "62598b4209b24a74bf3f6620",
            "destination_id": "6259bca2cc12b83b40ea8383",
            "rotation": 0
          },
          "child_attributes": [
            {}
          ],
          "image_file_name": "'image.png'",
          "image_attributes": [
            {
              "id": "626af4fc76fae63e6e6174b7",
              "attributeId": "626af4fc76fae63e6e6174b7",
              "externalId": "626af4fc76fae63e6e6174b7",
              "name": "Stitch count",
              "value": "\"8\""
            }
          ],
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ]
    }
  ],
  "order_discounts": {
    "discounted_total": 93.5,
    "original_total": 135,
    "total_after_line_item_discount": 111.5,
    "total_applied": -41.5,
    "applied": [
      {
        "_id": "631ef10f0367f47036f86dc2",
        "name": "OrderLevelDiscount2",
        "description": "off $1",
        "discount": -13.5,
        "currency_code": "USD",
        "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
      }
    ],
    "surcharge": 0,
    "company_manual_discount": 0,
    "surcharges": {
      "total_surcharge": "0",
      "applied": [
        {
          "name": "Setup Fee",
          "description": "Setup Fee Description",
          "price": "0",
          "currency_code": "USD",
          "price_code": "USD"
        }
      ]
    }
  },
  "shipping_information": {
    "service_type": "USPS Priority Mail",
    "service_code": "uspsPriorityMail",
    "carrier_code": "12345",
    "carrier_friendly_name": "United States Postal Service",
    "price": 25,
    "final_amount": 25
  },
  "total": 100,
  "shipments": [
    {
      "line_items": [
        {
          "brand_id": "888RED",
          "season": "Core",
          "style_number": "888",
          "color": "Red",
          "sizes": "array[OrderShipmentLineSize]"
        }
      ],
      "type": "fedex",
      "tracking_numbers": [
        "[ '1Z0000000001' ]"
      ],
      "status": "packing",
      "shipment_date": "2017-09-12 00:00:00.000Z"
    }
  ],
  "PaymentInformation": {
    "Attributes": {
      "_id": "5aabd8bff303cd00012e6af5",
      "payment_group_number": 135555,
      "brand": "5aabd936fa217edddeaab165",
      "order_group_id": "5aabd94bfa217edddeaab168",
      "company": "5aabd9fbfa217edddeaab16c",
      "created_by": "5aabda08fa217edddeaab172",
      "active": true,
      "currency_code": "USD",
      "status": "open",
      "subtotal": 100,
      "total_balance": 100,
      "balance_pending": 0,
      "balance_paid": 0,
      "transactions": [
        {
          "_id": "5aabe18dfa217edddeaab17d",
          "transaction_client_token_ref": "d131dd02c5e6eec4",
          "client_invoice_ref": "INV100",
          "payment_method": "cc",
          "description": "transaction description",
          "status": "authorized",
          "authorized_amount": 100,
          "amount": 100,
          "currency_code": "USD",
          "cc": "5aabe218fa217edddeaab183",
          "card_type": "visa",
          "last_four": "1111",
          "detail": {
            "response": "{\"id\":\"1234\",\"status\":\"resolved\",\"amount\":100}",
            "ext_transaction_id": "W4kerqJarQtuMPEK87gPuVsX",
            "gateway_transaction_id": "555",
            "reject_code": "400",
            "reference_id": "5abba1f4713e9d01c39136e3"
          },
          "created_on": "2018-01-01T00:00:00.000Z",
          "modified_on": "2018-01-01T00:00:00.000Z"
        }
      ],
      "shipping_charges": [
        {
          "_id": "5aabdaeafa217edddeaab177",
          "amount": 5,
          "created_on": "2018-01-01T00:00:00.000Z"
        }
      ],
      "created_on": "2018-01-01T00:00:00.000Z",
      "modified_on": "2018-01-01T00:00:00.000Z"
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string",
      "description": "The Order Number,"
    },
    "external_id": {
      "type": "string",
      "description": "External Order Number (from your system),"
    },
    "customer_po_number": {
      "type": "string",
      "description": "Customer's PO Number,"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency Code,"
    },
    "status": {
      "type": "string",
      "description": "Order Status (NuORDER, read-only field),"
    },
    "discount": {
      "type": "number",
      "description": "Discount % (0 - 100),"
    },
    "ship_start": {
      "type": "string",
      "description": "Order Ship Start,"
    },
    "ship_end": {
      "type": "string",
      "description": "Order Ship End,"
    },
    "rep_code": {
      "type": "string",
      "description": "Sales rep code,"
    },
    "rep_email": {
      "type": "string",
      "description": "Sales rep email,"
    },
    "notes": {
      "type": "string",
      "description": "Order note,"
    },
    "use_advanced_promotions": {
      "type": "boolean",
      "description": "Prices are taken from API and promotions are calculated by the NuORDER platform,"
    },
    "billing_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Billing address,"
    },
    "shipping_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Shipping address,"
    },
    "retailer": {
      "type": "object",
      "properties": {
        "retailer_code": {
          "type": "string",
          "description": "The customer code"
        },
        "buyer_email": {
          "type": "string",
          "description": "The buyer email (must exist in NuORDER)"
        }
      },
      "required": [
        "retailer_code",
        "buyer_email"
      ],
      "description": "Retailer information,"
    },
    "line_items": {
      "type": "array",
      "description": "Line items,"
    },
    "order_discounts": {
      "type": "object",
      "properties": {
        "discounted_total": {
          "type": "number",
          "description": "Discounted Total,"
        },
        "original_total": {
          "type": "number",
          "description": "Original Total,"
        },
        "total_after_line_item_discount": {
          "type": "number",
          "description": "Total after Line Item Discount,"
        },
        "total_applied": {
          "type": "number",
          "description": "Total Discount Applied on Order,"
        },
        "applied": {
          "type": "array",
          "description": "Applied Discount Objects,"
        },
        "surcharge": {
          "type": "number",
          "description": "Surcharge Applied on Order,"
        },
        "company_manual_discount": {
          "type": "number",
          "description": "Company Manual Discount,"
        },
        "surcharges": {
          "type": "object",
          "properties": {
            "total_surcharge": {
              "type": "string",
              "description": "Price of all surcharges of the entity (order, line item, size) combined"
            },
            "applied": {
              "type": "array",
              "description": "Individual surcharges applied to the entity (order, line item, size)"
            }
          },
          "required": [
            "total_surcharge",
            "applied"
          ],
          "description": "Surcharges, that were accounted for the order"
        }
      },
      "description": "Order Discounts,"
    },
    "shipping_information": {
      "type": "object",
      "properties": {
        "service_type": {
          "type": "string",
          "description": "type of service"
        },
        "service_code": {
          "type": "string",
          "description": "service code"
        },
        "carrier_code": {
          "type": "string",
          "description": "carrier code"
        },
        "carrier_friendly_name": {
          "type": "string",
          "description": "carrier friendly name"
        },
        "price": {
          "type": "number",
          "description": "price displayed in the ui"
        },
        "final_amount": {
          "type": "number",
          "description": "price of shipping used for recalculation"
        }
      },
      "description": "Shipping Information,"
    },
    "total": {
      "type": "number",
      "description": "Order total,"
    },
    "shipments": {
      "type": "array",
      "description": "NuORDER shipments (read-only)"
    },
    "PaymentInformation": {
      "type": "object",
      "properties": {
        "Attributes": {
          "type": "object",
          "properties": {
            "_id": {
              "type": "string",
              "description": "payment group ID"
            },
            "payment_group_number": {
              "type": "number",
              "description": "payment group number"
            },
            "brand": {
              "type": "string",
              "description": "brand ID"
            },
            "order_group_id": {
              "type": "string",
              "description": "order group ID"
            },
            "company": {
              "type": "string",
              "description": "company ID"
            },
            "created_by": {
              "type": "string",
              "description": "created by user ID"
            },
            "active": {
              "type": "boolean",
              "description": "payment group active status"
            },
            "currency_code": {
              "type": "string",
              "description": "payment group currency code"
            },
            "status": {
              "type": "string",
              "enum": [
                "closed"
              ],
              "description": "status"
            },
            "subtotal": {
              "type": "number",
              "description": "subtotal"
            },
            "total_balance": {
              "type": "number",
              "description": "total balance"
            },
            "balance_pending": {
              "type": "number",
              "description": "balance pending"
            },
            "balance_paid": {
              "type": "number",
              "description": "balance paid"
            },
            "transactions": {
              "type": "array",
              "description": "transactions"
            },
            "shipping_charges": {
              "type": "array",
              "description": "shipping charges"
            },
            "created_on": {
              "type": "string",
              "description": "date payment group was created"
            },
            "modified_on": {
              "type": "string",
              "description": "date payment group was last modified"
            }
          }
        }
      }
    }
  },
  "required": [
    "order_number",
    "external_id",
    "currency_code",
    "ship_start",
    "ship_end",
    "line_items"
  ]
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Payment group not found'
}

Get Payment Group by Transaction ID
GET`/api/transaction/{transactionId}/payment-group`

Example URI

GET https://nuorder.com/api/transaction/5b071eddfb972c1170aa0442/payment-group

URI Parameters

HideShow

transactionId: string (required) Example: 5b071eddfb972c1170aa0442
transaction ID

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "5aabd8bff303cd00012e6af5",
  "payment_group_number": 135555,
  "brand": "5aabd936fa217edddeaab165",
  "order_group_id": "5aabd94bfa217edddeaab168",
  "company": "5aabd9fbfa217edddeaab16c",
  "created_by": "5aabda08fa217edddeaab172",
  "active": true,
  "currency_code": "USD",
  "status": "closed",
  "subtotal": 100,
  "total_balance": 100,
  "balance_pending": 0,
  "balance_paid": 0,
  "transactions": [
    {
      "_id": "5aabe18dfa217edddeaab17d",
      "transaction_client_token_ref": "d131dd02c5e6eec4",
      "client_invoice_ref": "INV100",
      "payment_method": "cc",
      "description": "transaction description",
      "status": "authorized",
      "authorized_amount": 100,
      "amount": 100,
      "currency_code": "USD",
      "cc": "5aabe218fa217edddeaab183",
      "card_type": "visa",
      "last_four": "1111",
      "detail": {
        "response": "{\"id\":\"1234\",\"status\":\"resolved\",\"amount\":100}",
        "ext_transaction_id": "W4kerqJarQtuMPEK87gPuVsX",
        "gateway_transaction_id": "555",
        "reject_code": "400",
        "reference_id": "5abba1f4713e9d01c39136e3"
      },
      "created_on": "2018-01-01T00:00:00.000Z",
      "modified_on": "2018-01-01T00:00:00.000Z"
    }
  ],
  "shipping_charges": [
    {
      "_id": "5aabdaeafa217edddeaab177",
      "amount": 5,
      "created_on": "2018-01-01T00:00:00.000Z"
    }
  ],
  "created_on": "2018-01-01T00:00:00.000Z",
  "modified_on": "2018-01-01T00:00:00.000Z"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "payment group ID"
    },
    "payment_group_number": {
      "type": "number",
      "description": "payment group number"
    },
    "brand": {
      "type": "string",
      "description": "brand ID"
    },
    "order_group_id": {
      "type": "string",
      "description": "order group ID"
    },
    "company": {
      "type": "string",
      "description": "company ID"
    },
    "created_by": {
      "type": "string",
      "description": "created by user ID"
    },
    "active": {
      "type": "boolean",
      "description": "payment group active status"
    },
    "currency_code": {
      "type": "string",
      "description": "payment group currency code"
    },
    "status": {
      "type": "string",
      "enum": [
        "closed"
      ],
      "description": "status"
    },
    "subtotal": {
      "type": "number",
      "description": "subtotal"
    },
    "total_balance": {
      "type": "number",
      "description": "total balance"
    },
    "balance_pending": {
      "type": "number",
      "description": "balance pending"
    },
    "balance_paid": {
      "type": "number",
      "description": "balance paid"
    },
    "transactions": {
      "type": "array",
      "description": "transactions"
    },
    "shipping_charges": {
      "type": "array",
      "description": "shipping charges"
    },
    "created_on": {
      "type": "string",
      "description": "date payment group was created"
    },
    "modified_on": {
      "type": "string",
      "description": "date payment group was last modified"
    }
  }
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Payment group not found'
}

Get Payment Group Balance
GET`/api/payment/{paymentGroupId}/balance`

Example URI

GET https://nuorder.com/api/payment/5aabd2c3fa217edddeaab162/balance

URI Parameters

HideShow

paymentGroupId: string (required) Example: 5aabd2c3fa217edddeaab162
payment group ID

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    amount: 200,
    currency_code: 'USD'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
        code: 404,
        message: 'Payment group not found'
    }

Get Credit Card External Tokens
GET`/api/payment/credit-card/{creditCardId}/external-tokens`

Get external tokens for a particular credit card.

Example URI

GET https://nuorder.com/api/payment/credit-card/5aabd2c3fa217edddeaab162/external-tokens

URI Parameters

HideShow

creditCardId: string (required) Example: 5aabd2c3fa217edddeaab162
credit card ID

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "5aabe18dfa217edddeaab17d",
  "card_type": "visa",
  "last_four": "1111",
  "external_tokens": [
    {
      "gateway": {
        "_id": "W4kerqJarQtuMPEK87gPuVsX",
        "name": "Spreedly",
        "description": "Testing gateway",
        "currency_code": "USD"
      },
      "external_token": "W4kerqJarQtuMPEK87gPuVsX"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "card ID"
    },
    "card_type": {
      "type": "string",
      "description": "card type"
    },
    "last_four": {
      "type": "string",
      "description": "card last 4 digits"
    },
    "external_tokens": {
      "type": "array",
      "description": "external tokens"
    }
  }
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Credit card not found'
}

Authorize Transaction
POST`/api/payment/{paymentGroupId}/authorize`

As of May 26th, 2021, in order to address brand headaches related to bad cards/missing cards on orders, if this endpoint is called without a valid “nuorder_card_id” in the request body, we will assume it means no card is on the order, and trigger a “SendPaymentDue” email to the buyer.

In addition, if the authorization fails, we will also trigger that email. See “SendPaymentDue” endpoint for more information.

Example URI

POST https://nuorder.com/api/payment/5aabd2c3fa217edddeaab162/authorize

URI Parameters

HideShow

paymentGroupId: string (required) Example: 5aabd2c3fa217edddeaab162
payment group ID

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "transaction_client_token_ref": "d131dd02c5e6eec4",
  "client_invoice_ref": "INV100",
  "nuorder_payment_account_id": "5aff1f0ffd7a29cb53421390",
  "nuorder_card_id": "5aabd0fafa217edddeaab15b",
  "amount": 100,
  "currency_code": "USD",
  "description": "Authorize for $100.00"
}

Schema

{
  "type": "object",
  "properties": {
    "transaction_client_token_ref": {
      "type": "string",
      "description": "client unique transaction identifier"
    },
    "client_invoice_ref": {
      "type": "string",
      "description": "client invoice number"
    },
    "nuorder_payment_account_id": {
      "type": "string",
      "description": "payment account ID"
    },
    "nuorder_card_id": {
      "type": "string",
      "description": "credit card ID"
    },
    "amount": {
      "type": "number",
      "description": "transaction amount"
    },
    "currency_code": {
      "type": "string",
      "description": "transaction currency code"
    },
    "description": {
      "type": "string",
      "description": "transaction description"
    }
  },
  "required": [
    "transaction_client_token_ref",
    "nuorder_card_id",
    "amount",
    "currency_code",
    "description"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "5aabe18dfa217edddeaab17d",
  "transaction_client_token_ref": "d131dd02c5e6eec4",
  "client_invoice_ref": "INV100",
  "payment_method": "cc",
  "description": "transaction description",
  "status": "authorized",
  "authorized_amount": 100,
  "amount": 100,
  "currency_code": "USD",
  "cc": "5aabe218fa217edddeaab183",
  "card_type": "visa",
  "last_four": "1111",
  "detail": {
    "response": "{\"id\":\"1234\",\"status\":\"resolved\",\"amount\":100}",
    "ext_transaction_id": "W4kerqJarQtuMPEK87gPuVsX",
    "gateway_transaction_id": "555",
    "reject_code": "400",
    "reference_id": "5abba1f4713e9d01c39136e3"
  },
  "created_on": "2018-01-01T00:00:00.000Z",
  "modified_on": "2018-01-01T00:00:00.000Z"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "transaction ID"
    },
    "transaction_client_token_ref": {
      "type": "string",
      "description": "client transaction token ref"
    },
    "client_invoice_ref": {
      "type": "string",
      "description": "client invoice number"
    },
    "payment_method": {
      "type": "string",
      "enum": [
        "cc"
      ],
      "description": "payment method"
    },
    "description": {
      "type": "string",
      "description": "transaction description"
    },
    "status": {
      "type": "string",
      "description": "status"
    },
    "authorized_amount": {
      "type": "number",
      "description": "authorized amount"
    },
    "amount": {
      "type": "number",
      "description": "amount"
    },
    "currency_code": {
      "type": "string",
      "description": "currency code"
    },
    "cc": {
      "type": "string",
      "description": "card ID"
    },
    "card_type": {
      "type": "string",
      "description": "card type"
    },
    "last_four": {
      "type": "string",
      "description": "card last 4 digits"
    },
    "detail": {
      "type": "object",
      "properties": {
        "response": {
          "type": "string",
          "description": "JSON response from gateway"
        },
        "ext_transaction_id": {
          "type": "string",
          "description": "external transaction ID"
        },
        "gateway_transaction_id": {
          "type": "string",
          "description": "gateway transaction ID"
        },
        "reject_code": {
          "type": "string",
          "description": "reject code"
        },
        "reference_id": {
          "type": "string",
          "description": "reference id"
        }
      },
      "description": "transaction details"
    },
    "created_on": {
      "type": "string",
      "description": "date transaction was created"
    },
    "modified_on": {
      "type": "string",
      "description": "date transaction was last modified"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Missing or invalid fields'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
        code: 404,
        message: 'Payment group not found'
    }

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
        code: 404,
        message: 'Payment account not found'
    }

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
    code: 409,
    message: 'Transaction with this transaction_client_token_ref has already been created'
}

Charge Transaction
POST`/api/payment/{paymentGroupId}/charge`

Example URI

POST https://nuorder.com/api/payment/5aabd2c3fa217edddeaab162/charge

URI Parameters

HideShow

paymentGroupId: string (required) Example: 5aabd2c3fa217edddeaab162
payment group ID

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "transaction_client_token_ref": "d131dd02c5e6eec4",
  "client_invoice_ref": "INV100",
  "nuorder_payment_account_id": "5aff1f0ffd7a29cb53421390",
  "nuorder_card_id": "5aabd0fafa217edddeaab15b",
  "amount": 100,
  "currency_code": "USD",
  "description": "Charge for $100.00"
}

Schema

{
  "type": "object",
  "properties": {
    "transaction_client_token_ref": {
      "type": "string",
      "description": "client unique transaction identifier"
    },
    "client_invoice_ref": {
      "type": "string",
      "description": "client invoice number"
    },
    "nuorder_payment_account_id": {
      "type": "string",
      "description": "payment account ID"
    },
    "nuorder_card_id": {
      "type": "string",
      "description": "credit card ID"
    },
    "amount": {
      "type": "number",
      "description": "transaction amount"
    },
    "currency_code": {
      "type": "string",
      "description": "transaction currency code"
    },
    "description": {
      "type": "string",
      "description": "transaction description"
    }
  },
  "required": [
    "transaction_client_token_ref",
    "nuorder_card_id",
    "amount",
    "currency_code",
    "description"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "5aabe18dfa217edddeaab17d",
  "transaction_client_token_ref": "d131dd02c5e6eec4",
  "client_invoice_ref": "INV100",
  "payment_method": "cc",
  "description": "transaction description",
  "status": "authorized",
  "authorized_amount": 100,
  "amount": 100,
  "currency_code": "USD",
  "cc": "5aabe218fa217edddeaab183",
  "card_type": "visa",
  "last_four": "1111",
  "detail": {
    "response": "{\"id\":\"1234\",\"status\":\"resolved\",\"amount\":100}",
    "ext_transaction_id": "W4kerqJarQtuMPEK87gPuVsX",
    "gateway_transaction_id": "555",
    "reject_code": "400",
    "reference_id": "5abba1f4713e9d01c39136e3"
  },
  "created_on": "2018-01-01T00:00:00.000Z",
  "modified_on": "2018-01-01T00:00:00.000Z"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "transaction ID"
    },
    "transaction_client_token_ref": {
      "type": "string",
      "description": "client transaction token ref"
    },
    "client_invoice_ref": {
      "type": "string",
      "description": "client invoice number"
    },
    "payment_method": {
      "type": "string",
      "enum": [
        "cc"
      ],
      "description": "payment method"
    },
    "description": {
      "type": "string",
      "description": "transaction description"
    },
    "status": {
      "type": "string",
      "description": "status"
    },
    "authorized_amount": {
      "type": "number",
      "description": "authorized amount"
    },
    "amount": {
      "type": "number",
      "description": "amount"
    },
    "currency_code": {
      "type": "string",
      "description": "currency code"
    },
    "cc": {
      "type": "string",
      "description": "card ID"
    },
    "card_type": {
      "type": "string",
      "description": "card type"
    },
    "last_four": {
      "type": "string",
      "description": "card last 4 digits"
    },
    "detail": {
      "type": "object",
      "properties": {
        "response": {
          "type": "string",
          "description": "JSON response from gateway"
        },
        "ext_transaction_id": {
          "type": "string",
          "description": "external transaction ID"
        },
        "gateway_transaction_id": {
          "type": "string",
          "description": "gateway transaction ID"
        },
        "reject_code": {
          "type": "string",
          "description": "reject code"
        },
        "reference_id": {
          "type": "string",
          "description": "reference id"
        }
      },
      "description": "transaction details"
    },
    "created_on": {
      "type": "string",
      "description": "date transaction was created"
    },
    "modified_on": {
      "type": "string",
      "description": "date transaction was last modified"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Missing or invalid fields'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Payment group not found'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Payment account not found'
}

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
    code: 409,
    message: 'Transaction with this transaction_client_token_ref has already been created'
}

Capture Transaction
POST`/api/payment/{paymentGroupId}/capture/{transactionId}`

Capture an existing Authorization transaction.

As of May 26th 2021, if the capture is rejected by the credit card processor, we will also automatically trigger a “SendPaymentDue” email directly to the buyer to request payment.

Example URI

POST https://nuorder.com/api/payment/5aabd2c3fa217edddeaab162/capture/5aac22dffa217edddeaab188

URI Parameters

HideShow

paymentGroupId: string (required) Example: 5aabd2c3fa217edddeaab162
payment group ID
transactionId: string (required) Example: 5aac22dffa217edddeaab188
authorization transaction ID to capture

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "transaction_client_token_ref": "d131dd02c5e6eec4",
  "client_invoice_ref": "INV100",
  "amount": 100,
  "currency_code": "USD",
  "description": "Capture for $100.00"
}

Schema

{
  "type": "object",
  "properties": {
    "transaction_client_token_ref": {
      "type": "string",
      "description": "client unique transaction identifier"
    },
    "client_invoice_ref": {
      "type": "string",
      "description": "client invoice number"
    },
    "amount": {
      "type": "number",
      "description": "transaction amount"
    },
    "currency_code": {
      "type": "string",
      "description": "transaction currency code"
    },
    "description": {
      "type": "string",
      "description": "transaction description"
    }
  },
  "required": [
    "transaction_client_token_ref",
    "amount",
    "currency_code",
    "description"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "5aabe18dfa217edddeaab17d",
  "transaction_client_token_ref": "d131dd02c5e6eec4",
  "client_invoice_ref": "INV100",
  "payment_method": "cc",
  "description": "transaction description",
  "status": "authorized",
  "authorized_amount": 100,
  "amount": 100,
  "currency_code": "USD",
  "cc": "5aabe218fa217edddeaab183",
  "card_type": "visa",
  "last_four": "1111",
  "detail": {
    "response": "{\"id\":\"1234\",\"status\":\"resolved\",\"amount\":100}",
    "ext_transaction_id": "W4kerqJarQtuMPEK87gPuVsX",
    "gateway_transaction_id": "555",
    "reject_code": "400",
    "reference_id": "5abba1f4713e9d01c39136e3"
  },
  "created_on": "2018-01-01T00:00:00.000Z",
  "modified_on": "2018-01-01T00:00:00.000Z"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "transaction ID"
    },
    "transaction_client_token_ref": {
      "type": "string",
      "description": "client transaction token ref"
    },
    "client_invoice_ref": {
      "type": "string",
      "description": "client invoice number"
    },
    "payment_method": {
      "type": "string",
      "enum": [
        "cc"
      ],
      "description": "payment method"
    },
    "description": {
      "type": "string",
      "description": "transaction description"
    },
    "status": {
      "type": "string",
      "description": "status"
    },
    "authorized_amount": {
      "type": "number",
      "description": "authorized amount"
    },
    "amount": {
      "type": "number",
      "description": "amount"
    },
    "currency_code": {
      "type": "string",
      "description": "currency code"
    },
    "cc": {
      "type": "string",
      "description": "card ID"
    },
    "card_type": {
      "type": "string",
      "description": "card type"
    },
    "last_four": {
      "type": "string",
      "description": "card last 4 digits"
    },
    "detail": {
      "type": "object",
      "properties": {
        "response": {
          "type": "string",
          "description": "JSON response from gateway"
        },
        "ext_transaction_id": {
          "type": "string",
          "description": "external transaction ID"
        },
        "gateway_transaction_id": {
          "type": "string",
          "description": "gateway transaction ID"
        },
        "reject_code": {
          "type": "string",
          "description": "reject code"
        },
        "reference_id": {
          "type": "string",
          "description": "reference id"
        }
      },
      "description": "transaction details"
    },
    "created_on": {
      "type": "string",
      "description": "date transaction was created"
    },
    "modified_on": {
      "type": "string",
      "description": "date transaction was last modified"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Missing or invalid fields'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
        code: 404,
        message: 'Payment group not found'
    }

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
        code: 404,
        message: 'Transaction not found'
    }

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
        code: 409,
        message: 'Transaction with this transaction_client_token_ref has already been created'
    }

Refund Transaction
POST`/api/payment/{paymentGroupId}/refund/{transactionId}`

Refund an existing Capture or Charge transaction.

Example URI

POST https://nuorder.com/api/payment/5aabd2c3fa217edddeaab162/refund/5aac22dffa217edddeaab188

URI Parameters

HideShow

paymentGroupId: string (required) Example: 5aabd2c3fa217edddeaab162
payment group ID
transactionId: string (required) Example: 5aac22dffa217edddeaab188
authorization transaction ID to capture

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Body

{
  "transaction_client_token_ref": "d131dd02c5e6eec4",
  "client_invoice_ref": "INV100",
  "amount": 100,
  "currency_code": "USD",
  "description": "Refund for $100.00"
}

Schema

{
  "type": "object",
  "properties": {
    "transaction_client_token_ref": {
      "type": "string",
      "description": "client unique transaction identifier"
    },
    "client_invoice_ref": {
      "type": "string",
      "description": "client invoice number"
    },
    "amount": {
      "type": "number",
      "description": "transaction amount"
    },
    "currency_code": {
      "type": "string",
      "description": "transaction currency code"
    },
    "description": {
      "type": "string",
      "description": "transaction description"
    }
  },
  "required": [
    "transaction_client_token_ref",
    "amount",
    "currency_code",
    "description"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "5aabe18dfa217edddeaab17d",
  "transaction_client_token_ref": "d131dd02c5e6eec4",
  "client_invoice_ref": "INV100",
  "payment_method": "cc",
  "description": "transaction description",
  "status": "authorized",
  "authorized_amount": 100,
  "amount": 100,
  "currency_code": "USD",
  "cc": "5aabe218fa217edddeaab183",
  "card_type": "visa",
  "last_four": "1111",
  "detail": {
    "response": "{\"id\":\"1234\",\"status\":\"resolved\",\"amount\":100}",
    "ext_transaction_id": "W4kerqJarQtuMPEK87gPuVsX",
    "gateway_transaction_id": "555",
    "reject_code": "400",
    "reference_id": "5abba1f4713e9d01c39136e3"
  },
  "created_on": "2018-01-01T00:00:00.000Z",
  "modified_on": "2018-01-01T00:00:00.000Z"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "transaction ID"
    },
    "transaction_client_token_ref": {
      "type": "string",
      "description": "client transaction token ref"
    },
    "client_invoice_ref": {
      "type": "string",
      "description": "client invoice number"
    },
    "payment_method": {
      "type": "string",
      "enum": [
        "cc"
      ],
      "description": "payment method"
    },
    "description": {
      "type": "string",
      "description": "transaction description"
    },
    "status": {
      "type": "string",
      "description": "status"
    },
    "authorized_amount": {
      "type": "number",
      "description": "authorized amount"
    },
    "amount": {
      "type": "number",
      "description": "amount"
    },
    "currency_code": {
      "type": "string",
      "description": "currency code"
    },
    "cc": {
      "type": "string",
      "description": "card ID"
    },
    "card_type": {
      "type": "string",
      "description": "card type"
    },
    "last_four": {
      "type": "string",
      "description": "card last 4 digits"
    },
    "detail": {
      "type": "object",
      "properties": {
        "response": {
          "type": "string",
          "description": "JSON response from gateway"
        },
        "ext_transaction_id": {
          "type": "string",
          "description": "external transaction ID"
        },
        "gateway_transaction_id": {
          "type": "string",
          "description": "gateway transaction ID"
        },
        "reject_code": {
          "type": "string",
          "description": "reject code"
        },
        "reference_id": {
          "type": "string",
          "description": "reference id"
        }
      },
      "description": "transaction details"
    },
    "created_on": {
      "type": "string",
      "description": "date transaction was created"
    },
    "modified_on": {
      "type": "string",
      "description": "date transaction was last modified"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Missing or invalid fields'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
        code: 404,
        message: 'Payment group not found'
    }

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
        code: 404,
        message: 'Transaction not found'
    }

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
        code: 409,
        message: 'Transaction with this transaction_client_token_ref has already been created'
    }

Void Transaction
DELETE`/api/payment/{paymentGroupId}/void/{transactionId}`

Void an existing Authorization transaction.

Example URI

DELETE https://nuorder.com/api/payment/5aabd2c3fa217edddeaab162/void/5aac22dffa217edddeaab188

URI Parameters

HideShow

paymentGroupId: string (required) Example: 5aabd2c3fa217edddeaab162
payment group ID
transactionId: string (required) Example: 5aac22dffa217edddeaab188
authorization transaction ID to void

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "5aabe18dfa217edddeaab17d",
  "transaction_client_token_ref": "d131dd02c5e6eec4",
  "client_invoice_ref": "INV100",
  "payment_method": "cc",
  "description": "transaction description",
  "status": "authorized",
  "authorized_amount": 100,
  "amount": 100,
  "currency_code": "USD",
  "cc": "5aabe218fa217edddeaab183",
  "card_type": "visa",
  "last_four": "1111",
  "detail": {
    "response": "{\"id\":\"1234\",\"status\":\"resolved\",\"amount\":100}",
    "ext_transaction_id": "W4kerqJarQtuMPEK87gPuVsX",
    "gateway_transaction_id": "555",
    "reject_code": "400",
    "reference_id": "5abba1f4713e9d01c39136e3"
  },
  "created_on": "2018-01-01T00:00:00.000Z",
  "modified_on": "2018-01-01T00:00:00.000Z"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "transaction ID"
    },
    "transaction_client_token_ref": {
      "type": "string",
      "description": "client transaction token ref"
    },
    "client_invoice_ref": {
      "type": "string",
      "description": "client invoice number"
    },
    "payment_method": {
      "type": "string",
      "enum": [
        "cc"
      ],
      "description": "payment method"
    },
    "description": {
      "type": "string",
      "description": "transaction description"
    },
    "status": {
      "type": "string",
      "description": "status"
    },
    "authorized_amount": {
      "type": "number",
      "description": "authorized amount"
    },
    "amount": {
      "type": "number",
      "description": "amount"
    },
    "currency_code": {
      "type": "string",
      "description": "currency code"
    },
    "cc": {
      "type": "string",
      "description": "card ID"
    },
    "card_type": {
      "type": "string",
      "description": "card type"
    },
    "last_four": {
      "type": "string",
      "description": "card last 4 digits"
    },
    "detail": {
      "type": "object",
      "properties": {
        "response": {
          "type": "string",
          "description": "JSON response from gateway"
        },
        "ext_transaction_id": {
          "type": "string",
          "description": "external transaction ID"
        },
        "gateway_transaction_id": {
          "type": "string",
          "description": "gateway transaction ID"
        },
        "reject_code": {
          "type": "string",
          "description": "reject code"
        },
        "reference_id": {
          "type": "string",
          "description": "reference id"
        }
      },
      "description": "transaction details"
    },
    "created_on": {
      "type": "string",
      "description": "date transaction was created"
    },
    "modified_on": {
      "type": "string",
      "description": "date transaction was last modified"
    }
  }
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Payment group not found'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Transaction not found'
}

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
    code: 409,
    message: 'Transaction with this transaction_client_token_ref has already been created'
}

Send Payment Due
POST`/api/order/:id/send-payment-due-email`

This route enables you to trigger an email to the buyer requesting payment for the order specified.

There are a couple of requirements for an order to be considered “needing payment”: 1. Order must be whitelisted for payments - you can make credit card transactions on the order 2. Order’s payment status must be either ‘Not Paid’ or ‘Partial Payment’ 3. Order cannot be a draft, ez-order, or cancelled 4. Ship start on the order is at least 24 hours in the past

In addition, out of respect to buyers’ email inboxes, we can only send this email 1 time per order per day. You will receive a 404 if you attempt to re-trigger the email more than once per day per order.

Example URI

POST https://nuorder.com/api/order/:id/send-payment-due-email

URI Parameters

HideShow

id: string (required) Example: 5aabd2c3fa217edddeaab162
order id

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "order_number": "12345",
  "external_id": "888888",
  "customer_po_number": "po_number",
  "currency_code": "USD",
  "status": "approved",
  "discount": 0,
  "ship_start": "2017/10/01",
  "ship_end": "2017/10/31",
  "rep_code": "555",
  "rep_email": "testrep@nuorder.com",
  "notes": "A note at the order level",
  "use_advanced_promotions": true,
  "billing_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "shipping_address": {
    "code": "123",
    "line_1": "444 Testing Lane",
    "line_2": "Suite C",
    "city": "Atlanta",
    "state": "GA",
    "zip": "30345",
    "country": "US"
  },
  "retailer": {
    "retailer_code": "777777",
    "buyer_email": "buyer@brand.com"
  },
  "line_items": [
    {
      "id": "ksadkmg",
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "discount": 0,
      "ship_start": "2017/10/01",
      "ship_end": "2017/10/31",
      "total_applied": -2,
      "original_total": 10,
      "discounted_total": 7.5122,
      "item_price_after_discount": 8,
      "subtotal": 8,
      "adjusted_wholesale_string": "$10.00",
      "retail_string": "$15.00",
      "total_adjustment": "-1.5951",
      "company_manual_discount_on_item": 0,
      "item_manual_discount_on_item": 0,
      "applied": [
        {
          "_id": "631ef10f0367f47036f86dc2",
          "name": "OrderLevelDiscount2",
          "description": "off $1",
          "discount": -13.5,
          "currency_code": "USD",
          "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
        }
      ],
      "notes": "A note at the line level",
      "warehouse": "100",
      "sizes": [
        {
          "size": "Small",
          "upc": "123456789",
          "quantity": 10,
          "units_per_pack": 2,
          "price": 25,
          "retail": 32,
          "price_precise": "25.00000",
          "original_price": 29,
          "discounts": {
            "total_discount": 12,
            "applied": [
              {
                "_id": "631ef10f0367f47036f86dc2",
                "name": "OrderLevelDiscount2",
                "description": "off $1",
                "discount": -13.5,
                "currency_code": "USD",
                "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
              }
            ]
          },
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ],
      "prebook": false,
      "surcharges": {
        "total_surcharge": "0",
        "applied": [
          {
            "name": "Setup Fee",
            "description": "Setup Fee Description",
            "price": "0",
            "currency_code": "USD",
            "price_code": "USD"
          }
        ]
      },
      "customizations": [
        {
          "id": "626af4fc76fae63e6e6174b7",
          "attribute_id": "6259bce43bb43e84f36d28d1",
          "external_id": "some string",
          "label": "Front Panel",
          "externalId": "FP",
          "type": "printed-image",
          "value_id": "5259bce43bb43e84f36d28d1",
          "value": "4630664466382748671",
          "display_value": "https://img.nuorder.com/c9lf9rkt3j8oinraci7g/serve",
          "value_key": "0",
          "print_type": "DIGITAL",
          "target": {
            "visualizer_id": "62598b4209b24a74bf3f6620",
            "destination_id": "6259bca2cc12b83b40ea8383",
            "rotation": 0
          },
          "child_attributes": [
            {}
          ],
          "image_file_name": "'image.png'",
          "image_attributes": [
            {
              "id": "626af4fc76fae63e6e6174b7",
              "attributeId": "626af4fc76fae63e6e6174b7",
              "externalId": "626af4fc76fae63e6e6174b7",
              "name": "Stitch count",
              "value": "\"8\""
            }
          ],
          "surcharges": {
            "total_surcharge": "0",
            "applied": [
              {
                "name": "Setup Fee",
                "description": "Setup Fee Description",
                "price": "0",
                "currency_code": "USD",
                "price_code": "USD"
              }
            ]
          }
        }
      ]
    }
  ],
  "order_discounts": {
    "discounted_total": 93.5,
    "original_total": 135,
    "total_after_line_item_discount": 111.5,
    "total_applied": -41.5,
    "applied": [
      {
        "_id": "631ef10f0367f47036f86dc2",
        "name": "OrderLevelDiscount2",
        "description": "off $1",
        "discount": -13.5,
        "currency_code": "USD",
        "price_code": "c7229d8a-2c35-4734-9a8d-bbaa55b039fe"
      }
    ],
    "surcharge": 0,
    "company_manual_discount": 0,
    "surcharges": {
      "total_surcharge": "0",
      "applied": [
        {
          "name": "Setup Fee",
          "description": "Setup Fee Description",
          "price": "0",
          "currency_code": "USD",
          "price_code": "USD"
        }
      ]
    }
  },
  "shipping_information": {
    "service_type": "USPS Priority Mail",
    "service_code": "uspsPriorityMail",
    "carrier_code": "12345",
    "carrier_friendly_name": "United States Postal Service",
    "price": 25,
    "final_amount": 25
  },
  "total": 100,
  "shipments": [
    {
      "line_items": [
        {
          "brand_id": "888RED",
          "season": "Core",
          "style_number": "888",
          "color": "Red",
          "sizes": "array[OrderShipmentLineSize]"
        }
      ],
      "type": "fedex",
      "tracking_numbers": [
        "[ '1Z0000000001' ]"
      ],
      "status": "packing",
      "shipment_date": "2017-09-12 00:00:00.000Z"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "order_number": {
      "type": "string",
      "description": "The Order Number,"
    },
    "external_id": {
      "type": "string",
      "description": "External Order Number (from your system),"
    },
    "customer_po_number": {
      "type": "string",
      "description": "Customer's PO Number,"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency Code,"
    },
    "status": {
      "type": "string",
      "description": "Order Status (NuORDER, read-only field),"
    },
    "discount": {
      "type": "number",
      "description": "Discount % (0 - 100),"
    },
    "ship_start": {
      "type": "string",
      "description": "Order Ship Start,"
    },
    "ship_end": {
      "type": "string",
      "description": "Order Ship End,"
    },
    "rep_code": {
      "type": "string",
      "description": "Sales rep code,"
    },
    "rep_email": {
      "type": "string",
      "description": "Sales rep email,"
    },
    "notes": {
      "type": "string",
      "description": "Order note,"
    },
    "use_advanced_promotions": {
      "type": "boolean",
      "description": "Prices are taken from API and promotions are calculated by the NuORDER platform,"
    },
    "billing_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Billing address,"
    },
    "shipping_address": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "The Address ID"
        },
        "line_1": {
          "type": "string",
          "description": "The Address Line 1"
        },
        "line_2": {
          "type": "string",
          "description": "The Address Line 2"
        },
        "city": {
          "type": "string",
          "description": "The Address City"
        },
        "state": {
          "type": "string",
          "description": "The Address State"
        },
        "zip": {
          "type": "string",
          "description": "The Address Zip"
        },
        "country": {
          "type": "string",
          "description": "The Address Country"
        }
      },
      "description": "Shipping address,"
    },
    "retailer": {
      "type": "object",
      "properties": {
        "retailer_code": {
          "type": "string",
          "description": "The customer code"
        },
        "buyer_email": {
          "type": "string",
          "description": "The buyer email (must exist in NuORDER)"
        }
      },
      "required": [
        "retailer_code",
        "buyer_email"
      ],
      "description": "Retailer information,"
    },
    "line_items": {
      "type": "array",
      "description": "Line items,"
    },
    "order_discounts": {
      "type": "object",
      "properties": {
        "discounted_total": {
          "type": "number",
          "description": "Discounted Total,"
        },
        "original_total": {
          "type": "number",
          "description": "Original Total,"
        },
        "total_after_line_item_discount": {
          "type": "number",
          "description": "Total after Line Item Discount,"
        },
        "total_applied": {
          "type": "number",
          "description": "Total Discount Applied on Order,"
        },
        "applied": {
          "type": "array",
          "description": "Applied Discount Objects,"
        },
        "surcharge": {
          "type": "number",
          "description": "Surcharge Applied on Order,"
        },
        "company_manual_discount": {
          "type": "number",
          "description": "Company Manual Discount,"
        },
        "surcharges": {
          "type": "object",
          "properties": {
            "total_surcharge": {
              "type": "string",
              "description": "Price of all surcharges of the entity (order, line item, size) combined"
            },
            "applied": {
              "type": "array",
              "description": "Individual surcharges applied to the entity (order, line item, size)"
            }
          },
          "required": [
            "total_surcharge",
            "applied"
          ],
          "description": "Surcharges, that were accounted for the order"
        }
      },
      "description": "Order Discounts,"
    },
    "shipping_information": {
      "type": "object",
      "properties": {
        "service_type": {
          "type": "string",
          "description": "type of service"
        },
        "service_code": {
          "type": "string",
          "description": "service code"
        },
        "carrier_code": {
          "type": "string",
          "description": "carrier code"
        },
        "carrier_friendly_name": {
          "type": "string",
          "description": "carrier friendly name"
        },
        "price": {
          "type": "number",
          "description": "price displayed in the ui"
        },
        "final_amount": {
          "type": "number",
          "description": "price of shipping used for recalculation"
        }
      },
      "description": "Shipping Information,"
    },
    "total": {
      "type": "number",
      "description": "Order total,"
    },
    "shipments": {
      "type": "array",
      "description": "NuORDER shipments (read-only)"
    }
  },
  "required": [
    "order_number",
    "external_id",
    "currency_code",
    "ship_start",
    "ship_end",
    "line_items"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Invalid orderId'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'No valid order found'
}

Get Deposited Transactions
GET`/api/v3.0/transactions/deposits/account/:accountId{?transaction_date_gte,transaction_date_lte}`

For Brands using NuORDER Payments, you have the ability to fetch deposited transactions, similar to what we display current in the Daily Deposited Transactions screen.

Please note we currently have a strict limit of 100 records max returned by a single request.

A note on the response object itself – NuORDER Payments contains additional information on a transaction that you would get normally, so there are many attributes you likely don’t care about (for example, “e_check”). So, to make things a little easier, here are common, useful attributes:

authorization_amount - if transaction was an authorization, the amount authorized.
transaction_amount - the amount of the transaction (refund, capture, charge, etc). This is returned as a float, so for example, if transaction was for $5.00, you would see 5.00
total_fees - The total of all fees. This is returned as a float, so for example, if the fees were for $5.00, you would see 5.00
net_amount - this is the gross amount minus fees. This is returned as a float, so for example, if net amount was $5.00, you would see 5.00
gateway_reference_id - this is the order id associated with the transaction.
order_number - The order number of the order associated with the transaction.
partner_reference_id - the PSP token for the transaction
transaction_type - Enum describing the type of transaction. Possible values: 0 = Deposit 1 = Refund 2 = Chargeback 6 = ChargebackReversal, 7 = Decline, 10 = AdjustmentFrom, 11 = AdjustmentTo, 13 = Fee There are a few more possible values, but they are not in use here (e.g. ACH)

Example URI

GET https://nuorder.com/api/v3.0/transactions/deposits/account/:accountId?transaction_date_gte=1636009200000&transaction_date_lte=1636095599999

URI Parameters

HideShow

accountId: string (required) Example: 5aabd2c3fa217edddeaab162
id of your NuORDER Payments account
transaction_date_gte: number (optional) Example: 1636009200000
Date cutoff to begin looking for a record’s created_at date. Inclusive of day provided.
transaction_date_lte: number (optional) Example: 1636095599999
Date cutoff to end looking for a record’s created_at date. Inclusive of day provided.

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "adjustment_id": "``",
    "arn": "``",
    "authorization_amount": 0,
    "authorization_code": "``",
    "authorization_response": "``",
    "authorization_source": "``",
    "brand_id": "``",
    "buyer_email": "``",
    "card_bin": "``",
    "card_expiration_date": "``",
    "card_last_four": "``",
    "card_present_type": "Hello, world!",
    "card_type": "``",
    "chargeback_fee": 0,
    "company_name": "``",
    "created_on": 0,
    "currency_code": "``",
    "deposit_id": "``",
    "deposit_ids": "Hello, world!",
    "e_check": "``",
    "extended_data": "``",
    "fee_billing_type": 0,
    "fee_funding_status": 0,
    "fee_profile_type": 0,
    "fee_settlement_date": "``",
    "funding_status": 0,
    "gateway_reference_id": "``",
    "id": "``",
    "infinicept_id": 0,
    "interchange_code": "``",
    "interchange_level": "``",
    "is_forced": false,
    "issuing_bank_id": "``",
    "merchant_identifiers": "Hello, world!",
    "modified_on": 0,
    "net_amount": 0,
    "network": 0,
    "notes": "Hello, world!",
    "nuorder_transaction_id": "``",
    "on_hold": "``",
    "order_number": "``",
    "partner_reference_id": "``",
    "payment_account_id": "``",
    "processed_date": 0,
    "processor_mid": "``",
    "processor_transaction_id": "``",
    "settlement_date": 0,
    "source_data_event_id": 0,
    "submerchant_batch_id": "``",
    "submerchant_dba_name": "``",
    "submerchant_id": "``",
    "submerchant_name": "``",
    "submerchant_status": 0,
    "terminal_id": "``",
    "tip_amount": 0,
    "total_assessed_fees": 0,
    "total_fees": 0,
    "transaction_amount": 0,
    "transaction_date": 0,
    "transaction_type": 0
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Pricesheet Collection ¶

APIs for managing your Pricesheets.

Get pricesheet by template
GET`/api/pricesheet/{template}`

Example URI

GET https://nuorder.com/api/pricesheet/A23N

URI Parameters

HideShow

template: string (required) Example: A23N
pricesheet template name

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "pricing": [
    {
      "wholesale": 1.2,
      "retail": 0,
      "disabled": false,
      "sizes": [
        {
          "_id": "59d436ce105813000150505f",
          "wholesale": "1",
          "retail": "0",
          "size": "small"
        }
      ],
      "template": "A23N",
      "style_number": "A11N",
      "season": "summer",
      "color": "green",
      "product": "5728def1ab19c9017f5f585c"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "pricing": {
      "type": "array"
    }
  }
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Pricing template not found'
}

Get pricesheets list
GET`/api/pricesheets/list`

Example URI

GET https://nuorder.com/api/pricesheets/list

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
    { name: 'template1' },
    { name: 'template2' } ,
    { name: 'template3' }
]

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Get pricesheets companies IDs
GET`/api/pricesheets/list/companies/{template}`

Example URI

GET https://nuorder.com/api/pricesheets/list/companies/A23N

URI Parameters

HideShow

template: string (required) Example: A23N
pricesheet template name

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
    '59d425cae1d38e00019e7608',
    '570707c62f7f6d803ceb52bd',
    '560b53e2d9045d4e36cb97da'
]

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Get pricesheets companies codes
GET`/api/pricesheets/list/companies/codes/{template}`

Example URI

GET https://nuorder.com/api/pricesheets/list/companies/codes/A23N

URI Parameters

HideShow

template: string (required) Example: A23N
pricesheet template name

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
        '159488',
        'AGABI01',
        'QT123'
    ]

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Create pricesheet
PUT`/api/pricesheet/{template}`

Example URI

PUT https://nuorder.com/api/pricesheet/A23N

URI Parameters

HideShow

template: string (required) Example: A23N
pricesheet template name

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "currency_code": "USD",
  "pricing": [
    {
      "wholesale": 1.2,
      "retail": 0,
      "disabled": false,
      "sizes": [
        {
          "_id": "59d436ce105813000150505f",
          "wholesale": "1",
          "retail": "0",
          "size": "small"
        }
      ],
      "template": "A23N",
      "style_number": "A11N",
      "season": "summer",
      "color": "green",
      "_id": "5996118f6873730001744fff",
      "brand_id": "A486"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "currency_code": {
      "type": "string",
      "description": "pricing currency code"
    },
    "pricing": {
      "type": "array"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    'updates': [
        'Pricing template awesome_template has set a price for 5996118f6873730001744fff (A930|spring/summer|all dark blue)'
    ],
    'errors': []
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
    code: 409,
    message: 'Pricing template already exists'
}

Assign pricesheet to product by ID
POST`/api/pricesheet/{template}/assign/product/{id}`

Example URI

POST https://nuorder.com/api/pricesheet/A23N/assign/product/5996118f6873730001744fff

URI Parameters

HideShow

template: string (required) Example: A23N
pricesheet template name
id: string (required) Example: 5996118f6873730001744fff
product ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "pricing": [
    {
      "wholesale": 1.2,
      "retail": 0,
      "disabled": false,
      "sizes": [
        {
          "_id": "59d436ce105813000150505f",
          "wholesale": "1",
          "retail": "0",
          "size": "small"
        }
      ],
      "template": "A23N",
      "style_number": "A11N",
      "season": "summer",
      "color": "green",
      "_id": "5996118f6873730001744fff",
      "brand_id": "A486"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "pricing": {
      "type": "array"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "updates": [
    "Pricing template some-name has set a price for 5996118f6873730001744ff6 (A363|spring/summer|rose gold/gunmetal/brown)"
  ],
  "errors": []
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: '5996118f6873730001744fff wholesale is missing, disabled is missing'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Assign pricesheet to product by external_id
POST`/api/pricesheet/{template}/assign/product/external_id/{id}`

Example URI

POST https://nuorder.com/api/pricesheet/A23N/assign/product/external_id/A486-springsummer-blacksilver

URI Parameters

HideShow

template: string (required) Example: A23N
pricesheet template name
id: string (required) Example: A486-springsummer-blacksilver
product external_id or brand_id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "pricing": [
    {
      "wholesale": 1.2,
      "retail": 0,
      "disabled": false,
      "sizes": [
        {
          "_id": "59d436ce105813000150505f",
          "wholesale": "1",
          "retail": "0",
          "size": "small"
        }
      ],
      "template": "A23N",
      "style_number": "A11N",
      "season": "summer",
      "color": "green",
      "_id": "5996118f6873730001744fff",
      "brand_id": "A486"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "pricing": {
      "type": "array"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "updates": [
    "Pricing template ch3 has set a price for A486-springsummer-blacksilver (A486|spring/summer|black/silver)"
  ],
  "errors": []
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'A486-springsummer-blacksilver size[0].wholesale is missing'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Delete pricesheet from product by ID
DELETE`/api/pricesheet/{template}/remove/product/{id}`

Example URI

DELETE https://nuorder.com/api/pricesheet/A23N/remove/product/5996118f6873730001744fff

URI Parameters

HideShow

template: string (required) Example: A23N
pricesheet template name
id: string (required) Example: 5996118f6873730001744fff
product ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
  "code": 400,
  "message": "Invalid ID Parameter"
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Delete pricesheet from product by external_id
DELETE`/api/pricesheet/{template}/remove/product/external_id/{id}`

Example URI

DELETE https://nuorder.com/api/pricesheet/A23N/remove/product/external_id/A486-springsummer-blacksilver

URI Parameters

HideShow

template: string (required) Example: A23N
pricesheet template name
id: string (required) Example: A486-springsummer-blacksilver
product external_id or brand_id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Update pricesheet by product ID
POST`/api/product/{id}/pricesheets`

Example URI

POST https://nuorder.com/api/product/5996118f6873730001744ff6/pricesheets

URI Parameters

HideShow

id: string (required) Example: 5996118f6873730001744ff6
product ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

[
  {
    "wholesale": 1.2,
    "retail": 0,
    "disabled": false,
    "sizes": [
      {
        "_id": "59d436ce105813000150505f",
        "wholesale": "1",
        "retail": "0",
        "size": "small"
      }
    ],
    "template": "A23N",
    "style_number": "A11N",
    "season": "summer",
    "color": "green",
    "_id": "5996118f6873730001744fff",
    "brand_id": "A486"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "message": "Pricing template ch3 has set a price for 5996118f6873730001744ff6 (A363|spring/summer|rose gold/gunmetal/brown)",
    "index": 0,
    "success": true
  }
]

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
  "code": 400,
  "message": "Invalid ID Parameter"
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Update pricesheet by product external ID
POST`/api/product/external_id/{id}/pricesheets`

Example URI

POST https://nuorder.com/api/product/external_id/A486-springsummer-blacksilver/pricesheets

URI Parameters

HideShow

id: string (required) Example: A486-springsummer-blacksilver
product external_id or brand_id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

[
  {
    "wholesale": 1.2,
    "retail": 0,
    "disabled": false,
    "sizes": [
      {
        "_id": "59d436ce105813000150505f",
        "wholesale": "1",
        "retail": "0",
        "size": "small"
      }
    ],
    "template": "A23N",
    "style_number": "A11N",
    "season": "summer",
    "color": "green",
    "_id": "5996118f6873730001744fff",
    "brand_id": "A486"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "message": "Pricing template ch3 has set a price for A486-springsummer-blacksilver(A486|spring/summer|black/silver)",
    "index": 0,
    "success": true
  }
]

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
  "code": 400,
  "message": "Invalid ID Parameter"
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Delete pricesheet by product ID
DELETE`/api/product/{id}/pricesheets`

Example URI

DELETE https://nuorder.com/api/product/5996118f6873730001744ff6/pricesheets

URI Parameters

HideShow

id: string (required) Example: 5996118f6873730001744ff6
product ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
  "code": 400,
  "message": "Invalid ID Parameter"
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Delete pricesheet by product external ID
DELETE`/api/product/external_id/{id}/pricesheets`

Example URI

DELETE https://nuorder.com/api/product/external_id/A486-springsummer-blacksilver/pricesheets

URI Parameters

HideShow

id: string (required) Example: A486-springsummer-blacksilver
product external_id or brand_id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Bulk assign pricesheet to products
POST`/api/pricesheet/bulk/assign/{template}`

Example URI

POST https://nuorder.com/api/pricesheet/bulk/assign/A23N

URI Parameters

HideShow

template: string (required) Example: A23N
pricesheet template name

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "pricing": [
    {
      "wholesale": 1.2,
      "retail": 0,
      "disabled": false,
      "sizes": [
        {
          "_id": "59d436ce105813000150505f",
          "wholesale": "1",
          "retail": "0",
          "size": "small"
        }
      ],
      "template": "A23N",
      "style_number": "A11N",
      "season": "summer",
      "color": "green",
      "_id": "5996118f6873730001744fff",
      "brand_id": "A486"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "pricing": {
      "type": "array"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "updates": [
    "Pricing template 467 has set a price for 5996118f6873730001744fff (A930|spring/summer|all dark blue)"
  ],
  "errors": [
    "5996118f6873730001744fff size[0].wholesale is missing"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
  "code": 400,
  "message": "Invalid ID Parameter"
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Bulk remove pricesheet from all products
DELETE`/api/pricesheet/bulk/remove/{template}`

Example URI

DELETE https://nuorder.com/api/pricesheet/bulk/remove/A23N

URI Parameters

HideShow

template: string (required) Example: A23N
pricesheet template name

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "success": true
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Product Collection ¶

APIs for managing your Products, please note, the external ID is the Brand ID value that is attributed to your product data on a style + color level.

Get Product by ID
GET`/api/product/{id}`

Example URI

GET https://nuorder.com/api/product/59e4fad8cddc5c50bffa4188

URI Parameters

HideShow

id: string (required) Example: 59e4fad8cddc5c50bffa4188
Product ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "style_number": "A396",
  "season": "spring/summer",
  "color": "all black",
  "name": "test",
  "brand_id": "172ak061712-001",
  "unique_key": "A396,spring/summer,all black",
  "schema_id": "537bcbd716af5274043a0992",
  "sizes": [
    {
      "size": "OS",
      "size_group": "A1",
      "pricing": {
        "USD": {
          "wholesale": 10,
          "retail": 12.1,
          "disabled": false
        }
      }
    }
  ],
  "banners": [
    "[583f5196675ef9ac78c1628d]"
  ],
  "size_groups": [
    "[ group1, group2, group3 ]"
  ],
  "available_now": false,
  "images": [
    "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
  ],
  "cancelled": false,
  "archived": false,
  "active": true,
  "description": "awesome product",
  "available_from": "2017/08/30",
  "available_until": "2019/08/30",
  "order_closing": "2017-09-12 00:00:00.000Z",
  "pricing": {
    "USD": {
      "wholesale": 10,
      "retail": 12.1,
      "disabled": false
    }
  },
  "seasons": [
    "[spring, summer, 2018]"
  ],
  "_id": "599611906873730001745011",
  "__size_ids": [
    "[599611906873730001745011]"
  ],
  "modified_on": "2017-09-11T22:30:04.911Z",
  "__inventory_cache": [
    {
      "bucket": "2018/07/25",
      "warehouse": "537bcbd716af5274043a09be",
      "sku_id": "59958be4ffb5c600017a05cb",
      "_id": "59b70e6a01c70700012dbdb8",
      "quantity": 72
    }
  ],
  "__inventory": [
    "[default]"
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "style_number": {
      "type": "string",
      "description": "product style number"
    },
    "season": {
      "type": "string",
      "description": "product season"
    },
    "color": {
      "type": "string",
      "description": "product color"
    },
    "name": {
      "type": "string",
      "description": "product name"
    },
    "brand_id": {
      "type": "string",
      "description": "product external identificator"
    },
    "unique_key": {
      "type": "string",
      "description": "Product unique key"
    },
    "schema_id": {
      "type": "string",
      "description": "product schema id"
    },
    "sizes": {
      "type": "array",
      "description": "product sizes"
    },
    "banners": {
      "type": "array",
      "description": "order banners"
    },
    "size_groups": {
      "type": "array",
      "description": "size groups"
    },
    "available_now": {
      "type": "boolean",
      "description": "whether product is available now"
    },
    "images": {
      "type": "array",
      "description": "product images URLs: upload Images via API not supported at this time"
    },
    "cancelled": {
      "type": "boolean",
      "description": "whether product was cancelled"
    },
    "archived": {
      "type": "boolean",
      "description": "whether product was archived"
    },
    "active": {
      "type": "boolean",
      "description": "whether product is active,"
    },
    "description": {
      "type": "string",
      "description": "product description"
    },
    "available_from": {
      "type": "string",
      "description": "date available from"
    },
    "available_until": {
      "type": "string",
      "description": "date available until"
    },
    "order_closing": {
      "type": "string",
      "description": "date order closing"
    },
    "pricing": {
      "type": "object",
      "properties": {
        "USD": {
          "type": "object",
          "properties": {
            "wholesale": {
              "type": "number",
              "description": "wholesale price"
            },
            "retail": {
              "type": "number",
              "description": "retail price"
            },
            "disabled": {
              "type": "boolean",
              "description": "whether price is disabled"
            }
          },
          "required": [
            "wholesale"
          ]
        }
      },
      "description": "product pricing"
    },
    "seasons": {
      "type": "array",
      "description": "product additional seasons"
    },
    "_id": {
      "type": "string",
      "description": "product ID"
    },
    "__size_ids": {
      "type": "array",
      "description": "size ids array"
    },
    "modified_on": {
      "type": "string",
      "description": "last modified date"
    },
    "__inventory_cache": {
      "type": "array",
      "description": "inventory cached data (DEPRECATED, to be removed soon)"
    },
    "__inventory": {
      "type": "array",
      "description": "inventory names"
    }
  },
  "required": [
    "style_number",
    "season",
    "color",
    "name",
    "sizes",
    "pricing"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid input data'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Product not found'
}

Get Product by external ID
GET`/api/product/external_id/{brand_id}`

Example URI

GET https://nuorder.com/api/product/external_id/172ak061712-001

URI Parameters

HideShow

brand_id: string (required) Example: 172ak061712-001
Product brand ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "style_number": "A396",
  "season": "spring/summer",
  "color": "all black",
  "name": "test",
  "brand_id": "172ak061712-001",
  "unique_key": "A396,spring/summer,all black",
  "schema_id": "537bcbd716af5274043a0992",
  "sizes": [
    {
      "size": "OS",
      "size_group": "A1",
      "pricing": {
        "USD": {
          "wholesale": 10,
          "retail": 12.1,
          "disabled": false
        }
      }
    }
  ],
  "banners": [
    "[583f5196675ef9ac78c1628d]"
  ],
  "size_groups": [
    "[ group1, group2, group3 ]"
  ],
  "available_now": false,
  "images": [
    "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
  ],
  "cancelled": false,
  "archived": false,
  "active": true,
  "description": "awesome product",
  "available_from": "2017/08/30",
  "available_until": "2019/08/30",
  "order_closing": "2017-09-12 00:00:00.000Z",
  "pricing": {
    "USD": {
      "wholesale": 10,
      "retail": 12.1,
      "disabled": false
    }
  },
  "seasons": [
    "[spring, summer, 2018]"
  ],
  "_id": "599611906873730001745011",
  "__size_ids": [
    "[599611906873730001745011]"
  ],
  "modified_on": "2017-09-11T22:30:04.911Z",
  "__inventory_cache": [
    {
      "bucket": "2018/07/25",
      "warehouse": "537bcbd716af5274043a09be",
      "sku_id": "59958be4ffb5c600017a05cb",
      "_id": "59b70e6a01c70700012dbdb8",
      "quantity": 72
    }
  ],
  "__inventory": [
    "[default]"
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "style_number": {
      "type": "string",
      "description": "product style number"
    },
    "season": {
      "type": "string",
      "description": "product season"
    },
    "color": {
      "type": "string",
      "description": "product color"
    },
    "name": {
      "type": "string",
      "description": "product name"
    },
    "brand_id": {
      "type": "string",
      "description": "product external identificator"
    },
    "unique_key": {
      "type": "string",
      "description": "Product unique key"
    },
    "schema_id": {
      "type": "string",
      "description": "product schema id"
    },
    "sizes": {
      "type": "array",
      "description": "product sizes"
    },
    "banners": {
      "type": "array",
      "description": "order banners"
    },
    "size_groups": {
      "type": "array",
      "description": "size groups"
    },
    "available_now": {
      "type": "boolean",
      "description": "whether product is available now"
    },
    "images": {
      "type": "array",
      "description": "product images URLs: upload Images via API not supported at this time"
    },
    "cancelled": {
      "type": "boolean",
      "description": "whether product was cancelled"
    },
    "archived": {
      "type": "boolean",
      "description": "whether product was archived"
    },
    "active": {
      "type": "boolean",
      "description": "whether product is active,"
    },
    "description": {
      "type": "string",
      "description": "product description"
    },
    "available_from": {
      "type": "string",
      "description": "date available from"
    },
    "available_until": {
      "type": "string",
      "description": "date available until"
    },
    "order_closing": {
      "type": "string",
      "description": "date order closing"
    },
    "pricing": {
      "type": "object",
      "properties": {
        "USD": {
          "type": "object",
          "properties": {
            "wholesale": {
              "type": "number",
              "description": "wholesale price"
            },
            "retail": {
              "type": "number",
              "description": "retail price"
            },
            "disabled": {
              "type": "boolean",
              "description": "whether price is disabled"
            }
          },
          "required": [
            "wholesale"
          ]
        }
      },
      "description": "product pricing"
    },
    "seasons": {
      "type": "array",
      "description": "product additional seasons"
    },
    "_id": {
      "type": "string",
      "description": "product ID"
    },
    "__size_ids": {
      "type": "array",
      "description": "size ids array"
    },
    "modified_on": {
      "type": "string",
      "description": "last modified date"
    },
    "__inventory_cache": {
      "type": "array",
      "description": "inventory cached data (DEPRECATED, to be removed soon)"
    },
    "__inventory": {
      "type": "array",
      "description": "inventory names"
    }
  },
  "required": [
    "style_number",
    "season",
    "color",
    "name",
    "sizes",
    "pricing"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid input data'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Product not found'
}

Get values of Products' specified by grouping
GET`/api/products/{grouping}/list`

Example URI

GET https://nuorder.com/api/products/style_number/list

URI Parameters

HideShow

grouping: string (required) Example: style_number
product property (field name) which values needs to be taken

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object"
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid input data'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Get Products matched grouping value
GET`/api/products/{grouping}/{value}/detail`

Example URI

GET https://nuorder.com/api/products/color_code/black/detail

URI Parameters

HideShow

grouping: string (required) Example: color_code
product property (field name)
value: string (required) Example: black
grouping value

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
    '54e508366c4ef2f027aea546',
    '54e508366c4ef2f027aea547'
]

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid input data'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Get Products IDs matched grouping value
GET`/api/products/{grouping}/{value}/list`

Example URI

GET https://nuorder.com/api/products/color_code/black/list

URI Parameters

HideShow

grouping: string (required) Example: color_code
product property (field name)
value: string (required) Example: black
grouping value

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
    '54e508366c4ef2f027aea546',
    '54e508366c4ef2f027aea547'
]

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid input data'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Get Products by created/modified filter
GET`/api/products/{field}/{when}/{mm}/{dd}/{yyyy}`

Example URI

GET https://nuorder.com/api/products/created/before/7/29/2017

URI Parameters

HideShow

field

string (required) Example: created

field to filter on

Choices: created modified

when

string (required) Example: before

before or after

Choices: before after

mm

number (required) Example: 7

month number 1…12

dd

number (required) Example: 29

day of month: 1…31

yyyy

number (required) Example: 2017

year

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "style_number": "A396",
    "season": "spring/summer",
    "color": "all black",
    "name": "test",
    "brand_id": "172ak061712-001",
    "unique_key": "A396,spring/summer,all black",
    "schema_id": "537bcbd716af5274043a0992",
    "sizes": [
      {
        "size": "OS",
        "size_group": "A1",
        "pricing": {
          "USD": {
            "wholesale": 10,
            "retail": 12.1,
            "disabled": false
          }
        }
      }
    ],
    "banners": [
      "[583f5196675ef9ac78c1628d]"
    ],
    "size_groups": [
      "[ group1, group2, group3 ]"
    ],
    "available_now": false,
    "images": [
      "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
    ],
    "cancelled": false,
    "archived": false,
    "active": true,
    "description": "awesome product",
    "available_from": "2017/08/30",
    "available_until": "2019/08/30",
    "order_closing": "2017-09-12 00:00:00.000Z",
    "pricing": {
      "USD": {
        "wholesale": 10,
        "retail": 12.1,
        "disabled": false
      }
    },
    "seasons": [
      "[spring, summer, 2018]"
    ],
    "_id": "599611906873730001745011",
    "__size_ids": [
      "[599611906873730001745011]"
    ],
    "modified_on": "2017-09-11T22:30:04.911Z",
    "__inventory_cache": [
      {
        "bucket": "2018/07/25",
        "warehouse": "537bcbd716af5274043a09be",
        "sku_id": "59958be4ffb5c600017a05cb",
        "_id": "59b70e6a01c70700012dbdb8",
        "quantity": 72
      }
    ],
    "__inventory": [
      "[default]"
    ]
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Invalid input data'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Update Product by ID
POST`/api/product/{id}`

Example URI

POST https://nuorder.com/api/product/59523f99cf355d0001e75f43

URI Parameters

HideShow

id: string (required) Example: 59523f99cf355d0001e75f43
product id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "style_number": "A396",
  "season": "spring/summer",
  "color": "all black",
  "name": "test",
  "brand_id": "172ak061712-001",
  "unique_key": "A396,spring/summer,all black",
  "schema_id": "537bcbd716af5274043a0992",
  "sizes": [
    {
      "size": "OS",
      "size_group": "A1",
      "pricing": {
        "USD": {
          "wholesale": 10,
          "retail": 12.1,
          "disabled": false
        }
      }
    }
  ],
  "banners": [
    "[583f5196675ef9ac78c1628d]"
  ],
  "size_groups": [
    "[ group1, group2, group3 ]"
  ],
  "available_now": false,
  "archived": false,
  "active": true,
  "description": "awesome product",
  "available_from": "2017/08/30",
  "available_until": "2019/08/30",
  "order_closing": "2017-09-12 00:00:00.000Z",
  "pricing": {
    "USD": {
      "wholesale": 10,
      "retail": 12.1,
      "disabled": false
    }
  },
  "seasons": [
    "[spring, summer, 2018]"
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "style_number": {
      "type": "string",
      "description": "product style number"
    },
    "season": {
      "type": "string",
      "description": "product season"
    },
    "color": {
      "type": "string",
      "description": "product color"
    },
    "name": {
      "type": "string",
      "description": "product name"
    },
    "brand_id": {
      "type": "string",
      "description": "product external identificator"
    },
    "unique_key": {
      "type": "string",
      "description": "Product unique key"
    },
    "schema_id": {
      "type": "string",
      "description": "product schema id"
    },
    "sizes": {
      "type": "array",
      "description": "product sizes"
    },
    "banners": {
      "type": "array",
      "description": "order banners"
    },
    "size_groups": {
      "type": "array",
      "description": "size groups"
    },
    "available_now": {
      "type": "boolean",
      "description": "whether product is available now"
    },
    "archived": {
      "type": "boolean",
      "description": "whether product was archived"
    },
    "active": {
      "type": "boolean",
      "description": "whether product is active,"
    },
    "description": {
      "type": "string",
      "description": "product description"
    },
    "available_from": {
      "type": "string",
      "description": "date available from"
    },
    "available_until": {
      "type": "string",
      "description": "date available until"
    },
    "order_closing": {
      "type": "string",
      "description": "date order closing"
    },
    "pricing": {
      "type": "object",
      "properties": {
        "USD": {
          "type": "object",
          "properties": {
            "wholesale": {
              "type": "number",
              "description": "wholesale price"
            },
            "retail": {
              "type": "number",
              "description": "retail price"
            },
            "disabled": {
              "type": "boolean",
              "description": "whether price is disabled"
            }
          },
          "required": [
            "wholesale"
          ]
        }
      },
      "description": "product pricing"
    },
    "seasons": {
      "type": "array",
      "description": "product additional seasons"
    }
  },
  "required": [
    "style_number",
    "season",
    "color",
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "style_number": "A396",
  "season": "spring/summer",
  "color": "all black",
  "name": "test",
  "brand_id": "172ak061712-001",
  "unique_key": "A396,spring/summer,all black",
  "schema_id": "537bcbd716af5274043a0992",
  "sizes": [
    {
      "size": "OS",
      "size_group": "A1",
      "pricing": {
        "USD": {
          "wholesale": 10,
          "retail": 12.1,
          "disabled": false
        }
      }
    }
  ],
  "banners": [
    "[583f5196675ef9ac78c1628d]"
  ],
  "size_groups": [
    "[ group1, group2, group3 ]"
  ],
  "available_now": false,
  "images": [
    "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
  ],
  "cancelled": false,
  "archived": false,
  "active": true,
  "description": "awesome product",
  "available_from": "2017/08/30",
  "available_until": "2019/08/30",
  "order_closing": "2017-09-12 00:00:00.000Z",
  "pricing": {
    "USD": {
      "wholesale": 10,
      "retail": 12.1,
      "disabled": false
    }
  },
  "seasons": [
    "[spring, summer, 2018]"
  ],
  "_id": "599611906873730001745011",
  "__size_ids": [
    "[599611906873730001745011]"
  ],
  "modified_on": "2017-09-11T22:30:04.911Z",
  "__inventory_cache": [
    {
      "bucket": "2018/07/25",
      "warehouse": "537bcbd716af5274043a09be",
      "sku_id": "59958be4ffb5c600017a05cb",
      "_id": "59b70e6a01c70700012dbdb8",
      "quantity": 72
    }
  ],
  "__inventory": [
    "[default]"
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "style_number": {
      "type": "string",
      "description": "product style number"
    },
    "season": {
      "type": "string",
      "description": "product season"
    },
    "color": {
      "type": "string",
      "description": "product color"
    },
    "name": {
      "type": "string",
      "description": "product name"
    },
    "brand_id": {
      "type": "string",
      "description": "product external identificator"
    },
    "unique_key": {
      "type": "string",
      "description": "Product unique key"
    },
    "schema_id": {
      "type": "string",
      "description": "product schema id"
    },
    "sizes": {
      "type": "array",
      "description": "product sizes"
    },
    "banners": {
      "type": "array",
      "description": "order banners"
    },
    "size_groups": {
      "type": "array",
      "description": "size groups"
    },
    "available_now": {
      "type": "boolean",
      "description": "whether product is available now"
    },
    "images": {
      "type": "array",
      "description": "product images URLs: upload Images via API not supported at this time"
    },
    "cancelled": {
      "type": "boolean",
      "description": "whether product was cancelled"
    },
    "archived": {
      "type": "boolean",
      "description": "whether product was archived"
    },
    "active": {
      "type": "boolean",
      "description": "whether product is active,"
    },
    "description": {
      "type": "string",
      "description": "product description"
    },
    "available_from": {
      "type": "string",
      "description": "date available from"
    },
    "available_until": {
      "type": "string",
      "description": "date available until"
    },
    "order_closing": {
      "type": "string",
      "description": "date order closing"
    },
    "pricing": {
      "type": "object",
      "properties": {
        "USD": {
          "type": "object",
          "properties": {
            "wholesale": {
              "type": "number",
              "description": "wholesale price"
            },
            "retail": {
              "type": "number",
              "description": "retail price"
            },
            "disabled": {
              "type": "boolean",
              "description": "whether price is disabled"
            }
          },
          "required": [
            "wholesale"
          ]
        }
      },
      "description": "product pricing"
    },
    "seasons": {
      "type": "array",
      "description": "product additional seasons"
    },
    "_id": {
      "type": "string",
      "description": "product ID"
    },
    "__size_ids": {
      "type": "array",
      "description": "size ids array"
    },
    "modified_on": {
      "type": "string",
      "description": "last modified date"
    },
    "__inventory_cache": {
      "type": "array",
      "description": "inventory cached data (DEPRECATED, to be removed soon)"
    },
    "__inventory": {
      "type": "array",
      "description": "inventory names"
    }
  },
  "required": [
    "style_number",
    "season",
    "color",
    "name",
    "sizes",
    "pricing"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Validation error messages'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Product not found'
}

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
    code: 409,
    message: 'Another product already exists with the given composite keys.'
}

Update Product by external ID
POST`/api/product/external_id/{external_id}`

Example URI

POST https://nuorder.com/api/product/external_id/172ak061712-001

URI Parameters

HideShow

external_id: string (required) Example: 172ak061712-001
product external id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "style_number": "A396",
  "season": "spring/summer",
  "color": "all black",
  "name": "test",
  "brand_id": "172ak061712-001",
  "unique_key": "A396,spring/summer,all black",
  "schema_id": "537bcbd716af5274043a0992",
  "sizes": [
    {
      "size": "OS",
      "size_group": "A1",
      "pricing": {
        "USD": {
          "wholesale": 10,
          "retail": 12.1,
          "disabled": false
        }
      }
    }
  ],
  "banners": [
    "[583f5196675ef9ac78c1628d]"
  ],
  "size_groups": [
    "[ group1, group2, group3 ]"
  ],
  "available_now": false,
  "archived": false,
  "active": true,
  "description": "awesome product",
  "available_from": "2017/08/30",
  "available_until": "2019/08/30",
  "order_closing": "2017-09-12 00:00:00.000Z",
  "pricing": {
    "USD": {
      "wholesale": 10,
      "retail": 12.1,
      "disabled": false
    }
  },
  "seasons": [
    "[spring, summer, 2018]"
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "style_number": {
      "type": "string",
      "description": "product style number"
    },
    "season": {
      "type": "string",
      "description": "product season"
    },
    "color": {
      "type": "string",
      "description": "product color"
    },
    "name": {
      "type": "string",
      "description": "product name"
    },
    "brand_id": {
      "type": "string",
      "description": "product external identificator"
    },
    "unique_key": {
      "type": "string",
      "description": "Product unique key"
    },
    "schema_id": {
      "type": "string",
      "description": "product schema id"
    },
    "sizes": {
      "type": "array",
      "description": "product sizes"
    },
    "banners": {
      "type": "array",
      "description": "order banners"
    },
    "size_groups": {
      "type": "array",
      "description": "size groups"
    },
    "available_now": {
      "type": "boolean",
      "description": "whether product is available now"
    },
    "archived": {
      "type": "boolean",
      "description": "whether product was archived"
    },
    "active": {
      "type": "boolean",
      "description": "whether product is active,"
    },
    "description": {
      "type": "string",
      "description": "product description"
    },
    "available_from": {
      "type": "string",
      "description": "date available from"
    },
    "available_until": {
      "type": "string",
      "description": "date available until"
    },
    "order_closing": {
      "type": "string",
      "description": "date order closing"
    },
    "pricing": {
      "type": "object",
      "properties": {
        "USD": {
          "type": "object",
          "properties": {
            "wholesale": {
              "type": "number",
              "description": "wholesale price"
            },
            "retail": {
              "type": "number",
              "description": "retail price"
            },
            "disabled": {
              "type": "boolean",
              "description": "whether price is disabled"
            }
          },
          "required": [
            "wholesale"
          ]
        }
      },
      "description": "product pricing"
    },
    "seasons": {
      "type": "array",
      "description": "product additional seasons"
    }
  },
  "required": [
    "style_number",
    "season",
    "color",
    "name"
  ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "style_number": "A396",
  "season": "spring/summer",
  "color": "all black",
  "name": "test",
  "brand_id": "172ak061712-001",
  "unique_key": "A396,spring/summer,all black",
  "schema_id": "537bcbd716af5274043a0992",
  "sizes": [
    {
      "size": "OS",
      "size_group": "A1",
      "pricing": {
        "USD": {
          "wholesale": 10,
          "retail": 12.1,
          "disabled": false
        }
      }
    }
  ],
  "banners": [
    "[583f5196675ef9ac78c1628d]"
  ],
  "size_groups": [
    "[ group1, group2, group3 ]"
  ],
  "available_now": false,
  "images": [
    "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
  ],
  "cancelled": false,
  "archived": false,
  "active": true,
  "description": "awesome product",
  "available_from": "2017/08/30",
  "available_until": "2019/08/30",
  "order_closing": "2017-09-12 00:00:00.000Z",
  "pricing": {
    "USD": {
      "wholesale": 10,
      "retail": 12.1,
      "disabled": false
    }
  },
  "seasons": [
    "[spring, summer, 2018]"
  ],
  "_id": "599611906873730001745011",
  "__size_ids": [
    "[599611906873730001745011]"
  ],
  "modified_on": "2017-09-11T22:30:04.911Z",
  "__inventory_cache": [
    {
      "bucket": "2018/07/25",
      "warehouse": "537bcbd716af5274043a09be",
      "sku_id": "59958be4ffb5c600017a05cb",
      "_id": "59b70e6a01c70700012dbdb8",
      "quantity": 72
    }
  ],
  "__inventory": [
    "[default]"
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "style_number": {
      "type": "string",
      "description": "product style number"
    },
    "season": {
      "type": "string",
      "description": "product season"
    },
    "color": {
      "type": "string",
      "description": "product color"
    },
    "name": {
      "type": "string",
      "description": "product name"
    },
    "brand_id": {
      "type": "string",
      "description": "product external identificator"
    },
    "unique_key": {
      "type": "string",
      "description": "Product unique key"
    },
    "schema_id": {
      "type": "string",
      "description": "product schema id"
    },
    "sizes": {
      "type": "array",
      "description": "product sizes"
    },
    "banners": {
      "type": "array",
      "description": "order banners"
    },
    "size_groups": {
      "type": "array",
      "description": "size groups"
    },
    "available_now": {
      "type": "boolean",
      "description": "whether product is available now"
    },
    "images": {
      "type": "array",
      "description": "product images URLs: upload Images via API not supported at this time"
    },
    "cancelled": {
      "type": "boolean",
      "description": "whether product was cancelled"
    },
    "archived": {
      "type": "boolean",
      "description": "whether product was archived"
    },
    "active": {
      "type": "boolean",
      "description": "whether product is active,"
    },
    "description": {
      "type": "string",
      "description": "product description"
    },
    "available_from": {
      "type": "string",
      "description": "date available from"
    },
    "available_until": {
      "type": "string",
      "description": "date available until"
    },
    "order_closing": {
      "type": "string",
      "description": "date order closing"
    },
    "pricing": {
      "type": "object",
      "properties": {
        "USD": {
          "type": "object",
          "properties": {
            "wholesale": {
              "type": "number",
              "description": "wholesale price"
            },
            "retail": {
              "type": "number",
              "description": "retail price"
            },
            "disabled": {
              "type": "boolean",
              "description": "whether price is disabled"
            }
          },
          "required": [
            "wholesale"
          ]
        }
      },
      "description": "product pricing"
    },
    "seasons": {
      "type": "array",
      "description": "product additional seasons"
    },
    "_id": {
      "type": "string",
      "description": "product ID"
    },
    "__size_ids": {
      "type": "array",
      "description": "size ids array"
    },
    "modified_on": {
      "type": "string",
      "description": "last modified date"
    },
    "__inventory_cache": {
      "type": "array",
      "description": "inventory cached data (DEPRECATED, to be removed soon)"
    },
    "__inventory": {
      "type": "array",
      "description": "inventory names"
    }
  },
  "required": [
    "style_number",
    "season",
    "color",
    "name",
    "sizes",
    "pricing"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Validation error messages'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Product not found'
}

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
    code: 409,
    message: 'Another product already exists with the given composite keys.'
}

Create Product
PUT`/api/product/new`

Example URI

PUT https://nuorder.com/api/product/new

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "style_number": "A396",
  "season": "spring/summer",
  "color": "all black",
  "name": "test",
  "brand_id": "172ak061712-001",
  "unique_key": "A396,spring/summer,all black",
  "schema_id": "537bcbd716af5274043a0992",
  "sizes": [
    {
      "size": "OS",
      "size_group": "A1",
      "pricing": {
        "USD": {
          "wholesale": 10,
          "retail": 12.1,
          "disabled": false
        }
      }
    }
  ],
  "banners": [
    "[583f5196675ef9ac78c1628d]"
  ],
  "size_groups": [
    "[ group1, group2, group3 ]"
  ],
  "available_now": false,
  "archived": false,
  "active": true,
  "description": "awesome product",
  "available_from": "2017/08/30",
  "available_until": "2019/08/30",
  "order_closing": "2017-09-12 00:00:00.000Z",
  "pricing": {
    "USD": {
      "wholesale": 10,
      "retail": 12.1,
      "disabled": false
    }
  },
  "seasons": [
    "[spring, summer, 2018]"
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "style_number": {
      "type": "string",
      "description": "product style number"
    },
    "season": {
      "type": "string",
      "description": "product season"
    },
    "color": {
      "type": "string",
      "description": "product color"
    },
    "name": {
      "type": "string",
      "description": "product name"
    },
    "brand_id": {
      "type": "string",
      "description": "product external identificator"
    },
    "unique_key": {
      "type": "string",
      "description": "Product unique key"
    },
    "schema_id": {
      "type": "string",
      "description": "product schema id"
    },
    "sizes": {
      "type": "array",
      "description": "product sizes"
    },
    "banners": {
      "type": "array",
      "description": "order banners"
    },
    "size_groups": {
      "type": "array",
      "description": "size groups"
    },
    "available_now": {
      "type": "boolean",
      "description": "whether product is available now"
    },
    "archived": {
      "type": "boolean",
      "description": "whether product was archived"
    },
    "active": {
      "type": "boolean",
      "description": "whether product is active,"
    },
    "description": {
      "type": "string",
      "description": "product description"
    },
    "available_from": {
      "type": "string",
      "description": "date available from"
    },
    "available_until": {
      "type": "string",
      "description": "date available until"
    },
    "order_closing": {
      "type": "string",
      "description": "date order closing"
    },
    "pricing": {
      "type": "object",
      "properties": {
        "USD": {
          "type": "object",
          "properties": {
            "wholesale": {
              "type": "number",
              "description": "wholesale price"
            },
            "retail": {
              "type": "number",
              "description": "retail price"
            },
            "disabled": {
              "type": "boolean",
              "description": "whether price is disabled"
            }
          },
          "required": [
            "wholesale"
          ]
        }
      },
      "description": "product pricing"
    },
    "seasons": {
      "type": "array",
      "description": "product additional seasons"
    }
  },
  "required": [
    "style_number",
    "season",
    "color",
    "name"
  ]
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "style_number": "A396",
  "season": "spring/summer",
  "color": "all black",
  "name": "test",
  "brand_id": "172ak061712-001",
  "unique_key": "A396,spring/summer,all black",
  "schema_id": "537bcbd716af5274043a0992",
  "sizes": [
    {
      "size": "OS",
      "size_group": "A1",
      "pricing": {
        "USD": {
          "wholesale": 10,
          "retail": 12.1,
          "disabled": false
        }
      }
    }
  ],
  "banners": [
    "[583f5196675ef9ac78c1628d]"
  ],
  "size_groups": [
    "[ group1, group2, group3 ]"
  ],
  "available_now": false,
  "archived": false,
  "active": true,
  "description": "awesome product",
  "available_from": "2017/08/30",
  "available_until": "2019/08/30",
  "order_closing": "2017-09-12 00:00:00.000Z",
  "pricing": {
    "USD": {
      "wholesale": 10,
      "retail": 12.1,
      "disabled": false
    }
  },
  "seasons": [
    "[spring, summer, 2018]"
  ],
  "_id": "599611906873730001745011",
  "__size_ids": [
    "[599611906873730001745011]"
  ],
  "modified_on": "2017-09-11T22:30:04.911Z",
  "__inventory_cache": [
    {
      "bucket": "2018/07/25",
      "warehouse": "537bcbd716af5274043a09be",
      "sku_id": "59958be4ffb5c600017a05cb",
      "_id": "59b70e6a01c70700012dbdb8",
      "quantity": 72
    }
  ],
  "__inventory": [
    "[default]"
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "style_number": {
      "type": "string",
      "description": "product style number"
    },
    "season": {
      "type": "string",
      "description": "product season"
    },
    "color": {
      "type": "string",
      "description": "product color"
    },
    "name": {
      "type": "string",
      "description": "product name"
    },
    "brand_id": {
      "type": "string",
      "description": "product external identificator"
    },
    "unique_key": {
      "type": "string",
      "description": "Product unique key"
    },
    "schema_id": {
      "type": "string",
      "description": "product schema id"
    },
    "sizes": {
      "type": "array",
      "description": "product sizes"
    },
    "banners": {
      "type": "array",
      "description": "order banners"
    },
    "size_groups": {
      "type": "array",
      "description": "size groups"
    },
    "available_now": {
      "type": "boolean",
      "description": "whether product is available now"
    },
    "archived": {
      "type": "boolean",
      "description": "whether product was archived"
    },
    "active": {
      "type": "boolean",
      "description": "whether product is active,"
    },
    "description": {
      "type": "string",
      "description": "product description"
    },
    "available_from": {
      "type": "string",
      "description": "date available from"
    },
    "available_until": {
      "type": "string",
      "description": "date available until"
    },
    "order_closing": {
      "type": "string",
      "description": "date order closing"
    },
    "pricing": {
      "type": "object",
      "properties": {
        "USD": {
          "type": "object",
          "properties": {
            "wholesale": {
              "type": "number",
              "description": "wholesale price"
            },
            "retail": {
              "type": "number",
              "description": "retail price"
            },
            "disabled": {
              "type": "boolean",
              "description": "whether price is disabled"
            }
          },
          "required": [
            "wholesale"
          ]
        }
      },
      "description": "product pricing"
    },
    "seasons": {
      "type": "array",
      "description": "product additional seasons"
    },
    "_id": {
      "type": "string",
      "description": "product ID"
    },
    "__size_ids": {
      "type": "array",
      "description": "size ids array"
    },
    "modified_on": {
      "type": "string",
      "description": "last modified date"
    },
    "__inventory_cache": {
      "type": "array",
      "description": "inventory cached data (DEPRECATED, to be removed soon)"
    },
    "__inventory": {
      "type": "array",
      "description": "inventory names"
    }
  },
  "required": [
    "style_number",
    "season",
    "color",
    "name"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Validation error messages'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Another Product already exists with the given brand_id or composite keys.'
}

Create or update Product
PUT`/api/product/new/force`

Example URI

PUT https://nuorder.com/api/product/new/force

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "style_number": "A396",
  "season": "spring/summer",
  "color": "all black",
  "name": "test",
  "brand_id": "172ak061712-001",
  "unique_key": "A396,spring/summer,all black",
  "schema_id": "537bcbd716af5274043a0992",
  "sizes": [
    {
      "size": "OS",
      "size_group": "A1",
      "pricing": {
        "USD": {
          "wholesale": 10,
          "retail": 12.1,
          "disabled": false
        }
      }
    }
  ],
  "banners": [
    "[583f5196675ef9ac78c1628d]"
  ],
  "size_groups": [
    "[ group1, group2, group3 ]"
  ],
  "available_now": false,
  "archived": false,
  "active": true,
  "description": "awesome product",
  "available_from": "2017/08/30",
  "available_until": "2019/08/30",
  "order_closing": "2017-09-12 00:00:00.000Z",
  "pricing": {
    "USD": {
      "wholesale": 10,
      "retail": 12.1,
      "disabled": false
    }
  },
  "seasons": [
    "[spring, summer, 2018]"
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "style_number": {
      "type": "string",
      "description": "product style number"
    },
    "season": {
      "type": "string",
      "description": "product season"
    },
    "color": {
      "type": "string",
      "description": "product color"
    },
    "name": {
      "type": "string",
      "description": "product name"
    },
    "brand_id": {
      "type": "string",
      "description": "product external identificator"
    },
    "unique_key": {
      "type": "string",
      "description": "Product unique key"
    },
    "schema_id": {
      "type": "string",
      "description": "product schema id"
    },
    "sizes": {
      "type": "array",
      "description": "product sizes"
    },
    "banners": {
      "type": "array",
      "description": "order banners"
    },
    "size_groups": {
      "type": "array",
      "description": "size groups"
    },
    "available_now": {
      "type": "boolean",
      "description": "whether product is available now"
    },
    "archived": {
      "type": "boolean",
      "description": "whether product was archived"
    },
    "active": {
      "type": "boolean",
      "description": "whether product is active,"
    },
    "description": {
      "type": "string",
      "description": "product description"
    },
    "available_from": {
      "type": "string",
      "description": "date available from"
    },
    "available_until": {
      "type": "string",
      "description": "date available until"
    },
    "order_closing": {
      "type": "string",
      "description": "date order closing"
    },
    "pricing": {
      "type": "object",
      "properties": {
        "USD": {
          "type": "object",
          "properties": {
            "wholesale": {
              "type": "number",
              "description": "wholesale price"
            },
            "retail": {
              "type": "number",
              "description": "retail price"
            },
            "disabled": {
              "type": "boolean",
              "description": "whether price is disabled"
            }
          },
          "required": [
            "wholesale"
          ]
        }
      },
      "description": "product pricing"
    },
    "seasons": {
      "type": "array",
      "description": "product additional seasons"
    }
  },
  "required": [
    "style_number",
    "season",
    "color",
    "name"
  ]
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "style_number": "A396",
  "season": "spring/summer",
  "color": "all black",
  "name": "test",
  "brand_id": "172ak061712-001",
  "unique_key": "A396,spring/summer,all black",
  "schema_id": "537bcbd716af5274043a0992",
  "sizes": [
    {
      "size": "OS",
      "size_group": "A1",
      "pricing": {
        "USD": {
          "wholesale": 10,
          "retail": 12.1,
          "disabled": false
        }
      }
    }
  ],
  "banners": [
    "[583f5196675ef9ac78c1628d]"
  ],
  "size_groups": [
    "[ group1, group2, group3 ]"
  ],
  "available_now": false,
  "images": [
    "['https://cdn3.nuorder.com/product/65e80a7485b3d940c512672ec777db15.jpg']"
  ],
  "cancelled": false,
  "archived": false,
  "active": true,
  "description": "awesome product",
  "available_from": "2017/08/30",
  "available_until": "2019/08/30",
  "order_closing": "2017-09-12 00:00:00.000Z",
  "pricing": {
    "USD": {
      "wholesale": 10,
      "retail": 12.1,
      "disabled": false
    }
  },
  "seasons": [
    "[spring, summer, 2018]"
  ],
  "_id": "599611906873730001745011",
  "__size_ids": [
    "[599611906873730001745011]"
  ],
  "modified_on": "2017-09-11T22:30:04.911Z",
  "__inventory_cache": [
    {
      "bucket": "2018/07/25",
      "warehouse": "537bcbd716af5274043a09be",
      "sku_id": "59958be4ffb5c600017a05cb",
      "_id": "59b70e6a01c70700012dbdb8",
      "quantity": 72
    }
  ],
  "__inventory": [
    "[default]"
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "style_number": {
      "type": "string",
      "description": "product style number"
    },
    "season": {
      "type": "string",
      "description": "product season"
    },
    "color": {
      "type": "string",
      "description": "product color"
    },
    "name": {
      "type": "string",
      "description": "product name"
    },
    "brand_id": {
      "type": "string",
      "description": "product external identificator"
    },
    "unique_key": {
      "type": "string",
      "description": "Product unique key"
    },
    "schema_id": {
      "type": "string",
      "description": "product schema id"
    },
    "sizes": {
      "type": "array",
      "description": "product sizes"
    },
    "banners": {
      "type": "array",
      "description": "order banners"
    },
    "size_groups": {
      "type": "array",
      "description": "size groups"
    },
    "available_now": {
      "type": "boolean",
      "description": "whether product is available now"
    },
    "images": {
      "type": "array",
      "description": "product images URLs: upload Images via API not supported at this time"
    },
    "cancelled": {
      "type": "boolean",
      "description": "whether product was cancelled"
    },
    "archived": {
      "type": "boolean",
      "description": "whether product was archived"
    },
    "active": {
      "type": "boolean",
      "description": "whether product is active,"
    },
    "description": {
      "type": "string",
      "description": "product description"
    },
    "available_from": {
      "type": "string",
      "description": "date available from"
    },
    "available_until": {
      "type": "string",
      "description": "date available until"
    },
    "order_closing": {
      "type": "string",
      "description": "date order closing"
    },
    "pricing": {
      "type": "object",
      "properties": {
        "USD": {
          "type": "object",
          "properties": {
            "wholesale": {
              "type": "number",
              "description": "wholesale price"
            },
            "retail": {
              "type": "number",
              "description": "retail price"
            },
            "disabled": {
              "type": "boolean",
              "description": "whether price is disabled"
            }
          },
          "required": [
            "wholesale"
          ]
        }
      },
      "description": "product pricing"
    },
    "seasons": {
      "type": "array",
      "description": "product additional seasons"
    },
    "_id": {
      "type": "string",
      "description": "product ID"
    },
    "__size_ids": {
      "type": "array",
      "description": "size ids array"
    },
    "modified_on": {
      "type": "string",
      "description": "last modified date"
    },
    "__inventory_cache": {
      "type": "array",
      "description": "inventory cached data (DEPRECATED, to be removed soon)"
    },
    "__inventory": {
      "type": "array",
      "description": "inventory names"
    }
  },
  "required": [
    "style_number",
    "season",
    "color",
    "name",
    "sizes",
    "pricing"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Validation error message'
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Change Product status by ID
POST`/api/product/{status}/{id}`

Example URI

POST https://nuorder.com/api/product/restore/59523f99cf355d0001e75f43

URI Parameters

HideShow

status

string (required) Example: restore

product status

Choices: archive cancel unarchive restore

id

string (required) Example: 59523f99cf355d0001e75f43

product id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    'success': true
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Product not found'
}

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
    code: 409,
    message: 'Another product already exists with the given composite keys.'
}

Change Product status by external ID
POST`/api/product/{status}/external_id/{external_id}`

Example URI

POST https://nuorder.com/api/product/restore/external_id/888RED

URI Parameters

HideShow

status

string (required) Example: restore

product status

Choices: archive cancel unarchive restore

external_id

string (required) Example: 888RED

product external id

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    'success': true
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404,
    message: 'Product not found'
}

Replenishment Collection ¶

APIs for managing your Replenishments.

IMPORTANT You must use the PUT - /api/inventory/flags API endpoint to update your filters if you manage your inventory through these replenishment endpoints.

List All Replenishments
GET`/api/v3.0/warehouses/skus/replenishments{?sku_id,rollup,populate,__company}`

Example URI

GET https://nuorder.com/api/v3.0/warehouses/skus/replenishments?sku_id=58beec6230c543013d31ef5c&__rollup=true&__populate=__available&__company=58bf12ef30c543013d31ef5d

URI Parameters

HideShow

sku_id

string (required) Example: 58beec6230c543013d31ef5c

SKU ID (can be added multiple times)

__rollup

boolean (optional) Default: false Example: true

Roll past dates into one “Available to Sell” replenishment

__populate

enum (optional) Example: __available

Populate options. __available will include available inventory calculation

Choices: __available

__company

string (optional) Example: 58bf12ef30c543013d31ef5d

Company ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": "58beeb1230c543013d31ef5a",
    "warehouse_id": "58beec5330c543013d31ef5b",
    "sku_id": "58beec6230c543013d31ef5c",
    "created_on": 148890683000,
    "modified_on": 148890683000,
    "display_name": "Replenishment Name",
    "prebook": false,
    "period_start": 1488326400000,
    "period_end": 1490918400000,
    "quantity": 100,
    "active": true
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

List Replenishments by Warehouse
GET`/api/v3.0/warehouse/{warehouse_id}/skus/replenishments{?sku_id,rollup,populate,company,limit,last_id}`

Example URI

GET https://nuorder.com/api/v3.0/warehouse/58bdda1730c543013d31ef56/skus/replenishments?sku_id=58beec6230c543013d31ef5c&__rollup=true&__populate=__available&__company=58bf12ef30c543013d31ef5d&limit=100&__last_id=58bf12ef30c543013d31ef5d

URI Parameters

HideShow

warehouse_id

string (required) Example: 58bdda1730c543013d31ef56

Warehouse ID

sku_id

string (required) Example: 58beec6230c543013d31ef5c

SKU ID (can be added multiple times)

__rollup

boolean (optional) Default: false Example: true

Roll past dates into one “Available to Sell” replenishment

__populate

enum (optional) Example: __available

Populate options. __available will include available inventory calculation

Choices: __available

__company

string (optional) Example: 58bf12ef30c543013d31ef5d

Company ID

limit

number (optional) Example: 100

Amount of returned records (value in range 1-1000)

__last_id

string (optional) Example: 58bf12ef30c543013d31ef5d

ID of last replenishment entry fetched (used for fetching next entries)

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": "58beeb1230c543013d31ef5a",
    "warehouse_id": "58beec5330c543013d31ef5b",
    "sku_id": "58beec6230c543013d31ef5c",
    "created_on": 148890683000,
    "modified_on": 148890683000,
    "display_name": "Replenishment Name",
    "prebook": false,
    "period_start": 1488326400000,
    "period_end": 1490918400000,
    "quantity": 100,
    "active": true
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

List Replenishments by Warehouse and SKU
GET`/api/v3.0/warehouse/{warehouse_id}/sku/{sku_id}/replenishments{?rollup,populate,__company}`

Example URI

GET https://nuorder.com/api/v3.0/warehouse/58bdda1730c543013d31ef56/sku/58beec6230c543013d31ef5c/replenishments?__rollup=true&__populate=__available&__company=58bf12ef30c543013d31ef5d

URI Parameters

HideShow

warehouse_id

string (required) Example: 58bdda1730c543013d31ef56

Warehouse ID

sku_id

string (required) Example: 58beec6230c543013d31ef5c

SKU ID (can be added multiple times)

__rollup

boolean (optional) Default: false Example: true

Roll past dates into one “Available to Sell” replenishment

__populate

enum (optional) Example: __available

Populate options. __available will include available inventory calculation

Choices: __available

__company

string (optional) Example: 58bf12ef30c543013d31ef5d

Company ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": "58beeb1230c543013d31ef5a",
    "warehouse_id": "58beec5330c543013d31ef5b",
    "sku_id": "58beec6230c543013d31ef5c",
    "created_on": 148890683000,
    "modified_on": 148890683000,
    "display_name": "Replenishment Name",
    "prebook": false,
    "period_start": 1488326400000,
    "period_end": 1490918400000,
    "quantity": 100,
    "active": true
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Create Replenishment
POST`/api/v3.0/warehouse/{warehouse_id}/sku/{sku_id}/replenishments`

Example URI

POST https://nuorder.com/api/v3.0/warehouse/warehouse_id/sku/sku_id/replenishments

URI Parameters

HideShow

warehouse_id: string (required)
Warehouse ID
sku_id: string (required)
SKU ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
    "warehouse_id": '58beec5330c543013d31ef5b',
    "sku_id": '58beec6230c543013d31ef5c',
    "display_name": 'Prebook',
    "prebook": true,
    "period_start": '3/1/2017',
    "period_end": '3/31/2017',
    "quantity": null,
    "active": true
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "id": "58beeb1230c543013d31ef5a",
  "warehouse_id": "58beec5330c543013d31ef5b",
  "sku_id": "58beec6230c543013d31ef5c",
  "created_on": 148890683000,
  "modified_on": 148890683000,
  "display_name": "Replenishment Name",
  "prebook": false,
  "period_start": 1488326400000,
  "period_end": 1490918400000,
  "quantity": 100,
  "active": true
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The Replenishment ID (24 character hex string)"
    },
    "warehouse_id": {
      "type": "string",
      "description": "The Warehouse ID (24 character hex string)"
    },
    "sku_id": {
      "type": "string",
      "description": "The SKU ID (24 character hex string)"
    },
    "created_on": {
      "type": "number",
      "description": "Milliseconds since epoch"
    },
    "modified_on": {
      "type": "number",
      "description": "Milliseconds since epoch"
    },
    "display_name": {
      "type": "string",
      "description": "The replenishment name"
    },
    "prebook": {
      "type": "boolean",
      "description": "Is this replenishment prebook"
    },
    "period_start": {
      "type": "number",
      "description": "Replenishment start date"
    },
    "period_end": {
      "type": "number",
      "description": "Replenishment end date"
    },
    "quantity": {
      "type": "number",
      "description": "The quantity available for this replenishment (required if `prebook` = `false`)"
    },
    "active": {
      "type": "boolean"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Error message with what field(s) need to be corrected',
    args: {
        /* fields that need to be corrected */
    }
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage replenishments'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Warehouse / SKU not found'
}

Bulk Create Replenishments
POST`/api/v3.0/warehouse/{warehouse_id}/replenishments`

Example URI

POST https://nuorder.com/api/v3.0/warehouse/warehouse_id/replenishments

URI Parameters

HideShow

warehouse_id: string (required)
Warehouse ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "replenishments": [
    {
      "warehouse_id": "5fc100c2b20e3b3eb8f4bfd4",
      "sku_id": "6152ea94faa931bc009def86",
      "prebook": false,
      "period_start": null,
      "period_end": null,
      "quantity": 500
    },
    {
      "warehouse_id": "5fc100c2b20e3b3eb8f4bfd4",
      "sku_id": "6152ea94faa931bc009def86",
      "prebook": true,
      "period_start": "12/02/2023",
      "period_end": "01/30/2024",
      "quantity": null
    },
    {
      "warehouse_id": "5fc100c2b20e3b3eb8f4bfd4",
      "sku_id": "6152ea94faa931bc009def86",
      "prebook": false,
      "period_start": "12/04/2024",
      "period_end": null,
      "quantity": 650
    }
  ]
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": "58beeb1230c543013d31ef5a",
    "warehouse_id": "58beec5330c543013d31ef5b",
    "sku_id": "58beec6230c543013d31ef5c",
    "created_on": 148890683000,
    "modified_on": 148890683000,
    "display_name": "Replenishment Name",
    "prebook": false,
    "period_start": 1488326400000,
    "period_end": 1490918400000,
    "quantity": 100,
    "active": true
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Error message with what field(s) need to be corrected',
    args: {
        /* fields that need to be corrected */
    }
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage replenishments'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Warehouse / SKU not found'
}

Replace Replenishments
PUT`/api/v3.0/warehouse/{warehouse_id}/replenishments`

Upserts replenishments if a match is found, otherwise it creates a new replenishment.

Example URI

PUT https://nuorder.com/api/v3.0/warehouse/warehouse_id/replenishments

URI Parameters

HideShow

warehouse_id: string (required)
Warehouse ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
    replenishments: [
        {
            "warehouse_id": '58beec5330c543013d31ef5b',
            "sku_id": '58beec6230c543013d31ef5c',
            "display_name": 'Prebook',
            "prebook": true,
            "period_start": '3/1/2017',
            "period_end": '3/31/2017',
            "quantity": null,
            "active": true
        }
    ]
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": "58beeb1230c543013d31ef5a",
    "warehouse_id": "58beec5330c543013d31ef5b",
    "sku_id": "58beec6230c543013d31ef5c",
    "created_on": 148890683000,
    "modified_on": 148890683000,
    "display_name": "Replenishment Name",
    "prebook": false,
    "period_start": 1488326400000,
    "period_end": 1490918400000,
    "quantity": 100,
    "active": true
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Error message with what field(s) need to be corrected',
    args: {
        /* fields that need to be corrected */
    }
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage replenishments'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Warehouse / SKU not found'
}

Refresh Inventory Flags
PUT`/api/inventory/flags`

Example URI

PUT https://nuorder.com/api/inventory/flags

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "product_ids": [
    "5aa7d76dfa217edddeaab159"
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "product_ids": {
      "type": "array",
      "description": "product IDs (max 25)"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    success: true
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'product_ids must be an array of 25 elements or less'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403,
    message: 'No permissions for inventory management'
}

Delete a Replenishment
DELETE`/api/v3.0/warehouse/{warehouse_id}/sku/{sku_id}/replenishment/{replenishment_id}`

Example URI

DELETE https://nuorder.com/api/v3.0/warehouse/warehouse_id/sku/sku_id/replenishment/replenishment_id

URI Parameters

HideShow

warehouse_id: string (required)
Warehouse ID
sku_id: string (required)
SKU ID
replenishment_id: string (required)
Replenishment ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    id: '58beeb1230c543013d31ef5a',
    warehouse_id: '58beec5330c543013d31ef5b',
    sku_id: '58beec6230c543013d31ef5c',
    success: true
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage replenishments'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Warehouse, SKU or Replenishment not found'
}

Delete Replenishments by Warehouse and SKU
DELETE`/api/v3.0/warehouse/{warehouse_id}/sku/{sku_id}/replenishments`

Example URI

DELETE https://nuorder.com/api/v3.0/warehouse/warehouse_id/sku/sku_id/replenishments

URI Parameters

HideShow

warehouse_id: string (required)
Warehouse ID
sku_id: string (required)
SKU ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    warehouse_id: '58beec5330c543013d31ef5b',
    sku_id: '58beec6230c543013d31ef5c',
    success: true
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage replenishments'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Warehouse, SKU not found'
}

Delete All Replenishments by Warehouse
DELETE`/api/v3.0/warehouse/{warehouse_id}/replenishments`

Example URI

DELETE https://nuorder.com/api/v3.0/warehouse/warehouse_id/replenishments

URI Parameters

HideShow

warehouse_id: string (required)
Warehouse ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    warehouse_id: '58beec5330c543013d31ef5b',
    success: true
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage replenishments'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Warehouse not found'
}

Schema Collection ¶

APIs for managing your Schemas.

Get All Schemas
GET`/api/schemas`

Example URI

GET https://nuorder.com/api/schemas

Request

HideShow

Headers

Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "_id": "537bcbd716af5274043a0992",
    "active": true,
    "brand": "59f0bdc4949776162469a73d",
    "composite_key_fields": [],
    "name": "Order Schema",
    "type": "order",
    "fields": [
      {
        "_id": "59f0be6f949776162469a73e",
        "key": "some_prop",
        "name": "Some Prop",
        "unique": false,
        "display": true,
        "display_to_buyers": true,
        "filterable": true,
        "searchable": true,
        "required": true,
        "details": {
          "type": "single",
          "subtype": "string",
          "allowed_values": [],
          "formatters": [
            "lowercase",
            "uppercase"
          ],
          "lookup": "''"
        }
      }
    ]
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Get Schema by Type
GET`/api/schemas/{type}`

Example URI

GET https://nuorder.com/api/schemas/order

URI Parameters

HideShow

type

enum (required) Example: order

schema type

Choices: company order product

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "537bcbd716af5274043a0992",
  "active": true,
  "brand": "59f0bdc4949776162469a73d",
  "composite_key_fields": [],
  "name": "Order Schema",
  "type": "order",
  "fields": [
    {
      "_id": "59f0be6f949776162469a73e",
      "key": "some_prop",
      "name": "Some Prop",
      "unique": false,
      "display": true,
      "display_to_buyers": true,
      "filterable": true,
      "searchable": true,
      "required": true,
      "details": {
        "type": "single",
        "subtype": "string",
        "allowed_values": [],
        "formatters": [
          "lowercase",
          "uppercase"
        ],
        "lookup": "''"
      }
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "schema ID"
    },
    "active": {
      "type": "boolean",
      "description": "active state"
    },
    "brand": {
      "type": "string",
      "description": "brand ID"
    },
    "composite_key_fields": {
      "type": "array",
      "description": "unique composite key for entity"
    },
    "name": {
      "type": "string",
      "description": "schema name"
    },
    "type": {
      "type": "string",
      "enum": [
        "company",
        "product"
      ],
      "description": "schema type"
    },
    "fields": {
      "type": "array",
      "description": "schema fields"
    }
  }
}

Get Schema by ID
GET`/api/schema/{id}`

Example URI

GET https://nuorder.com/api/schema/59f0be6f949776162469a73e

URI Parameters

HideShow

id: string (required) Example: 59f0be6f949776162469a73e
schema ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "_id": "537bcbd716af5274043a0992",
  "active": true,
  "brand": "59f0bdc4949776162469a73d",
  "composite_key_fields": [],
  "name": "Order Schema",
  "type": "order",
  "fields": [
    {
      "_id": "59f0be6f949776162469a73e",
      "key": "some_prop",
      "name": "Some Prop",
      "unique": false,
      "display": true,
      "display_to_buyers": true,
      "filterable": true,
      "searchable": true,
      "required": true,
      "details": {
        "type": "single",
        "subtype": "string",
        "allowed_values": [],
        "formatters": [
          "lowercase",
          "uppercase"
        ],
        "lookup": "''"
      }
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "schema ID"
    },
    "active": {
      "type": "boolean",
      "description": "active state"
    },
    "brand": {
      "type": "string",
      "description": "brand ID"
    },
    "composite_key_fields": {
      "type": "array",
      "description": "unique composite key for entity"
    },
    "name": {
      "type": "string",
      "description": "schema name"
    },
    "type": {
      "type": "string",
      "enum": [
        "company",
        "product"
      ],
      "description": "schema type"
    },
    "fields": {
      "type": "array",
      "description": "schema fields"
    }
  }
}

Shipment Collection ¶

APIs for managing your Shipments.

Create a Fulfilled Shipment by Order ID
PUT`/api/order/{id}/shipment`

Example URI

PUT https://nuorder.com/api/order/59e4fad8cddc5c50bffa4189/shipment

URI Parameters

HideShow

id: string (required) Example: 59e4fad8cddc5c50bffa4189
Order ID
reduce: string (optional) Example: backorder
reduce backorder/cancelled shipment quantities according to a new fulfilled shipment
suppress_emails: boolean (optional)
explicitly suppress the shipment email

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "type": "fedex",
  "tracking_numbers": [
    "1Z0000000001"
  ],
  "line_items": [
    {
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "suppress_emails": false
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Shipping type"
    },
    "tracking_numbers": {
      "type": "array",
      "description": "Shipping tracking numbers"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "suppress_emails": {
      "type": "boolean",
      "description": "Explicitly suppress shipment email"
    }
  }
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "ready_to_ship",
  "created_by": "NuORDER API",
  "line_items": [
    {
      "product": "59958be4ffb5c600017a05cc",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "shipment_info": {
    "type": "fedex",
    "tracking_numbers": [
      "1Z0000000001"
    ]
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ready_to_ship"
      ],
      "description": "Shipment status"
    },
    "created_by": {
      "type": "string",
      "description": "creator name"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "shipment_info": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "shipment type"
        },
        "tracking_numbers": {
          "type": "array",
          "description": "Shipping tracking numbers"
        }
      },
      "description": "shipment info"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error message with what field(s) need to be corrected',
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403
    message: 'You do not have permission to create shipments'
}

Create a Fulfilled Shipment by Order Number
PUT`/api/order/number/{number}/shipment`

Example URI

PUT https://nuorder.com/api/order/number/19985624/shipment

URI Parameters

HideShow

number: string (required) Example: 19985624
Order number
reduce: string (optional) Example: backorder
reduce backorder/cancelled shipment quantities according to a new fulfilled shipment
suppress_emails: boolean (optional)
explicitly suppress the shipment email

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "type": "fedex",
  "tracking_numbers": [
    "1Z0000000001"
  ],
  "line_items": [
    {
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "suppress_emails": false
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Shipping type"
    },
    "tracking_numbers": {
      "type": "array",
      "description": "Shipping tracking numbers"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "suppress_emails": {
      "type": "boolean",
      "description": "Explicitly suppress shipment email"
    }
  }
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "ready_to_ship",
  "created_by": "NuORDER API",
  "line_items": [
    {
      "product": "59958be4ffb5c600017a05cc",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "shipment_info": {
    "type": "fedex",
    "tracking_numbers": [
      "1Z0000000001"
    ]
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ready_to_ship"
      ],
      "description": "Shipment status"
    },
    "created_by": {
      "type": "string",
      "description": "creator name"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "shipment_info": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "shipment type"
        },
        "tracking_numbers": {
          "type": "array",
          "description": "Shipping tracking numbers"
        }
      },
      "description": "shipment info"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error message with what field(s) need to be corrected',
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403
    message: 'You do not have permission to create shipments'
}

Create a Backorder Shipment by Order ID
PUT`/api/order/{id}/backorder`

Example URI

PUT https://nuorder.com/api/order/59e4fad8cddc5c50bffa4189/backorder

URI Parameters

HideShow

id: string (required) Example: 59e4fad8cddc5c50bffa4189
Order ID
suppress_emails: boolean (optional)
explicitly suppress the shipment email

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "type": "fedex",
  "tracking_numbers": [
    "1Z0000000001"
  ],
  "line_items": [
    {
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "suppress_emails": false
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Shipping type"
    },
    "tracking_numbers": {
      "type": "array",
      "description": "Shipping tracking numbers"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "suppress_emails": {
      "type": "boolean",
      "description": "Explicitly suppress shipment email"
    }
  }
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "ready_to_ship",
  "created_by": "NuORDER API",
  "line_items": [
    {
      "product": "59958be4ffb5c600017a05cc",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "shipment_info": {
    "type": "fedex",
    "tracking_numbers": [
      "1Z0000000001"
    ]
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ready_to_ship"
      ],
      "description": "Shipment status"
    },
    "created_by": {
      "type": "string",
      "description": "creator name"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "shipment_info": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "shipment type"
        },
        "tracking_numbers": {
          "type": "array",
          "description": "Shipping tracking numbers"
        }
      },
      "description": "shipment info"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error message with what field(s) need to be corrected',
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403
    message: 'You do not have permission to create shipments'
}

Create a Backorder Shipment by Order Number
PUT`/api/order/number/{number}/backorder`

Example URI

PUT https://nuorder.com/api/order/number/19985624/backorder

URI Parameters

HideShow

number: string (required) Example: 19985624
Order number
suppress_emails: boolean (optional)
explicitly suppress the shipment email

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "type": "fedex",
  "tracking_numbers": [
    "1Z0000000001"
  ],
  "line_items": [
    {
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "suppress_emails": false
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Shipping type"
    },
    "tracking_numbers": {
      "type": "array",
      "description": "Shipping tracking numbers"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "suppress_emails": {
      "type": "boolean",
      "description": "Explicitly suppress shipment email"
    }
  }
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "ready_to_ship",
  "created_by": "NuORDER API",
  "line_items": [
    {
      "product": "59958be4ffb5c600017a05cc",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "shipment_info": {
    "type": "fedex",
    "tracking_numbers": [
      "1Z0000000001"
    ]
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ready_to_ship"
      ],
      "description": "Shipment status"
    },
    "created_by": {
      "type": "string",
      "description": "creator name"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "shipment_info": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "shipment type"
        },
        "tracking_numbers": {
          "type": "array",
          "description": "Shipping tracking numbers"
        }
      },
      "description": "shipment info"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error message with what field(s) need to be corrected',
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403
    message: 'You do not have permission to create shipments'
}

Create a Cancelled Shipment by Order Number
PUT`/api/order/number/{number}/cancelled`

Example URI

PUT https://nuorder.com/api/order/number/19985624/cancelled

URI Parameters

HideShow

number: string (required) Example: 19985624
Order number
suppress_emails: boolean (optional)
explicitly suppress the shipment email

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "type": "fedex",
  "tracking_numbers": [
    "1Z0000000001"
  ],
  "line_items": [
    {
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "suppress_emails": false
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Shipping type"
    },
    "tracking_numbers": {
      "type": "array",
      "description": "Shipping tracking numbers"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "suppress_emails": {
      "type": "boolean",
      "description": "Explicitly suppress shipment email"
    }
  }
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "ready_to_ship",
  "created_by": "NuORDER API",
  "line_items": [
    {
      "product": "59958be4ffb5c600017a05cc",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "shipment_info": {
    "type": "fedex",
    "tracking_numbers": [
      "1Z0000000001"
    ]
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ready_to_ship"
      ],
      "description": "Shipment status"
    },
    "created_by": {
      "type": "string",
      "description": "creator name"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "shipment_info": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "shipment type"
        },
        "tracking_numbers": {
          "type": "array",
          "description": "Shipping tracking numbers"
        }
      },
      "description": "shipment info"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error message with what field(s) need to be corrected',
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403
    message: 'You do not have permission to create shipments'
}

Update a Fulfilled Shipment by Order ID and Shipment ID
POST`/api/order/{id}/shipment/{shipmentId}`

Example URI

POST https://nuorder.com/api/order/59e4fad8cddc5c50bffa4189/shipment/59e4fb09cddc5c50bffa418a

URI Parameters

HideShow

id: string (required) Example: 59e4fad8cddc5c50bffa4189
Order ID
shipmentId: string (required) Example: 59e4fb09cddc5c50bffa418a
Shipment ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "type": "fedex",
  "tracking_numbers": [
    "1Z0000000001"
  ],
  "line_items": [
    {
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "suppress_emails": false
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Shipping type"
    },
    "tracking_numbers": {
      "type": "array",
      "description": "Shipping tracking numbers"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "suppress_emails": {
      "type": "boolean",
      "description": "Explicitly suppress shipment email"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "ready_to_ship",
  "created_by": "NuORDER API",
  "line_items": [
    {
      "product": "59958be4ffb5c600017a05cc",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "shipment_info": {
    "type": "fedex",
    "tracking_numbers": [
      "1Z0000000001"
    ]
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ready_to_ship"
      ],
      "description": "Shipment status"
    },
    "created_by": {
      "type": "string",
      "description": "creator name"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "shipment_info": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "shipment type"
        },
        "tracking_numbers": {
          "type": "array",
          "description": "Shipping tracking numbers"
        }
      },
      "description": "shipment info"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error message with what field(s) need to be corrected',
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403
    message: 'You do not have permission to create shipments'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404
    message: 'Order or shipment not found'
}

Update a Fulfilled Shipment by Order Number and Shipment ID
POST`/api/order/number/{id}/shipment/{shipmentId}`

Example URI

POST https://nuorder.com/api/order/number/59e4fad8cddc5c50bffa4189/shipment/59e4fb09cddc5c50bffa418a

URI Parameters

HideShow

id: string (required) Example: 59e4fad8cddc5c50bffa4189
Order ID
shipmentId: string (required) Example: 59e4fb09cddc5c50bffa418a
Shipment ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "type": "fedex",
  "tracking_numbers": [
    "1Z0000000001"
  ],
  "line_items": [
    {
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "suppress_emails": false
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Shipping type"
    },
    "tracking_numbers": {
      "type": "array",
      "description": "Shipping tracking numbers"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "suppress_emails": {
      "type": "boolean",
      "description": "Explicitly suppress shipment email"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "ready_to_ship",
  "created_by": "NuORDER API",
  "line_items": [
    {
      "product": "59958be4ffb5c600017a05cc",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "shipment_info": {
    "type": "fedex",
    "tracking_numbers": [
      "1Z0000000001"
    ]
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ready_to_ship"
      ],
      "description": "Shipment status"
    },
    "created_by": {
      "type": "string",
      "description": "creator name"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "shipment_info": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "shipment type"
        },
        "tracking_numbers": {
          "type": "array",
          "description": "Shipping tracking numbers"
        }
      },
      "description": "shipment info"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error message with what field(s) need to be corrected',
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403
    message: 'You do not have permission to create shipments'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404
    message: 'Order or shipment not found'
}

Update a Fulfilled Shipment Shipment by Tracking Number and Order ID
POST`/api/order/{id}/shipment/tracking/{tracking_number}`

Example URI

POST https://nuorder.com/api/order/59e4fad8cddc5c50bffa4189/shipment/tracking/1Z0000000001

URI Parameters

HideShow

id: string (required) Example: 59e4fad8cddc5c50bffa4189
Order ID
tracking_number: string (required) Example: 1Z0000000001
Tracking number

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "type": "fedex",
  "tracking_numbers": [
    "1Z0000000001"
  ],
  "line_items": [
    {
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "suppress_emails": false
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Shipping type"
    },
    "tracking_numbers": {
      "type": "array",
      "description": "Shipping tracking numbers"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "suppress_emails": {
      "type": "boolean",
      "description": "Explicitly suppress shipment email"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "ready_to_ship",
  "created_by": "NuORDER API",
  "line_items": [
    {
      "product": "59958be4ffb5c600017a05cc",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "shipment_info": {
    "type": "fedex",
    "tracking_numbers": [
      "1Z0000000001"
    ]
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ready_to_ship"
      ],
      "description": "Shipment status"
    },
    "created_by": {
      "type": "string",
      "description": "creator name"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "shipment_info": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "shipment type"
        },
        "tracking_numbers": {
          "type": "array",
          "description": "Shipping tracking numbers"
        }
      },
      "description": "shipment info"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error message with what field(s) need to be corrected',
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403
    message: 'You do not have permission to create shipments'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404
    message: 'Order or shipment not found'
}

Update a Fulfilled Shipment Shipment by Tracking Number and Order Number
POST`/api/order/number/{number}/shipment/tracking/{tracking_number}`

Example URI

POST https://nuorder.com/api/order/number/19985624/shipment/tracking/1Z0000000001

URI Parameters

HideShow

number: string (required) Example: 19985624
Order number
tracking_number: string (required) Example: 1Z0000000001
Tracking number

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "type": "fedex",
  "tracking_numbers": [
    "1Z0000000001"
  ],
  "line_items": [
    {
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "suppress_emails": false
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Shipping type"
    },
    "tracking_numbers": {
      "type": "array",
      "description": "Shipping tracking numbers"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "suppress_emails": {
      "type": "boolean",
      "description": "Explicitly suppress shipment email"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "ready_to_ship",
  "created_by": "NuORDER API",
  "line_items": [
    {
      "product": "59958be4ffb5c600017a05cc",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "shipment_info": {
    "type": "fedex",
    "tracking_numbers": [
      "1Z0000000001"
    ]
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ready_to_ship"
      ],
      "description": "Shipment status"
    },
    "created_by": {
      "type": "string",
      "description": "creator name"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "shipment_info": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "shipment type"
        },
        "tracking_numbers": {
          "type": "array",
          "description": "Shipping tracking numbers"
        }
      },
      "description": "shipment info"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error message with what field(s) need to be corrected',
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403
    message: 'You do not have permission to create shipments'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404
    message: 'Order or shipment not found'
}

Update a Backorder Shipment by Order ID and Shipment ID
POST`/api/order/{id}/backorder/{shipmentId}`

Example URI

POST https://nuorder.com/api/order/59e4fad8cddc5c50bffa4189/backorder/59e4fb09cddc5c50bffa418a

URI Parameters

HideShow

id: string (required) Example: 59e4fad8cddc5c50bffa4189
Order ID
shipmentId: string (required) Example: 59e4fb09cddc5c50bffa418a
Shipment ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "type": "fedex",
  "tracking_numbers": [
    "1Z0000000001"
  ],
  "line_items": [
    {
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "suppress_emails": false
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Shipping type"
    },
    "tracking_numbers": {
      "type": "array",
      "description": "Shipping tracking numbers"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "suppress_emails": {
      "type": "boolean",
      "description": "Explicitly suppress shipment email"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "ready_to_ship",
  "created_by": "NuORDER API",
  "line_items": [
    {
      "product": "59958be4ffb5c600017a05cc",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "shipment_info": {
    "type": "fedex",
    "tracking_numbers": [
      "1Z0000000001"
    ]
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ready_to_ship"
      ],
      "description": "Shipment status"
    },
    "created_by": {
      "type": "string",
      "description": "creator name"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "shipment_info": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "shipment type"
        },
        "tracking_numbers": {
          "type": "array",
          "description": "Shipping tracking numbers"
        }
      },
      "description": "shipment info"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error message with what field(s) need to be corrected',
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403
    message: 'You do not have permission to create shipments'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404
    message: 'Order or shipment not found'
}

Update a Backorder Shipment by Order Number and Shipment ID
POST`/api/order/number/{id}/backorder/{shipmentId}`

Example URI

POST https://nuorder.com/api/order/number/59e4fad8cddc5c50bffa4189/backorder/59e4fb09cddc5c50bffa418a

URI Parameters

HideShow

id: string (required) Example: 59e4fad8cddc5c50bffa4189
Order ID
shipmentId: string (required) Example: 59e4fb09cddc5c50bffa418a
Shipment ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "type": "fedex",
  "tracking_numbers": [
    "1Z0000000001"
  ],
  "line_items": [
    {
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "suppress_emails": false
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Shipping type"
    },
    "tracking_numbers": {
      "type": "array",
      "description": "Shipping tracking numbers"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "suppress_emails": {
      "type": "boolean",
      "description": "Explicitly suppress shipment email"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "ready_to_ship",
  "created_by": "NuORDER API",
  "line_items": [
    {
      "product": "59958be4ffb5c600017a05cc",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "shipment_info": {
    "type": "fedex",
    "tracking_numbers": [
      "1Z0000000001"
    ]
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ready_to_ship"
      ],
      "description": "Shipment status"
    },
    "created_by": {
      "type": "string",
      "description": "creator name"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "shipment_info": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "shipment type"
        },
        "tracking_numbers": {
          "type": "array",
          "description": "Shipping tracking numbers"
        }
      },
      "description": "shipment info"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error message with what field(s) need to be corrected',
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403
    message: 'You do not have permission to create shipments'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404
    message: 'Order or shipment not found'
}

Update a Cancelled Shipment by Order ID and Shipment ID
POST`/api/order/{id}/cancelled/{shipmentId}`

Example URI

POST https://nuorder.com/api/order/59e4fad8cddc5c50bffa4189/cancelled/59e4fb09cddc5c50bffa418a

URI Parameters

HideShow

id: string (required) Example: 59e4fad8cddc5c50bffa4189
Order ID
shipmentId: string (required) Example: 59e4fb09cddc5c50bffa418a
Shipment ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "type": "fedex",
  "tracking_numbers": [
    "1Z0000000001"
  ],
  "line_items": [
    {
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "suppress_emails": false
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Shipping type"
    },
    "tracking_numbers": {
      "type": "array",
      "description": "Shipping tracking numbers"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "suppress_emails": {
      "type": "boolean",
      "description": "Explicitly suppress shipment email"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "ready_to_ship",
  "created_by": "NuORDER API",
  "line_items": [
    {
      "product": "59958be4ffb5c600017a05cc",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "shipment_info": {
    "type": "fedex",
    "tracking_numbers": [
      "1Z0000000001"
    ]
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ready_to_ship"
      ],
      "description": "Shipment status"
    },
    "created_by": {
      "type": "string",
      "description": "creator name"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "shipment_info": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "shipment type"
        },
        "tracking_numbers": {
          "type": "array",
          "description": "Shipping tracking numbers"
        }
      },
      "description": "shipment info"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error message with what field(s) need to be corrected',
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403
    message: 'You do not have permission to create shipments'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404
    message: 'Order or shipment not found'
}

Update a Cancelled Shipment by Order Number and Shipment ID
POST`/api/order/number/{id}/cancelled/{shipmentId}`

Example URI

POST https://nuorder.com/api/order/number/59e4fad8cddc5c50bffa4189/cancelled/59e4fb09cddc5c50bffa418a

URI Parameters

HideShow

id: string (required) Example: 59e4fad8cddc5c50bffa4189
Order ID
shipmentId: string (required) Example: 59e4fb09cddc5c50bffa418a
Shipment ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
  "type": "fedex",
  "tracking_numbers": [
    "1Z0000000001"
  ],
  "line_items": [
    {
      "brand_id": "888RED",
      "season": "Core",
      "style_number": "888",
      "color": "Red",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "suppress_emails": false
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Shipping type"
    },
    "tracking_numbers": {
      "type": "array",
      "description": "Shipping tracking numbers"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "suppress_emails": {
      "type": "boolean",
      "description": "Explicitly suppress shipment email"
    }
  }
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "status": "ready_to_ship",
  "created_by": "NuORDER API",
  "line_items": [
    {
      "product": "59958be4ffb5c600017a05cc",
      "sizes": [
        {
          "size": "Small",
          "quantity": 10
        }
      ]
    }
  ],
  "shipment_info": {
    "type": "fedex",
    "tracking_numbers": [
      "1Z0000000001"
    ]
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "ready_to_ship"
      ],
      "description": "Shipment status"
    },
    "created_by": {
      "type": "string",
      "description": "creator name"
    },
    "line_items": {
      "type": "array",
      "description": "Shipment lines"
    },
    "shipment_info": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "shipment type"
        },
        "tracking_numbers": {
          "type": "array",
          "description": "Shipping tracking numbers"
        }
      },
      "description": "shipment info"
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    code: 400,
    message: 'Error message with what field(s) need to be corrected',
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    code: 403
    message: 'You do not have permission to create shipments'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    code: 404
    message: 'Order or shipment not found'
}

Delete Shipment by Order ID and Shipment ID
DELETE`/api/order/{id}/shipment/{shipment_id}`

Example URI

DELETE https://nuorder.com/api/order/59e4fad8cddc5c50bffa4189/shipment/59e4fad8cddc5c50bffa4188

URI Parameters

HideShow

id: string (required) Example: 59e4fad8cddc5c50bffa4189
Order ID
shipment_id: string (required) Example: 59e4fad8cddc5c50bffa4188
shipment ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    'success': true
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Delete Shipment by Order ID and Tracking Number
DELETE`/api/order/{id}/shipment/tracking/{tracking_number}`

Example URI

DELETE https://nuorder.com/api/order/59e4fad8cddc5c50bffa4189/shipment/tracking/1Z0000000001

URI Parameters

HideShow

id: string (required) Example: 59e4fad8cddc5c50bffa4189
Order ID
tracking_number: string (required) Example: 1Z0000000001
Tracking number

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    'success': true
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Delete Shipment by Order Number and Shipment ID
DELETE`/api/order/number/{number}/shipment/{shipment_id}`

Example URI

DELETE https://nuorder.com/api/order/number/19985624/shipment/59e4fad8cddc5c50bffa4188

URI Parameters

HideShow

number: string (required) Example: 19985624
Order number
shipment_id: string (required) Example: 59e4fad8cddc5c50bffa4188
shipment ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    'success': true
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Delete Shipment by Order Number and Tracking Number
DELETE`/api/order/number/{number}/shipment/tracking/{tracking_number}`

Example URI

DELETE https://nuorder.com/api/order/number/19985624/shipment/tracking/1Z0000000001

URI Parameters

HideShow

number: string (required) Example: 19985624
Order number
tracking_number: string (required) Example: 1Z0000000001
Tracking number

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    'success': true
}

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
    code: 401,
    message: 'Invalid permissions'
}

Warehouse Collection ¶

APIs for managing your Warehouses.

List All Warehouses
GET`/api/v3.0/warehouses{?__company,sku_id,code}`

Example URI

GET https://nuorder.com/api/v3.0/warehouses?__company=58bf12ef30c543013d31ef5d&sku_id=58beec6230c543013d31ef5c&code=001

URI Parameters

HideShow

sku_id: string (optional) Example: 58beec6230c543013d31ef5c
SKU ID
code: string (optional) Example: 001
Warehouse Code
__company: string (optional) Example: 58bf12ef30c543013d31ef5d
Company ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": "58bdda1730c543013d31ef56",
    "brand_id": "58bdddf430c543013d31ef59",
    "display_name": "Warehouse Name",
    "created_on": 148890683000,
    "modified_on": 148890683000,
    "code": "001",
    "sort": 1,
    "active": true
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Create a Warehouse
POST`/api/v3.0/warehouses`

Example URI

POST https://nuorder.com/api/v3.0/warehouses

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
    display_name: 'Warehouse Name',
    code: '001',
    sort: 1
    allows_overselling: false,
}

Response 201

HideShow

Headers

Content-Type: application/json

Body

{
  "id": "58bdda1730c543013d31ef56",
  "brand_id": "58bdddf430c543013d31ef59",
  "display_name": "Warehouse Name",
  "created_on": 148890683000,
  "modified_on": 148890683000,
  "code": "001",
  "sort": 1,
  "active": true
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The Warehouse ID (24 character hex string)"
    },
    "brand_id": {
      "type": "string",
      "description": "The Brand's ID (24 character hex string)"
    },
    "display_name": {
      "type": "string",
      "description": "The warehouse name"
    },
    "created_on": {
      "type": "number",
      "description": "Milliseconds since epoch"
    },
    "modified_on": {
      "type": "number",
      "description": "Milliseconds since epoch"
    },
    "code": {
      "type": "string",
      "description": "The warehouse code (typically the code in your system)"
    },
    "sort": {
      "type": "number",
      "description": "Sort order the warehouse should show"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "display_name"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Error message with what field(s) need to be corrected',
    args: {
        /* fields that need to be corrected */
    }
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage warehouses'
}

Response 409

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Warehouse already exists',
    args: {
        display_name: 'Conflicting Warehouse',
        code: '001'
    }
}

Update a Warehouse
PATCH`/api/v3.0/warehouse/{id}`

Example URI

PATCH https://nuorder.com/api/v3.0/warehouse/58beec5330c543013d31ef5b

URI Parameters

HideShow

id: string (required) Example: 58beec5330c543013d31ef5b
Warehouse ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
    display_name: 'Main Warehouse',
    code: '001',
    sort: 1,
    active: true
}

Request Partial Example

HideShow

This is a PATCH endpoint, so you need only send what changed.

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Body

{
    display_name: 'New Warehouse Name'
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": "58bdda1730c543013d31ef56",
  "brand_id": "58bdddf430c543013d31ef59",
  "display_name": "Warehouse Name",
  "created_on": 148890683000,
  "modified_on": 148890683000,
  "code": "001",
  "sort": 1,
  "active": true
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The Warehouse ID (24 character hex string)"
    },
    "brand_id": {
      "type": "string",
      "description": "The Brand's ID (24 character hex string)"
    },
    "display_name": {
      "type": "string",
      "description": "The warehouse name"
    },
    "created_on": {
      "type": "number",
      "description": "Milliseconds since epoch"
    },
    "modified_on": {
      "type": "number",
      "description": "Milliseconds since epoch"
    },
    "code": {
      "type": "string",
      "description": "The warehouse code (typically the code in your system)"
    },
    "sort": {
      "type": "number",
      "description": "Sort order the warehouse should show"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "display_name"
  ]
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Error message with what field(s) need to be corrected',
    args: {
        /* fields that need to be corrected */
    }
}

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage warehouses'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Warehouse not found',
    {
        id: '58bdda1730c543013d31ef60'
    }
}

Delete a Warehouse
DELETE`/api/v3.0/warehouse/{id}`

Example URI

DELETE https://nuorder.com/api/v3.0/warehouse/id

URI Parameters

HideShow

id: string (required)
Warehouse ID

Request

HideShow

Headers

Content-Type: application/json
Authorization: OAuth 1.0 Authorization Header

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
    id: '58bdda1730c543013d31ef56',
    success: true
}

Response 304

HideShow

Headers

Content-Type: application/json

Response 403

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'You do not have permission to manage warehouses'
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
    message: 'Warehouse not found',
    {
        id: '58bdda1730c543013d31ef60'
    }
}

HTTP Status codes ¶

Custom fields ¶

Code samples ¶

Node.js ¶

Service class ¶

1. Initiate request ¶

2. Token request ¶

3. Get Pending Orders Example ¶

C# ¶

Service class ¶

1. Initiate request ¶

2. Token request ¶

3. Get Pending Orders Example ¶

Authentication ¶

Authentication ¶

OAuth InitiateGET/api/initiate

Example URI

Headers

Headers

Body

Schema

OAuth TokenGET/api/token

Example URI

Headers

Headers

Body

Schema

Buyer Collection ¶

Buyer Collection ¶

Add Buyer to a Company by IDPUT/api/company/{id}/add/buyer

Example URI

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Headers

Body

Headers

Body

Add Buyer to a Company by CodePUT/api/company/code/{code}/add/buyer

Example URI

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Headers

Body

Headers

Body

Update Buyer by Company IDPOST/api/company/{id}/update/buyer/

Example URI

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Headers

Body

Headers

Body

Update Buyer by Company CodePOST/api/company/code/{code}/update/buyer/

Example URI

Headers

Body

Schema

Headers

Body

Schema

Headers

HTTP Status codes

Custom fields

Code samples

Node.js

Service class

1. Initiate request

2. Token request

3. Get Pending Orders Example

C#

Service class

1. Initiate request

2. Token request

3. Get Pending Orders Example

OAuth Initiate
GET`/api/initiate`

OAuth Token
GET`/api/token`

Add Buyer to a Company by ID
PUT`/api/company/{id}/add/buyer`

Add Buyer to a Company by Code
PUT`/api/company/code/{code}/add/buyer`

Update Buyer by Company ID
POST`/api/company/{id}/update/buyer/`

Update Buyer by Company Code
POST`/api/company/code/{code}/update/buyer/`

Remove Buyer by Company ID
DELETE`/api/company/{id}/buyer/{email}`

Remove Buyer by Company Code
DELETE`/api/company/code/{code}/buyer/{email}`

Remove All Buyers by Company ID
DELETE`/api/company/{id}/buyers`

Remove All Buyers by Company Code
DELETE`/api/company/code/{code}/buyers`

Create Catalog
POST`/api/v3.1/catalogs`

Fetch all Catalogs
GET`/api/v3.1/catalogs`

Fetch Catalog by ID
GET`/api/v3.1/catalog/{id}`