Customer API

API change history

Orders poll

The Order API polling endpoint allows your application to continually poll and process recent changes to orders.
Integration:
This endpoint is designed to work out of the box with Microsoft Flow and Logic Apps as a “polling trigger” integration.Alternatively, you may choose to develop your own custom integration using any language.
Usage:
In a typical scenario, the first request to this endpoint should not provide any parameters. There are two possible successful responses:
HTTP Response code 200 - Recently changed orders exist; response body will display order data.
HTTP Response code 202 – No recently changed orders exist; response body will be empty.
In both cases, there are two important headers in the response:
Location – The URL for the next request.
Retry-After – The recommended time interval in seconds for next request. For example. if there is data to retrieve, the Retry-After header will have a value of 1 or 60. If there is no data to retrieve, the value of the Retry-After header will be 300.
Note: These are just recommended values.Your application may choose to poll at a different frequency depending on your requirements. After the first request, all subsequent requests should use the URL provided in the Location header of the most recent response. No additional parameters should be added to the URL, as it already contains the necessary parameters required to ensure order changes are not missing from the request.

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    Format - date-time (as date-time in RFC3339). Date time in the format of yyyy-MM-ddTHH:mm:ss.ffZ. If it is not provided, it will default the value to DateTime.UtcNow.AddMinutes(-5).

  • (optional)
    integer

    Format - int64. Id of the latest order.

  • (optional)
    boolean

    If true, OrderFormFields will always be an empty array.

Request headers

  • (optional)
    integer

    CustomerAPI minor version

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

A list of orders data is returned in body as json string.

Response headers

  • (optional)
    string

    Time interval in seconds for next request in seconds

202 Accepted

The request is accepted. Do not trigger the workflow. The next attempt happens in one minute.

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": "Internal Id is not valid. Should be a 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."
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}
[
  {
    "Code": 0,
    "Message": "string"
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}
<CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-126>
  <Code>0</Code>
  <Message>string</Message>
</CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-126>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}
<CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-127>
  <Code>0</Code>
  <Message>string</Message>
</CustomerAPI-Infrastructure-ErrorHandling-ResponseErrorArray-127>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "Code": {
        "format": "int32",
        "type": "integer",
        "readOnly": true
      },
      "Message": {
        "type": "string",
        "readOnly": true
      }
    }
  }
}

401 Unauthorized

Unauthorized request.

404 Not Found

Order not found.

500 Internal Server Error

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

503 Service Unavailable

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

Code samples

@ECHO OFF

curl -v -X GET "https://customerapi-encore.actsoft.com/orders/v1/orders/poll?modifiedTime={string}&recId={integer}&excludeFormData={boolean}"
-H "X-API-Version: "
-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", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["modifiedTime"] = "{string}";
            queryString["recId"] = "{integer}";
            queryString["excludeFormData"] = "{boolean}";
            var uri = "https://customerapi-encore.actsoft.com/orders/v1/orders/poll?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // 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/poll");

            builder.setParameter("modifiedTime", "{string}");
            builder.setParameter("recId", "{integer}");
            builder.setParameter("excludeFormData", "{boolean}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("X-API-Version", "");
            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
            "modifiedTime": "{string}",
            "recId": "{integer}",
            "excludeFormData": "{boolean}",
        };
      
        $.ajax({
            url: "https://customerapi-encore.actsoft.com/orders/v1/orders/poll?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("X-API-Version","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // 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/poll";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"modifiedTime={string}",
                         @"recId={integer}",
                         @"excludeFormData={boolean}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"X-API-Version"];
    [_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/poll');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'modifiedTime' => '{string}',
    'recId' => '{integer}',
    'excludeFormData' => '{boolean}',
);

$url->setQueryVariables($parameters);

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

// 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': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'modifiedTime': '{string}',
    'recId': '{integer}',
    'excludeFormData': '{boolean}',
})

try:
    conn = httplib.HTTPSConnection('customerapi-encore.actsoft.com')
    conn.request("GET", "/orders/v1/orders/poll?%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': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'modifiedTime': '{string}',
    'recId': '{integer}',
    'excludeFormData': '{boolean}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'modifiedTime' => '{string}',
    'recId' => '{integer}',
    'excludeFormData' => '{boolean}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['X-API-Version'] = ''
# 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