Customers

API change history

Provides methods for working with customer objects and data.

Create Customer Order

Creates an Order for the given Customer Id.

You can get the Request Parameter at these calls:

customerId

  • Get Customer IDs
  • Get Customer IDs by Filter

Try it

Request

Request URL

Request parameters

  • string

    The Id of the customer for whom an order will be created.

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Required Fields:

  • CurrencyCode
    • Get Regions displays the country/state codes of the warehouses. If you are concerned about having the proper CurrencyCode, then this will allow you to know what region warehouse support team to call to get the confirmed CurrencyCode.
  • Items*
    • Products: Get Item by Filter
    • Products: Get Item by SKU
    • Products: Get Item by Id
  • Payments*
  • ShipMethodId
    • Orders: Get Shipping Methods
  • ShippingAddress
    • Get Customer
  • StoreId
    • Products: Get Stores

OnFileCard Options:

  • Unknown
  • DoNotSave
  • Primary
  • Secondary
  • OneTimeUse

* At least one object must be present in the array.

{
  "ShipMethodId": 6,
  "StoreId": 3,
  "CurrencyCode": "usd",
  "ShippingAddress": {
    "Street1": "350 S 400 W",
    "City": "Lindon",
    "Region": "UT",
    "PostalCode": "84042",
    "CountryCode": "us"
  },
  "Items": [
    {
      "ItemId": 30,
      "Quantity": 3,
      "IsReward": false
    }
  ],
  "Payments": [
    {
      "Amount": 154.85,
      "SavePaymentMethodId": 1,
      "OnFileCard": "Primary",
      "CurrencyCode": "usd",
      "MerchantId": 99,
      "SavePayment": true,
      "OrderCreditCard": {
        "CardToken": "abc123456",
        "NameOnCard": "Sammy Spacey",
        "Last4": "1234",
        "CardType": "Visa",
        "ExpirationMonth": 12,
        "ExpirationYear": 2022
      }
    }
  ],
  "Custom": {
    "Field1": "Fields 1 - 5",
    "Field5": "Are set here."
  }
}
{
    "Attention": "ATTN: Bob McFerrin",
    "CouponCodes": [
      "Coupon123"
    ],
    "CurrencyCode": "usd",
    "FirstName": "Samuel",
    "Items": [
      {
        "ItemId": 4,
        "Quantity": 1,
        "IsReward": false
      }
    ],
    "LastName": "Spacey",
    "OrderType": 1,
    "PartyId": 1,
    "Payments": [
      {
        "Amount": 10,
        "SavePaymentMethodId": 1,
        "OnFileCard": "DoNotSave",
        "CurrencyCode": "usd",
        "MerchantId": 99, // Test Merchant
        "SavePayment": true,
        "OrderRewardPoints": {
          "Amount": 0
        },
        "OrderCreditCard": {
          "CardToken": "abc123456",
          "NameOnCard": "Sammy Spacey",
          "Last4": "1234",
          "CardType": "Visa",
          "ExpirationMonth": 12,
          "ExpirationYear": 2022
        }
      }
    ],
    "Phone": "801-555-5555",
    "PriceGroup": 1,
    "ShipMethodId": 1,
    "ShippingAddress": {
      "Line1": "555 W Center St",
      "Line2": "Apt 5b",
      "City": "Lindon",
      "State": "UT",
      "Zip": "81234",
      "CountryCode": "us"
    },
    "SpecialInstructions": "Leave it on the porch, please",
    "StoreId": 1,
    "WarehouseId": 1,
    "CountryCode": "us",
    "Custom": {
      "Field1": "Custom Field 1",
      "Field2": "string",
      "Field3": "string",
      "Field4": "string",
      "Field5": "Custom Field 5"
    }
}

Responses

201 Created

Signifies that the Order was created successfully.

Representations

{
  "OrderId": 50306,
  "Total": 40.65,
  "SubTotal": 25.7,
  "TaxTotal": 0,
  "ShippingTotal": 14.95,
  "DiscountTotal": 0,
  "CurrencyCode": null,
  "QvTotal": 0,
  "CvTotal": 0,
  "TaxableSubTotal": 25.7,
  "Items": null
}

404 Not Found

A Customer with the given Customer ID was not found.

500 Internal Server Error

Something went wrong... Here are some possible reasons for this error:

  • Is the model being sent to the API incorrect?
  • Did you forget a required field?
  • Is the API marked as deprecated, and the date has expired?

If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.

Code samples

@ECHO OFF

curl -v -X POST "https://dsapi.directscale.com/v1/customers/{customerId}/orders"
-H "Content-Type: application/json (minimal)"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://dsapi.directscale.com/v1/customers/{customerId}/orders?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://dsapi.directscale.com/v1/customers/{customerId}/orders");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json (minimal)");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://dsapi.directscale.com/v1/customers/{customerId}/orders?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json (minimal)");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://dsapi.directscale.com/v1/customers/{customerId}/orders";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json (minimal)" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://dsapi.directscale.com/v1/customers/{customerId}/orders');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json (minimal)',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

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

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json (minimal)',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('dsapi.directscale.com')
    conn.request("POST", "/v1/customers/{customerId}/orders?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json (minimal)',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('dsapi.directscale.com')
    conn.request("POST", "/v1/customers/{customerId}/orders?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://dsapi.directscale.com/v1/customers/{customerId}/orders')

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json (minimal)'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

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

puts response.body