Orders API

API change history

Use the Orders API to create new orders, submit forms for orders and change order statuses. Additionally, you can retrieve any orders data from the application.

Add order

Add order

Versioning: V1.2 - added required field CreatedDateTime.

Try it

Request

Request URL

Request parameters

  • (optional)
    boolean

    Should address be geocoded or not

Request headers

  • (optional)
    integer

    Api minor version

  • (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

Creates new order.

{  
   "ExternalOrderId":"0000000040",
   "ExternalClientId":"123",
   "DueDate":"2017-11-19T20:00:00",
   "ServiceType":"Test type",
   "CreatedDateTime":"2017-12-04 3:13:00",
   "Client":{  
      "Contact":{  
         "Name":"Contact name",
         "Email":"contact@email.com",
         "PhoneNumber":"12354234345"
      },
      "Address":{  
         "AddressLine1":null,
         "AddressLine2":null,
         "City":null,
         "RegionCode":null,
         "RegionName":null,
         "PostalCode":null,
         "SubRegionCode":null,
         "SubRegionName":null,
         "CountryCode":null,
         "LatLon":{  
            "Latitude":41.6443349,
            "Longitude":-87.9402669
         }
      }
   },
   "Status":{  
      "EmployeeNumber":"000000006",
      "StatusStartDateTime":"2017-12-04 3:13:00",
      "StatusLabel":"Dispatched"
   },
   "OrderFormFields":[  
      {  
         "Caption":"Text 1",
         "Value":"Test 2"
      },
      {  
         "Caption":"Number 1",
         "Value":222
      }
   ]
}
{
  "example": "{  \n   \"ExternalOrderId\":\"0000000040\",\n   \"ExternalClientId\":\"123\",\n   \"DueDate\":\"2017-11-19T20:00:00\",\n   \"ServiceType\":\"Test type\",\n   \"CreatedDateTime\":\"2017-12-04 3:13:00\",\n   \"Client\":{  \n      \"Contact\":{  \n         \"Name\":\"Contact name\",\n         \"Email\":\"contact@email.com\",\n         \"PhoneNumber\":\"12354234345\"\n      },\n      \"Address\":{  \n         \"AddressLine1\":null,\n         \"AddressLine2\":null,\n         \"City\":null,\n         \"RegionCode\":null,\n         \"RegionName\":null,\n         \"PostalCode\":null,\n         \"SubRegionCode\":null,\n         \"SubRegionName\":null,\n         \"CountryCode\":null,\n         \"LatLon\":{  \n            \"Latitude\":41.6443349,\n            \"Longitude\":-87.9402669\n         }\n      }\n   },\n   \"Status\":{  \n      \"EmployeeNumber\":\"000000006\",\n      \"StatusStartDateTime\":\"2017-12-04 3:13:00\",\n      \"StatusLabel\":\"Dispatched\"\n   },\n   \"OrderFormFields\":[  \n      {  \n         \"Caption\":\"Text 1\",\n         \"Value\":\"Test 2\"\n      },\n      {  \n         \"Caption\":\"Number 1\",\n         \"Value\":222\n      }\n   ]\n}"
}

Responses

201 Created

Order has been created

Representations

{
  "Id": 123456
}

400 Bad Request

Invalid request from the client. Example: missing required parameter for GET method (which is not part of resource name, the latter will result in 404 error). 400 error should be accompanied by error code returned in the body (see format below).

Representations

[  
   {  
      "Code":1,
      "Message":"use-external-id is not valid."
   },
   {  
      "Code":2,
      "Message":"InternalId is not valid. Should be numeric value."
   },
   {  
      "Code":3,
      "Message":"Invalid data format."
   },
   {  
      "Code":4,
      "Message":"ExternalId is empty."
   },
   {  
      "Code":101,
      "Message":"Client with 'External Client ID' not found."
   },
   {  
      "Code":102,
      "Message":"Client with 'External Client ID' already deleted."
   },
   {  
      "Code":103,
      "Message":"Service type not found."
   },
   {  
      "Code":104,
      "Message":"Service type definition not found."
   },
   {  
      "Code":105,
      "Message":"Field caption not found."
   },
   {  
      "Code":106,
      "Message":"Duplicate field captions found."
   },
   {  
      "Code":107,
      "Message":"Company dispatch module does not exist."
   },
   {  
      "Code":108,
      "Message":"User with 'Employee Number' not found."
   },
   {  
      "Code":109,
      "Message":"Order with ExternalId already exists"
   },
   {  
      "Code":110,
      "Message":"ExternalClientId is required."
   },
   {  
      "Code":111,
      "Message":"ExternalOrderId is required."
   },
   {  
      "Code":112,
      "Message":"OrderDate is required."
   },
   {  
      "Code":113,
      "Message":"ServiceTypeName is required."
   },
   {  
      "Code":114,
      "Message":"User with 'Employee Number' already deleted or deactivated"
   },
   {  
      "Code":115,
      "Message":"Required form field not found."
   },
   {  
      "Code":116,
      "Message":"Contact Phone length is not valid."
   },
   {  
      "Code":117,
      "Message":"Contact Name length is not valid."
   },
   {  
      "Code":118,
      "Message":"Contact Email format is not valid."
   },
   {  
      "Code":119,
      "Message":"Latitude\\Longitude values are not valid."
   },
   {  
      "Code":120,
      "Message":"Country not supported."
   },
   {  
      "Code":121,
      "Message":"Region not supported."
   },
   {  
      "Code":122,
      "Message":"DueDateFrom is required."
   },
   {  
      "Code":123,
      "Message":"DueDateTo is required."
   },
   {  
      "Code":124,
      "Message":"ExternalId length is not valid."
   },
   {  
      "Code":125,
      "Message":"Contact Email length is not valid."
   },
   {  
      "Code":126,
      "Message":"Order status not found."
   },
   {  
      "Code":127,
      "Message":"Order cannot be closed."
   },
   {  
      "Code":128,
      "Message":"OrderFormFields are passed but service type has no form."
   },
   {  
      "Code":129,
      "Message":"StatusFormFields are passed but service status has no form."
   },
   {  
      "Code":130,
      "Message":"Client Name length is not valid."
   },
   {  
      "Code":131,
      "Message":"Client Country length is not valid."
   },
   {  
      "Code":132,
      "Message":"Client City length is not valid."
   },
   {  
      "Code":133,
      "Message":"Client Region Code length is not valid."
   },
   {  
      "Code":134,
      "Message":"Client Region Name length is not valid."
   },
   {  
      "Code":135,
      "Message":"Client SubRegion Code length is not valid."
   },
   {  
      "Code":136,
      "Message":"Client SubRegion Name length is not valid."
   },
   {  
      "Code":137,
      "Message":"Client Postal Code length is not valid."
   },
   {  
      "Code":138,
      "Message":"Client Address Line 1 length is not valid."
   },
   {  
      "Code":139,
      "Message":"Client Address Line 2 length is not valid."
   },
   {  
      "Code":140,
      "Message":"Order Status Start Date Time is not unique."
   },
   {  
      "Code":141,
      "Message":"Include status history parameter is not valid. Should be 'true' or 'false'."
   },
   {  
      "Code":142,
      "Message":"Only Dispatched status is allowed for new orders."
   },
   {  
      "Code":143,
      "Message":"RecId parameter can't be used without modifiedTime parameter."
   },
   {  
      "Code":144,
      "Message":"Due date is not valid."
   },
   {  
      "Code":145,
      "Message":"Order Created Date Time is required."
   },
   {  
      "Code":146,
      "Message":"Created date is greater than dispatched time."
   }
]

401 Unauthorized

Unauthorized request.

Representations

422 Unprocessable Entity

Not all methods will return code 422. Please see description of common patterns to see if 422 status code is expected (GET single item, GET lists, GET polling triggers, POST entity, PUT entity, DELETE entity, custom actions). 422 error should be accompanied by error code returned in the body (see format below).

Representations

[  
   {  
      "Code":1,
      "Message":"use-external-id is not valid."
   },
   {  
      "Code":2,
      "Message":"InternalId is not valid. Should be numeric value."
   },
   {  
      "Code":3,
      "Message":"Invalid data format."
   },
   {  
      "Code":4,
      "Message":"ExternalId is empty."
   },
   {  
      "Code":101,
      "Message":"Client with 'External Client ID' not found."
   },
   {  
      "Code":102,
      "Message":"Client with 'External Client ID' already deleted."
   },
   {  
      "Code":103,
      "Message":"Service type not found."
   },
   {  
      "Code":104,
      "Message":"Service type definition not found."
   },
   {  
      "Code":105,
      "Message":"Field caption not found."
   },
   {  
      "Code":106,
      "Message":"Duplicate field captions found."
   },
   {  
      "Code":107,
      "Message":"Company dispatch module does not exist."
   },
   {  
      "Code":108,
      "Message":"User with 'Employee Number' not found."
   },
   {  
      "Code":109,
      "Message":"Order with ExternalId already exists"
   },
   {  
      "Code":110,
      "Message":"ExternalClientId is required."
   },
   {  
      "Code":111,
      "Message":"ExternalOrderId is required."
   },
   {  
      "Code":112,
      "Message":"OrderDate is required."
   },
   {  
      "Code":113,
      "Message":"ServiceTypeName is required."
   },
   {  
      "Code":114,
      "Message":"User with 'Employee Number' already deleted or deactivated"
   },
   {  
      "Code":115,
      "Message":"Required form field not found."
   },
   {  
      "Code":116,
      "Message":"Contact Phone length is not valid."
   },
   {  
      "Code":117,
      "Message":"Contact Name length is not valid."
   },
   {  
      "Code":118,
      "Message":"Contact Email format is not valid."
   },
   {  
      "Code":119,
      "Message":"Latitude\\Longitude values are not valid."
   },
   {  
      "Code":120,
      "Message":"Country not supported."
   },
   {  
      "Code":121,
      "Message":"Region not supported."
   },
   {  
      "Code":122,
      "Message":"DueDateFrom is required."
   },
   {  
      "Code":123,
      "Message":"DueDateTo is required."
   },
   {  
      "Code":124,
      "Message":"ExternalId length is not valid."
   },
   {  
      "Code":125,
      "Message":"Contact Email length is not valid."
   },
   {  
      "Code":126,
      "Message":"Order status not found."
   },
   {  
      "Code":127,
      "Message":"Order cannot be closed."
   },
   {  
      "Code":128,
      "Message":"OrderFormFields are passed but service type has no form."
   },
   {  
      "Code":129,
      "Message":"StatusFormFields are passed but service status has no form."
   },
   {  
      "Code":130,
      "Message":"Client Name length is not valid."
   },
   {  
      "Code":131,
      "Message":"Client Country length is not valid."
   },
   {  
      "Code":132,
      "Message":"Client City length is not valid."
   },
   {  
      "Code":133,
      "Message":"Client Region Code length is not valid."
   },
   {  
      "Code":134,
      "Message":"Client Region Name length is not valid."
   },
   {  
      "Code":135,
      "Message":"Client SubRegion Code length is not valid."
   },
   {  
      "Code":136,
      "Message":"Client SubRegion Name length is not valid."
   },
   {  
      "Code":137,
      "Message":"Client Postal Code length is not valid."
   },
   {  
      "Code":138,
      "Message":"Client Address Line 1 length is not valid."
   },
   {  
      "Code":139,
      "Message":"Client Address Line 2 length is not valid."
   },
   {  
      "Code":140,
      "Message":"Order Status Start Date Time is not unique."
   },
   {  
      "Code":141,
      "Message":"Include status history parameter is not valid. Should be 'true' or 'false'."
   },
   {  
      "Code":142,
      "Message":"Only Dispatched status is allowed for new orders."
   },
   {  
      "Code":143,
      "Message":"RecId parameter can't be used without modifiedTime parameter."
   },
   {  
      "Code":144,
      "Message":"Due date is not valid."
   },
   {  
      "Code":145,
      "Message":"Order Created Date Time is required."
   },
   {  
      "Code":146,
      "Message":"Created date is greater than dispatched time."
   }
]

500 Internal Server Error

This error is always an indication of a bug on the server side, it possibly due to an unhandled exception.

Representations

503 Service Unavailable

Service temporarily unavailable, because other services are temporarily unavailable (such as Azure service, required 3rd party service like Google API).

Representations

Code samples

@ECHO OFF

curl -v -X POST "https://customerapi-encore.actsoft.com/orders/v1/orders?geocode=true"
-H "X-API-Version: 2"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

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

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

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

            // Request parameters
            queryString["geocode"] = "true";
            var uri = "https://customerapi-encore.actsoft.com/orders/v1/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://customerapi-encore.actsoft.com/orders/v1/orders");

            builder.setParameter("geocode", "true");

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


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

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

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

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

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "geocode": "true",
        };
      
        $.ajax({
            url: "https://customerapi-encore.actsoft.com/orders/v1/orders?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("X-API-Version","2");
                xhrObj.setRequestHeader("Content-Type","application/json");
                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://customerapi-encore.actsoft.com/orders/v1/orders";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"geocode=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:@"2" forHTTPHeaderField:@"X-API-Version"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

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

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

$request = new Http_Request2('https://customerapi-encore.actsoft.com/orders/v1/orders');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'geocode' => 'true',
);

$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
    'X-API-Version': '2',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'geocode': 'true',
})

try:
    conn = httplib.HTTPSConnection('customerapi-encore.actsoft.com')
    conn.request("POST", "/orders/v1/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
    'X-API-Version': '2',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'geocode': 'true',
})

try:
    conn = http.client.HTTPSConnection('customerapi-encore.actsoft.com')
    conn.request("POST", "/orders/v1/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://customerapi-encore.actsoft.com/orders/v1/orders')

query = URI.encode_www_form({
    # Request parameters
    'geocode' => 'true'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

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

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

puts response.body