ARGUS Supply Chain
ARGUS provides a JSON API for third-party integrations.
General Guidelines:
- data is sent/received in the HTTP POST request body, in JSON format
- all datetimes are sent/received in ISO 8601 format and UTC timezone (ex. "2010-04-30 14:50:23", "2010-04-30T14:50:23Z")
Inbound API Methods:
- for security, only HTTPS connections are allowed
- access the method URL using GET to receive a method descriptor, including JSON validation schema, and example data
- methods can be called by sending the required data in JSON format as the POST body
- detailed validation errors are returned in the case of incorrectly formatted input
Outbound Event Messages:
- users may subscribe to event messages by providing a destination HTTP URL
- access the message URL using GET to receive a message descriptor, including JSON validation schema, and example data
- if the status code of the HTTP response is not in the range 200-299 (Success), then the message will be re-sent at intervals
HTTP Examples
Example Request
POST /api/func/DHL/Order/acknowledge HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"created": "2011-11-11 11:11:11"
}
}Example Response (Success)
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
{
"success": true,
"result": "abcdefgh"
}Example Response (Failure)
HTTP/1.1 400 Bad Request
content-type: application/json; charset=utf-8
{
"success": false,
"errormsg": "validation errors: input 'orderID' is not a string"
}Code Examples
Node.js Example
var request = require('request');
var url = "https://dhl.slickss.com/api/func/DHL/Order/acknowledge";
var post = {
"username": "abcdefgh",
"password": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"created": "2011-11-11 11:11:11"
}
};
request({
url: url,
method: "POST",
json: post,
timeout: 1000*30,
headers: {
"content-type": "application/json; charset=utf-8"
}
}, function(err, request, response) {
if (err) return console.error(err);
console.log(response);
});Perl Example
use HTTP::Request::Common;
use JSON;
use LWP::UserAgent;
my $url = "https://dhl.slickss.com/api/func/DHL/Order/acknowledge";
my %post = (
"username" => "abcdefgh",
"password" => "abcdefgh",
"data" => (
"orderID" => "abcdefgh",
"created" => "2011-11-11 11:11:11"
)
);
my $req = HTTP::Request->new("POST", $url);
$req->header("content-type" => "application/json; charset=utf-8");
$req->content(encode_json(\%post));
my $lwp = LWP::UserAgent->new;
my $res = $lwp->request($req);
print $res->decoded_content;PHP Example
$url = "https://dhl.slickss.com/api/func/DHL/Order/acknowledge";
$post = array(
"username" => "abcdefgh",
"password" => "abcdefgh",
"data" => array(
"orderID" => "abcdefgh",
"created" => "2011-11-11 11:11:11"
)
);
$response = file_get_contents($url, false, stream_context_create(array(
"http" => array(
"method" => "POST",
"header" => "content-type: application/json; charset=utf-8\r\n",
"content" => json_encode($post),
"timeout" => 30
)
)));
echo $response;Python2 Example
import json, urllib2
url = "https://dhl.slickss.com/api/func/DHL/Order/acknowledge"
post = {
"username": "abcdefgh",
"password": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"created": "2011-11-11 11:11:11"
}
}
request = urllib2.Request(url)
request.add_header("content-type", "application/json; charset=utf-8")
response = urllib2.urlopen(request, json.dumps(post))
print responseARGUS External Methods
func/DHL/Order/acknowledge
acknowledge that this order has been received by and created in the external system
JSON Descriptor
{
"method": "/api/func/DHL/Order/acknowledge",
"description": "acknowledge that this order has been received by and created in the external system",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
},
"created": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"created": "2011-11-11 11:11:11"
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/acknowledge HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"created": "2011-11-11 11:11:11"
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
func/DHL/Order/activate
confirm manifest and update shipped parts/quantities; note: does not cause the order to be activated
JSON Descriptor
{
"method": "/api/func/DHL/Order/activate",
"description": "confirm manifest and update shipped parts/quantities; note: does not cause the order to be activated",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
},
"orderFields": {
"type": "object",
"required": false,
"properties": {
"customerInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"dispatchInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"specialInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"consolidationNumber": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"customerOrderNumber": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"businessUnit": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"orderReference2": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"orderReference3": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"orderReference4": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"orderReference5": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"orderReference6": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"miscReference1": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"miscReference2": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"miscReference3": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"orderTakenoutDatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"orderPickStartedDatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": false
}
}
},
"orderLines": {
"type": "array",
"required": true,
"items": [
{
"type": "object",
"required": true,
"properties": {
"orderLineID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"orderLineReference": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"shippedPart": {
"type": "object",
"required": true,
"properties": {
"partNumber": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"serialNum": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"licensePlate": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"quantity": {
"type": "integer",
"valueGt": 0,
"required": false
},
"currency": {
"type": "string",
"length": 3,
"unit": "ISO 4217 currency code",
"required": false
},
"value": {
"type": "number",
"valueGte": 0,
"description": "amount per piece",
"required": false
},
"dimensions": {
"type": "object",
"description": "dimensions per piece",
"required": false,
"properties": {
"grossWeight": {
"type": "number",
"valueGt": 0,
"unit": "kg",
"required": false
},
"netWeight": {
"type": "number",
"valueGt": 0,
"unit": "kg",
"required": false
},
"length": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"width": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"height": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"volume": {
"type": "number",
"valueGt": 0,
"unit": "cm³",
"required": false
}
}
},
"heavyPart": {
"type": "boolean",
"required": false
},
"hazardous": {
"type": "boolean",
"required": false
},
"returnable": {
"type": "boolean",
"required": false
}
}
}
}
}
]
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"orderFields": {
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh",
"consolidationNumber": "abcdefgh",
"customerOrderNumber": "abcdefgh",
"businessUnit": "abcdefgh",
"orderReference2": "abcdefgh",
"orderReference3": "abcdefgh",
"orderReference4": "abcdefgh",
"orderReference5": "abcdefgh",
"orderReference6": "abcdefgh",
"miscReference1": "abcdefgh",
"miscReference2": "abcdefgh",
"miscReference3": "abcdefgh",
"orderTakenoutDatetime": "2011-11-11 11:11:11",
"orderPickStartedDatetime": "2011-11-11 11:11:11"
},
"orderLines": [
{
"orderLineID": "abcdefgh",
"orderLineReference": "abcdefgh",
"shippedPart": {
"partNumber": "abcdefgh",
"serialNum": "abcdefgh",
"licensePlate": "abcdefgh",
"quantity": 1,
"currency": "abc",
"value": 0,
"dimensions": {
"grossWeight": 0.1,
"netWeight": 0.1,
"length": 0.1,
"width": 0.1,
"height": 0.1,
"volume": 0.1
},
"heavyPart": true,
"hazardous": true,
"returnable": true
}
}
]
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"result": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed",
"required": true
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"result": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed",
"required": true
},
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/activate HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"orderFields": {
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh",
"consolidationNumber": "abcdefgh",
"customerOrderNumber": "abcdefgh",
"businessUnit": "abcdefgh",
"orderReference2": "abcdefgh",
"orderReference3": "abcdefgh",
"orderReference4": "abcdefgh",
"orderReference5": "abcdefgh",
"orderReference6": "abcdefgh",
"miscReference1": "abcdefgh",
"miscReference2": "abcdefgh",
"miscReference3": "abcdefgh",
"orderTakenoutDatetime": "2011-11-11 11:11:11",
"orderPickStartedDatetime": "2011-11-11 11:11:11"
},
"orderLines": [
{
"orderLineID": "abcdefgh",
"orderLineReference": "abcdefgh",
"shippedPart": {
"partNumber": "abcdefgh",
"serialNum": "abcdefgh",
"licensePlate": "abcdefgh",
"quantity": 1,
"currency": "abc",
"value": 0,
"dimensions": {
"grossWeight": 0.1,
"netWeight": 0.1,
"length": 0.1,
"width": 0.1,
"height": 0.1,
"volume": 0.1
},
"heavyPart": true,
"hazardous": true,
"returnable": true
}
}
]
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"result": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed",
"required": true
},
"errormsg": null
}
func/DHL/Order/attachFile
attach file to this order
JSON Descriptor
{
"method": "/api/func/DHL/Order/attachFile",
"description": "attach file to this order",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
},
"fileType": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"description": "MIME Content-Type",
"required": true
},
"fileName": {
"type": "string",
"maxLen": 128,
"trimmedToLen": 128,
"required": true
},
"fileData": {
"type": "string",
"description": "base64-encoded binary data",
"required": true
},
"fileText": {
"type": "string",
"maxLen": 256,
"trimmedToLen": 256,
"description": "short description of this file",
"required": false
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"fileType": "abcdefgh",
"fileName": "abcdefgh",
"fileData": "abcdefgh",
"fileText": "abcdefgh"
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/attachFile HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"fileType": "abcdefgh",
"fileName": "abcdefgh",
"fileData": "abcdefgh",
"fileText": "abcdefgh"
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
func/DHL/Order/cancel
cancel an order
JSON Descriptor
{
"method": "/api/func/DHL/Order/cancel",
"description": "cancel an order",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
},
"orderFields": {
"type": "object",
"required": false,
"properties": {
"customerInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"dispatchInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"specialInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
}
}
},
"reasonCode": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"defValue": "XX",
"required": false
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"orderFields": {
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh"
},
"reasonCode": "abcdefgh"
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"result": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed",
"required": true
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"result": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed",
"required": true
},
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/cancel HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"orderFields": {
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh"
},
"reasonCode": "abcdefgh"
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"result": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed",
"required": true
},
"errormsg": null
}
func/DHL/Order/TMScancel
cancel an order (by TMS)
JSON Descriptor
{
"method": "/api/func/DHL/Order/TMScancel",
"description": "cancel an order (by TMS)",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
},
"orderFields": {
"type": "object",
"required": false,
"properties": {
"customerInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"dispatchInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"specialInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
}
}
},
"reasonCode": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"defValue": "XX",
"required": false
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"orderFields": {
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh"
},
"reasonCode": "abcdefgh"
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"result": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed",
"required": true
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"result": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed",
"required": true
},
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/TMScancel HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"orderFields": {
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh"
},
"reasonCode": "abcdefgh"
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"result": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed",
"required": true
},
"errormsg": null
}
func/DHL/Order/carrierActivate
shipment is assigned a carrier and becomes activatead
JSON Descriptor
{
"method": "/api/func/DHL/Order/carrierActivate",
"description": "shipment is assigned a carrier and becomes activatead",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"shipmentID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"carrierID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"description": "unique argus carrier identifier",
"required": true
},
"carrierServiceLevelID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"description": "unique argus customer service level identifier",
"required": true
},
"orderIDs": {
"type": "array",
"required": true,
"items": [
{
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
}
]
},
"trackingNumber": {
"type": "string",
"maxLen": 256,
"trimmedToLen": 256,
"required": false
},
"requestedDeliveryDatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"shipmentID": "abcdefgh",
"carrierID": "abcdefgh",
"carrierServiceLevelID": "abcdefgh",
"orderIDs": [
"abcdefgh"
],
"trackingNumber": "abcdefgh",
"requestedDeliveryDatetime": "2011-11-11 11:11:11"
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/carrierActivate HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"shipmentID": "abcdefgh",
"carrierID": "abcdefgh",
"carrierServiceLevelID": "abcdefgh",
"orderIDs": [
"abcdefgh"
],
"trackingNumber": "abcdefgh",
"requestedDeliveryDatetime": "2011-11-11 11:11:11"
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
func/DHL/Order/courierAccept
courier has accepted this order (first, activate order if necessary)
JSON Descriptor
{
"method": "/api/func/DHL/Order/courierAccept",
"description": "courier has accepted this order (first, activate order if necessary)",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
},
"accepted": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"courierID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"courierInfo": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"email": {
"type": "string",
"maxLen": 128,
"regexType": "emailAddress",
"trimmedToLen": 128,
"required": false
},
"phone": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
}
}
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"accepted": "2011-11-11 11:11:11",
"courierID": "abcdefgh",
"courierInfo": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/courierAccept HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"accepted": "2011-11-11 11:11:11",
"courierID": "abcdefgh",
"courierInfo": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
func/DHL/Order/courierAssign
assign a courier to this order (first, activate order if necessary)
JSON Descriptor
{
"method": "/api/func/DHL/Order/courierAssign",
"description": "assign a courier to this order (first, activate order if necessary)",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
},
"assigned": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"courierID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"courierInfo": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"email": {
"type": "string",
"maxLen": 128,
"regexType": "emailAddress",
"trimmedToLen": 128,
"required": false
},
"phone": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
}
}
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"assigned": "2011-11-11 11:11:11",
"courierID": "abcdefgh",
"courierInfo": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/courierAssign HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"assigned": "2011-11-11 11:11:11",
"courierID": "abcdefgh",
"courierInfo": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
func/DHL/Order/delivery
report the delivery actual for this order (first, activate order if necessary)
JSON Descriptor
{
"method": "/api/func/DHL/Order/delivery",
"description": "report the delivery actual for this order (first, activate order if necessary)",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
},
"deliveryActual": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"reasonNotOntime": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"description": "reason code; why is the actual early/late",
"required": false
},
"reasonLateInput": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"description": "reason code; why was there a delay in entering the actual",
"required": false
},
"remarkNotOntime": {
"type": "string",
"maxLen": 256,
"trimmedToLen": 256,
"description": "remark; why is the actual early/late",
"required": false
},
"remarkLateInput": {
"type": "string",
"maxLen": 256,
"trimmedToLen": 256,
"description": "remark; why was there a delay in entering the actual",
"required": false
},
"courierLocation": {
"type": "object",
"required": false,
"properties": {
"recorded": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when this position was recorded",
"required": true
},
"lat": {
"type": "number",
"maxPrecision": 8,
"minVal": -90,
"maxVal": 90,
"required": true
},
"lon": {
"type": "number",
"maxPrecision": 8,
"minVal": -180,
"maxVal": 180,
"required": true
}
}
},
"recipient": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "recipient's name",
"required": true
},
"signature": {
"type": "object",
"description": "recipient's signature",
"required": true,
"properties": {
"fileType": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"inValues": [
"image/png",
"image/svg",
"PNG",
"png",
"GIF",
"gif"
],
"description": "MIME Content-Type",
"required": true
},
"fileData": {
"type": "string",
"description": "base64-encoded binary data",
"required": true
}
}
},
"actualDistanceDriven": {
"type": "number",
"unit": "km",
"required": false
},
"gpsDistanceDriven": {
"type": "number",
"unit": "km",
"required": false
},
"deliveryComment": {
"type": "string",
"maxLen": 256,
"trimmedToLen": 256,
"required": false
},
"deliveryAnomaly": {
"type": "boolean",
"required": true
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"deliveryActual": "2011-11-11 11:11:11",
"reasonNotOntime": "abcdefgh",
"reasonLateInput": "abcdefgh",
"remarkNotOntime": "abcdefgh",
"remarkLateInput": "abcdefgh",
"courierLocation": {
"recorded": "2011-11-11 11:11:11",
"lat": 77.0443727,
"lon": 50.56508261
},
"recipient": "abcdefgh",
"signature": {
"fileType": "abcdefgh",
"fileData": "abcdefgh"
},
"actualDistanceDriven": 1.23,
"gpsDistanceDriven": 1.23,
"deliveryComment": "abcdefgh",
"deliveryAnomaly": true
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/delivery HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"deliveryActual": "2011-11-11 11:11:11",
"reasonNotOntime": "abcdefgh",
"reasonLateInput": "abcdefgh",
"remarkNotOntime": "abcdefgh",
"remarkLateInput": "abcdefgh",
"courierLocation": {
"recorded": "2011-11-11 11:11:11",
"lat": 77.0443727,
"lon": 50.56508261
},
"recipient": "abcdefgh",
"signature": {
"fileType": "abcdefgh",
"fileData": "abcdefgh"
},
"actualDistanceDriven": 1.23,
"gpsDistanceDriven": 1.23,
"deliveryComment": "abcdefgh",
"deliveryAnomaly": true
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
func/DHL/Order/deliveryND
report the delivery actual for this order (first, activate order if necessary)
JSON Descriptor
{
"method": "/api/func/DHL/Order/deliveryND",
"description": "report the delivery actual for this order (first, activate order if necessary)",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"shipmentID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"orderIDs": {
"type": "array",
"required": true,
"items": [
{
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
}
]
},
"deliveryActual": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"recipient": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "recipient's name",
"required": true
},
"signature": {
"type": "object",
"description": "recipient's signature",
"required": false,
"properties": {
"fileType": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"inValues": [
"image/png",
"image/svg",
"PNG",
"png",
"GIF",
"gif"
],
"description": "MIME Content-Type",
"required": true
},
"fileData": {
"type": "string",
"description": "base64-encoded binary data",
"required": true
}
}
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"shipmentID": "abcdefgh",
"orderIDs": [
"abcdefgh"
],
"deliveryActual": "2011-11-11 11:11:11",
"recipient": "abcdefgh",
"signature": {
"fileType": "abcdefgh",
"fileData": "abcdefgh"
}
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/deliveryND HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"shipmentID": "abcdefgh",
"orderIDs": [
"abcdefgh"
],
"deliveryActual": "2011-11-11 11:11:11",
"recipient": "abcdefgh",
"signature": {
"fileType": "abcdefgh",
"fileData": "abcdefgh"
}
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
func/DHL/Order/getLastOrderPosition
no description available
JSON Descriptor
{
"method": "/api/func/DHL/Order/getLastOrderPosition",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh"
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"result": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "argus order ID",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed (UTC)",
"required": true
},
"localdatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed (local timezone)",
"required": true
},
"latitude": {
"type": "number",
"maxPrecision": 8,
"minVal": -90,
"maxVal": 90,
"required": true
},
"longitude": {
"type": "number",
"maxPrecision": 8,
"minVal": -180,
"maxVal": 180,
"required": true
}
}
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"result": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "argus order ID",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed (UTC)",
"required": true
},
"localdatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed (local timezone)",
"required": true
},
"latitude": {
"type": "number",
"maxPrecision": 8,
"minVal": -90,
"maxVal": 90,
"required": true
},
"longitude": {
"type": "number",
"maxPrecision": 8,
"minVal": -180,
"maxVal": 180,
"required": true
}
}
},
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/getLastOrderPosition HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh"
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"result": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "argus order ID",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed (UTC)",
"required": true
},
"localdatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed (local timezone)",
"required": true
},
"latitude": {
"type": "number",
"maxPrecision": 8,
"minVal": -90,
"maxVal": 90,
"required": true
},
"longitude": {
"type": "number",
"maxPrecision": 8,
"minVal": -180,
"maxVal": 180,
"required": true
}
}
},
"errormsg": null
}
func/DHL/Order/materialUpdate
update the material on a list of orders
JSON Descriptor
{
"method": "/api/func/DHL/Order/materialUpdate",
"description": "update the material on a list of orders",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"shipmentID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"orderLines": {
"type": "array",
"required": true,
"items": [
{
"type": "object",
"required": true,
"properties": {
"orderLineID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"orderLineReference": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
},
"partDetails": {
"type": "array",
"required": false,
"items": [
{
"type": "object",
"required": true,
"properties": {
"serialNum": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"licensePlate": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"binLoc": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
}
}
}
]
},
"quantity": {
"type": "integer",
"valueGt": 0,
"required": false
},
"requestedPart": {
"type": "object",
"required": true,
"properties": {
"partNumber": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"currency": {
"type": "string",
"length": 3,
"unit": "ISO 4217 currency code",
"required": false
},
"value": {
"type": "number",
"valueGte": 0,
"description": "amount per piece",
"required": false
},
"dimensions": {
"type": "object",
"description": "dimensions per piece",
"required": false,
"properties": {
"grossWeight": {
"type": "number",
"valueGt": 0,
"unit": "kg",
"required": false
},
"netWeight": {
"type": "number",
"valueGt": 0,
"unit": "kg",
"required": false
},
"length": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"width": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"height": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"volume": {
"type": "number",
"valueGt": 0,
"unit": "cm³",
"required": false
}
}
},
"heavyPart": {
"type": "boolean",
"required": false
},
"hazardous": {
"type": "boolean",
"required": false
},
"returnable": {
"type": "boolean",
"required": false
}
}
}
}
}
]
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"shipmentID": "abcdefgh",
"orderLines": [
{
"orderLineID": "abcdefgh",
"orderLineReference": "abcdefgh",
"orderID": "abcdefgh",
"partDetails": [
{
"serialNum": "abcdefgh",
"licensePlate": "abcdefgh",
"binLoc": "abcdefgh"
}
],
"quantity": 1,
"requestedPart": {
"partNumber": "abcdefgh",
"currency": "abc",
"value": 0,
"dimensions": {
"grossWeight": 0.1,
"netWeight": 0.1,
"length": 0.1,
"width": 0.1,
"height": 0.1,
"volume": 0.1
},
"heavyPart": true,
"hazardous": true,
"returnable": true
}
}
]
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/materialUpdate HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"shipmentID": "abcdefgh",
"orderLines": [
{
"orderLineID": "abcdefgh",
"orderLineReference": "abcdefgh",
"orderID": "abcdefgh",
"partDetails": [
{
"serialNum": "abcdefgh",
"licensePlate": "abcdefgh",
"binLoc": "abcdefgh"
}
],
"quantity": 1,
"requestedPart": {
"partNumber": "abcdefgh",
"currency": "abc",
"value": 0,
"dimensions": {
"grossWeight": 0.1,
"netWeight": 0.1,
"length": 0.1,
"width": 0.1,
"height": 0.1,
"volume": 0.1
},
"heavyPart": true,
"hazardous": true,
"returnable": true
}
}
]
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
func/DHL/Order/onsite
report the onsite actual for this order (first, activate order if necessary)
JSON Descriptor
{
"method": "/api/func/DHL/Order/onsite",
"description": "report the onsite actual for this order (first, activate order if necessary)",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
},
"onsiteActual": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"courierLocation": {
"type": "object",
"required": false,
"properties": {
"recorded": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when this position was recorded",
"required": true
},
"lat": {
"type": "number",
"maxPrecision": 8,
"minVal": -90,
"maxVal": 90,
"required": true
},
"lon": {
"type": "number",
"maxPrecision": 8,
"minVal": -180,
"maxVal": 180,
"required": true
}
}
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"onsiteActual": "2011-11-11 11:11:11",
"courierLocation": {
"recorded": "2011-11-11 11:11:11",
"lat": -68.04803729,
"lon": 164.66695428
}
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/onsite HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"onsiteActual": "2011-11-11 11:11:11",
"courierLocation": {
"recorded": "2011-11-11 11:11:11",
"lat": -68.04803729,
"lon": 164.66695428
}
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
func/DHL/Order/pickup
report the pickup actual for this order (first, activate order if necessary)
JSON Descriptor
{
"method": "/api/func/DHL/Order/pickup",
"description": "report the pickup actual for this order (first, activate order if necessary)",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
},
"pickupActual": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"pickupActual": "2011-11-11 11:11:11"
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/pickup HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"pickupActual": "2011-11-11 11:11:11"
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
func/DHL/Order/pickupND
report the pickup actual for this order (first, activate order if necessary)
JSON Descriptor
{
"method": "/api/func/DHL/Order/pickupND",
"description": "report the pickup actual for this order (first, activate order if necessary)",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"shipmentID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"carrierID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"description": "carrier correction (no recalculations)",
"required": false
},
"carrierServiceLevelID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"description": "carrier service level correction (no recalculations)",
"required": false
},
"orderIDs": {
"type": "array",
"required": true,
"items": [
{
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
}
]
},
"trackingNumber": {
"type": "string",
"maxLen": 256,
"trimmedToLen": 256,
"required": false
},
"pickupActual": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"shipmentID": "abcdefgh",
"carrierID": "abcdefgh",
"carrierServiceLevelID": "abcdefgh",
"orderIDs": [
"abcdefgh"
],
"trackingNumber": "abcdefgh",
"pickupActual": "2011-11-11 11:11:11"
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/pickupND HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"shipmentID": "abcdefgh",
"carrierID": "abcdefgh",
"carrierServiceLevelID": "abcdefgh",
"orderIDs": [
"abcdefgh"
],
"trackingNumber": "abcdefgh",
"pickupActual": "2011-11-11 11:11:11"
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
func/DHL/Order/readyForBilling
add extra charges, then mark order as ready for billing
JSON Descriptor
{
"method": "/api/func/DHL/Order/readyForBilling",
"description": "add extra charges, then mark order as ready for billing",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
},
"actualDistanceDriven": {
"type": "number",
"unit": "km",
"required": false
},
"gpsDistanceDriven": {
"type": "number",
"unit": "km",
"required": false
},
"deliveryComment": {
"type": "string",
"maxLen": 256,
"trimmedToLen": 256,
"required": false
},
"deliveryAnomaly": {
"type": "boolean",
"required": true
},
"charges": {
"type": "array",
"required": false,
"items": [
{
"type": "object",
"required": true,
"properties": {
"type": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"cost": {
"type": "number",
"valueGt": 0,
"required": true
},
"currency": {
"type": "string",
"length": 3,
"unit": "ISO 4217 currency code",
"required": true
},
"comment": {
"type": "string",
"maxLen": 256,
"trimmedToLen": 256,
"required": false
}
}
}
]
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"actualDistanceDriven": 1.23,
"gpsDistanceDriven": 1.23,
"deliveryComment": "abcdefgh",
"deliveryAnomaly": true,
"charges": [
{
"type": "abcdefgh",
"cost": 0.1,
"currency": "abc",
"comment": "abcdefgh"
}
]
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/readyForBilling HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"actualDistanceDriven": 1.23,
"gpsDistanceDriven": 1.23,
"deliveryComment": "abcdefgh",
"deliveryAnomaly": true,
"charges": [
{
"type": "abcdefgh",
"cost": 0.1,
"currency": "abc",
"comment": "abcdefgh"
}
]
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
func/DHL/Order/reviseDeadline
revise the delivery deadline for this order (first, activate order if necessary)
JSON Descriptor
{
"method": "/api/func/DHL/Order/reviseDeadline",
"description": "revise the delivery deadline for this order (first, activate order if necessary)",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
},
"revisedDeadline": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"courierLocation": {
"type": "object",
"required": false,
"properties": {
"recorded": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when this position was recorded",
"required": true
},
"lat": {
"type": "number",
"maxPrecision": 8,
"minVal": -90,
"maxVal": 90,
"required": true
},
"lon": {
"type": "number",
"maxPrecision": 8,
"minVal": -180,
"maxVal": 180,
"required": true
}
}
},
"reasonChanged": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"description": "reason code; why has the schedule been changed",
"required": true
},
"reasonLateRev": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"description": "reason code; why has the schedule been changed late",
"required": false
},
"remarkChanged": {
"type": "string",
"maxLen": 256,
"trimmedToLen": 256,
"description": "remark; why has the schedule been changed",
"required": false
},
"remarkLateRev": {
"type": "string",
"maxLen": 256,
"trimmedToLen": 256,
"description": "remark; why has the schedule been changed late",
"required": false
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"revisedDeadline": "2011-11-11 11:11:11",
"courierLocation": {
"recorded": "2011-11-11 11:11:11",
"lat": -71.19022192,
"lon": -114.21715367
},
"reasonChanged": "abcdefgh",
"reasonLateRev": "abcdefgh",
"remarkChanged": "abcdefgh",
"remarkLateRev": "abcdefgh"
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/reviseDeadline HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderID": "abcdefgh",
"revisedDeadline": "2011-11-11 11:11:11",
"courierLocation": {
"recorded": "2011-11-11 11:11:11",
"lat": -71.19022192,
"lon": -114.21715367
},
"reasonChanged": "abcdefgh",
"reasonLateRev": "abcdefgh",
"remarkChanged": "abcdefgh",
"remarkLateRev": "abcdefgh"
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
func/DHL/Order/syncPositions
order tracking: sync one or more GPS positions
JSON Descriptor
{
"method": "/api/func/DHL/Order/syncPositions",
"description": "order tracking: sync one or more GPS positions",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"positions": {
"type": "array",
"valueGt": 0,
"required": true,
"items": [
{
"type": "object",
"required": true,
"properties": {
"shipmentID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"description": "SU Shipmnent ID",
"required": false
},
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": false
},
"recorded": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when this position was recorded",
"required": true
},
"lat": {
"type": "number",
"maxPrecision": 8,
"minVal": -90,
"maxVal": 90,
"required": true
},
"lon": {
"type": "number",
"maxPrecision": 8,
"minVal": -180,
"maxVal": 180,
"required": true
}
}
}
]
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"positions": [
{
"shipmentID": "abcdefgh",
"orderID": "abcdefgh",
"recorded": "2011-11-11 11:11:11",
"lat": 40.6112004,
"lon": 164.47340882
}
]
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/syncPositions HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"positions": [
{
"shipmentID": "abcdefgh",
"orderID": "abcdefgh",
"recorded": "2011-11-11 11:11:11",
"lat": 40.6112004,
"lon": 164.47340882
}
]
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
func/DHL/Order/trackingEvent
order tracking event
JSON Descriptor
{
"method": "/api/func/DHL/Order/trackingEvent",
"description": "order tracking event",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"trackingInfo": {
"type": "array",
"valueGt": 0,
"required": true,
"items": [
{
"type": "object",
"required": true,
"properties": {
"shipmentID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"orderIDs": {
"type": "array",
"required": false,
"items": [
{
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
}
]
},
"trackingEventTime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"trackingEventCode": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"trackingEventDescription": {
"type": "string",
"maxLen": 256,
"trimmedToLen": 256,
"required": false
},
"trackingNumber": {
"type": "string",
"maxLen": 256,
"trimmedToLen": 256,
"required": true
}
}
}
]
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"trackingInfo": [
{
"shipmentID": "abcdefgh",
"orderIDs": [
"abcdefgh"
],
"trackingEventTime": "2011-11-11 11:11:11",
"trackingEventCode": "abcdefgh",
"trackingEventDescription": "abcdefgh",
"trackingNumber": "abcdefgh"
}
]
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/trackingEvent HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"trackingInfo": [
{
"shipmentID": "abcdefgh",
"orderIDs": [
"abcdefgh"
],
"trackingEventTime": "2011-11-11 11:11:11",
"trackingEventCode": "abcdefgh",
"trackingEventDescription": "abcdefgh",
"trackingNumber": "abcdefgh"
}
]
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
func/DHL/Order/upsert
insert or update an order
JSON Descriptor
{
"method": "/api/func/DHL/Order/upsert",
"description": "insert or update an order",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"orderFields": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
},
"sourceSystem": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"principalID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"omsWmsOrderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": true
},
"customerOrderType": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"customerServiceLevel": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"omsWmsServiceLevel": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"standardServiceType": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"requestedDeliveryDatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": false
},
"routeDistance": {
"type": "integer",
"valueGt": 0,
"unit": "km",
"required": false
},
"routeDriveTime": {
"type": "integer",
"valueGt": 0,
"unit": "min",
"required": false
},
"allocationRule": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"requestorID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "order requestor identifier",
"required": false
},
"customerInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"dispatchInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"specialInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"businessUnit": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"consolidationNumber": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"customerOrderNumber": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"orderReference2": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"orderReference3": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"orderReference4": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"orderReference5": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"orderReference6": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"miscReference1": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"miscReference2": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"miscReference3": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"orderCreationDatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"orderAcceptedDatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"orderAssignedDatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": false
}
}
},
"customer": {
"type": "object",
"required": true,
"properties": {
"id": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "UNIQUE customer identifier",
"required": true
},
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "name or description for this customer",
"required": false
},
"contact": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": true
},
"phone": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"email": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"regexType": "emailAddress",
"required": false
}
}
}
}
},
"engineer": {
"type": "object",
"required": false,
"properties": {
"id": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"description": "unique engineer identifier",
"required": true
},
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": true
},
"phone": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"email": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"regexType": "emailAddress",
"required": false
}
}
},
"origin": {
"type": "object",
"required": false,
"properties": {
"shipFromID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"standardID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"wmsOmsID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"customerID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"data": {
"type": "object",
"required": false,
"properties": {
"prov": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"description": "province or state",
"required": false
},
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "name or description for this location",
"required": false
},
"addr": {
"type": "string",
"minLen": 1,
"maxLen": 256,
"trimmedToLen": 256,
"description": "street address",
"required": true
},
"unit": {
"type": "string",
"maxLen": 128,
"trimmedToLen": 128,
"description": "unit, building, apartment",
"required": false
},
"city": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "city name",
"required": true
},
"post": {
"type": "string",
"maxLen": 16,
"trimmedToLen": 16,
"description": "post code/ZIP code, excluding country prefix",
"required": false
},
"ctry": {
"type": "string",
"length": 2,
"description": "country code (ISO 3166-1 alpha-2)",
"required": true
},
"lat": {
"type": "number",
"maxPrecision": 8,
"minVal": -90,
"maxVal": 90,
"required": false
},
"lon": {
"type": "number",
"maxPrecision": 8,
"minVal": -180,
"maxVal": 180,
"required": false
},
"contact": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"email": {
"type": "string",
"maxLen": 64,
"regexType": "emailAddress",
"trimmedToLen": 64,
"required": false
},
"phone": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
}
}
}
}
}
}
},
"destination": {
"type": "object",
"required": true,
"properties": {
"shipToID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"standardID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"wmsOmsID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"customerID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"data": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "name or description for this location",
"required": false
},
"addr": {
"type": "string",
"minLen": 1,
"maxLen": 256,
"trimmedToLen": 256,
"description": "street address",
"required": false
},
"addr4": {
"type": "string",
"trimmedToLen": 256,
"description": "additional address information",
"required": false
},
"prov": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"description": "province or state",
"required": false
},
"unit": {
"type": "string",
"maxLen": 128,
"trimmedToLen": 128,
"description": "unit, building, apartment",
"required": false
},
"city": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "city name",
"required": false
},
"post": {
"type": "string",
"maxLen": 16,
"trimmedToLen": 16,
"description": "post code/ZIP code, excluding country prefix",
"required": false
},
"ctry": {
"type": "string",
"length": 2,
"description": "country code (ISO 3166-1 alpha-2)",
"required": false
},
"lat": {
"type": "number",
"maxPrecision": 8,
"minVal": -90,
"maxVal": 90,
"required": false
},
"lon": {
"type": "number",
"maxPrecision": 8,
"minVal": -180,
"maxVal": 180,
"required": false
},
"contact": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"email": {
"type": "string",
"maxLen": 64,
"regexType": "emailAddress",
"trimmedToLen": 64,
"required": false
},
"phone": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"phone2": {
"type": "string",
"trimmedToLen": 32,
"required": false
}
}
}
}
}
}
},
"orderLines": {
"type": "array",
"required": true,
"items": [
{
"type": "object",
"required": true,
"properties": {
"orderLineID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"orderLineReference": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"requestedPart": {
"type": "object",
"required": true,
"properties": {
"partNumber": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"serialNum": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"licensePlate": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"quantity": {
"type": "integer",
"valueGt": 0,
"required": false
},
"currency": {
"type": "string",
"length": 3,
"unit": "ISO 4217 currency code",
"required": false
},
"value": {
"type": "number",
"valueGte": 0,
"description": "amount per piece",
"required": false
},
"dimensions": {
"type": "object",
"description": "dimensions per piece",
"required": false,
"properties": {
"grossWeight": {
"type": "number",
"valueGt": 0,
"unit": "kg",
"required": false
},
"netWeight": {
"type": "number",
"valueGt": 0,
"unit": "kg",
"required": false
},
"length": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"width": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"height": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"volume": {
"type": "number",
"valueGt": 0,
"unit": "cm³",
"required": false
}
}
},
"heavyPart": {
"type": "boolean",
"required": false
},
"hazardous": {
"type": "boolean",
"required": false
},
"returnable": {
"type": "boolean",
"required": false
},
"productClass": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"UOM": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"pickInstructions": {
"type": "string",
"trimmedToLen": 1024,
"required": false
},
"packInstructions": {
"type": "string",
"trimmedToLen": 1024,
"required": false
}
}
}
}
}
]
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderFields": {
"orderID": "abcdefgh",
"sourceSystem": "abcdefgh",
"principalID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"customerOrderType": "abcdefgh",
"customerServiceLevel": "abcdefgh",
"omsWmsServiceLevel": "abcdefgh",
"standardServiceType": "abcdefgh",
"requestedDeliveryDatetime": "2011-11-11 11:11:11",
"routeDistance": 1,
"routeDriveTime": 1,
"allocationRule": "abcdefgh",
"requestorID": "abcdefgh",
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh",
"businessUnit": "abcdefgh",
"consolidationNumber": "abcdefgh",
"customerOrderNumber": "abcdefgh",
"orderReference2": "abcdefgh",
"orderReference3": "abcdefgh",
"orderReference4": "abcdefgh",
"orderReference5": "abcdefgh",
"orderReference6": "abcdefgh",
"miscReference1": "abcdefgh",
"miscReference2": "abcdefgh",
"miscReference3": "abcdefgh",
"orderCreationDatetime": "2011-11-11 11:11:11",
"orderAcceptedDatetime": "2011-11-11 11:11:11",
"orderAssignedDatetime": "2011-11-11 11:11:11"
},
"customer": {
"id": "abcdefgh",
"name": "abcdefgh",
"contact": {
"name": "abcdefgh",
"phone": "abcdefgh",
"email": "abc@def.gh"
}
},
"engineer": {
"id": "abcdefgh",
"name": "abcdefgh",
"phone": "abcdefgh",
"email": "abc@def.gh"
},
"origin": {
"shipFromID": "abcdefgh",
"standardID": "abcdefgh",
"wmsOmsID": "abcdefgh",
"customerID": "abcdefgh",
"data": {
"prov": "abcdefgh",
"name": "abcdefgh",
"addr": "a",
"unit": "abcdefgh",
"city": "abcdefgh",
"post": "abcdefgh",
"ctry": "ab",
"lat": 76.97666304,
"lon": -7.00776114,
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
}
},
"destination": {
"shipToID": "abcdefgh",
"standardID": "abcdefgh",
"wmsOmsID": "abcdefgh",
"customerID": "abcdefgh",
"data": {
"name": "abcdefgh",
"addr": "a",
"addr4": "abcdefgh",
"prov": "abcdefgh",
"unit": "abcdefgh",
"city": "abcdefgh",
"post": "abcdefgh",
"ctry": "ab",
"lat": 67.24132094,
"lon": -140.63839856,
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh",
"phone2": "abcdefgh"
}
}
},
"orderLines": [
{
"orderLineID": "abcdefgh",
"orderLineReference": "abcdefgh",
"requestedPart": {
"partNumber": "abcdefgh",
"serialNum": "abcdefgh",
"licensePlate": "abcdefgh",
"quantity": 1,
"currency": "abc",
"value": 0,
"dimensions": {
"grossWeight": 0.1,
"netWeight": 0.1,
"length": 0.1,
"width": 0.1,
"height": 0.1,
"volume": 0.1
},
"heavyPart": true,
"hazardous": true,
"returnable": true,
"productClass": "abcdefgh",
"UOM": "abcdefgh",
"pickInstructions": "abcdefgh",
"packInstructions": "abcdefgh"
}
}
]
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"result": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "argus order ID",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed",
"required": true
}
}
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"result": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "argus order ID",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed",
"required": true
}
}
},
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/upsert HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"orderFields": {
"orderID": "abcdefgh",
"sourceSystem": "abcdefgh",
"principalID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"customerOrderType": "abcdefgh",
"customerServiceLevel": "abcdefgh",
"omsWmsServiceLevel": "abcdefgh",
"standardServiceType": "abcdefgh",
"requestedDeliveryDatetime": "2011-11-11 11:11:11",
"routeDistance": 1,
"routeDriveTime": 1,
"allocationRule": "abcdefgh",
"requestorID": "abcdefgh",
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh",
"businessUnit": "abcdefgh",
"consolidationNumber": "abcdefgh",
"customerOrderNumber": "abcdefgh",
"orderReference2": "abcdefgh",
"orderReference3": "abcdefgh",
"orderReference4": "abcdefgh",
"orderReference5": "abcdefgh",
"orderReference6": "abcdefgh",
"miscReference1": "abcdefgh",
"miscReference2": "abcdefgh",
"miscReference3": "abcdefgh",
"orderCreationDatetime": "2011-11-11 11:11:11",
"orderAcceptedDatetime": "2011-11-11 11:11:11",
"orderAssignedDatetime": "2011-11-11 11:11:11"
},
"customer": {
"id": "abcdefgh",
"name": "abcdefgh",
"contact": {
"name": "abcdefgh",
"phone": "abcdefgh",
"email": "abc@def.gh"
}
},
"engineer": {
"id": "abcdefgh",
"name": "abcdefgh",
"phone": "abcdefgh",
"email": "abc@def.gh"
},
"origin": {
"shipFromID": "abcdefgh",
"standardID": "abcdefgh",
"wmsOmsID": "abcdefgh",
"customerID": "abcdefgh",
"data": {
"prov": "abcdefgh",
"name": "abcdefgh",
"addr": "a",
"unit": "abcdefgh",
"city": "abcdefgh",
"post": "abcdefgh",
"ctry": "ab",
"lat": 76.97666304,
"lon": -7.00776114,
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
}
},
"destination": {
"shipToID": "abcdefgh",
"standardID": "abcdefgh",
"wmsOmsID": "abcdefgh",
"customerID": "abcdefgh",
"data": {
"name": "abcdefgh",
"addr": "a",
"addr4": "abcdefgh",
"prov": "abcdefgh",
"unit": "abcdefgh",
"city": "abcdefgh",
"post": "abcdefgh",
"ctry": "ab",
"lat": 67.24132094,
"lon": -140.63839856,
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh",
"phone2": "abcdefgh"
}
}
},
"orderLines": [
{
"orderLineID": "abcdefgh",
"orderLineReference": "abcdefgh",
"requestedPart": {
"partNumber": "abcdefgh",
"serialNum": "abcdefgh",
"licensePlate": "abcdefgh",
"quantity": 1,
"currency": "abc",
"value": 0,
"dimensions": {
"grossWeight": 0.1,
"netWeight": 0.1,
"length": 0.1,
"width": 0.1,
"height": 0.1,
"volume": 0.1
},
"heavyPart": true,
"hazardous": true,
"returnable": true,
"productClass": "abcdefgh",
"UOM": "abcdefgh",
"pickInstructions": "abcdefgh",
"packInstructions": "abcdefgh"
}
}
]
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"result": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "argus order ID",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when action was completed",
"required": true
}
}
},
"errormsg": null
}
func/DHL/Order/warehouseStatus
set the warehouse status of an order
JSON Descriptor
{
"method": "/api/func/DHL/Order/warehouseStatus",
"description": "set the warehouse status of an order",
"encoding": "utf8",
"request": {
"properties": {
"username": {
"type": "string",
"maxLen": 128,
"description": "username as provided by SLiCK",
"required": true
},
"password": {
"type": "string",
"maxLen": 512,
"description": "password as provided by SLiCK",
"required": true
},
"language": {
"defValue": "en",
"type": "string",
"length": 2,
"inValues": [
"de",
"en",
"fr",
"nl"
],
"required": false
},
"data": {
"type": "object",
"description": "an object which is passed to the method as an argument",
"required": true,
"properties": {
"shipmentID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"orderStatus": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"orderIDs": {
"type": "array",
"required": true,
"items": [
{
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
}
]
},
"orderStatusDescription": {
"type": "string",
"maxLen": 512,
"trimmedToLen": 512,
"required": false
},
"orderStatusTime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
}
}
}
},
"example": {
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"shipmentID": "abcdefgh",
"orderStatus": "abcdefgh",
"orderIDs": [
"abcdefgh"
],
"orderStatusDescription": "abcdefgh",
"orderStatusTime": "2011-11-11 11:11:11"
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/func/DHL/Order/warehouseStatus HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"username": "abcdefgh",
"password": "abcdefgh",
"language": "ab",
"data": {
"shipmentID": "abcdefgh",
"orderStatus": "abcdefgh",
"orderIDs": [
"abcdefgh"
],
"orderStatusDescription": "abcdefgh",
"orderStatusTime": "2011-11-11 11:11:11"
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
ARGUS Event Messages
event/DHL/Order/activate
order has been confirmed; note: does not indicate that the order has been activated
JSON Descriptor
{
"method": "/api/event/DHL/Order/activate",
"description": "order has been confirmed; note: does not indicate that the order has been activated",
"encoding": "utf8",
"request": {
"properties": {
"event": {
"type": "string",
"isEqual": "DHL/Order/activate",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"origin": {
"type": "string",
"maxLen": 128,
"description": "host where this event originated from",
"required": true
},
"data": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"description": "unique argus order identifier",
"required": true
},
"shipmentID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"customerID": {
"type": "string",
"maxLen": 32,
"required": true
},
"orderFields": {
"type": "object",
"required": false,
"properties": {
"omsWmsOrderID": {
"type": "string",
"maxLen": 64,
"required": true
},
"customerInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"dispatchInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"specialInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"customerOrderNumber": {
"type": "string",
"maxLen": 64,
"required": false
},
"orderReference2": {
"type": "string",
"maxLen": 64,
"required": false
},
"orderReference3": {
"type": "string",
"maxLen": 64,
"required": false
},
"orderReference4": {
"type": "string",
"maxLen": 64,
"required": false
},
"orderReference5": {
"type": "string",
"maxLen": 64,
"required": false
},
"orderReference6": {
"type": "string",
"maxLen": 64,
"required": false
}
}
},
"origin": {
"type": "object",
"required": false,
"properties": {
"shipFromID": {
"type": "string",
"maxLen": 32,
"required": false
},
"standardID": {
"type": "string",
"maxLen": 32,
"required": false
},
"wmsOmsID": {
"type": "string",
"maxLen": 32,
"required": false
},
"customerID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"data": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "name or description for this location",
"required": false
},
"addr": {
"type": "string",
"minLen": 1,
"maxLen": 256,
"description": "street address",
"required": true
},
"unit": {
"type": "string",
"maxLen": 128,
"description": "unit, building, apartment",
"required": false
},
"city": {
"type": "string",
"maxLen": 64,
"description": "city name",
"required": true
},
"post": {
"type": "string",
"maxLen": 16,
"description": "post code/ZIP code, excluding country prefix",
"required": true
},
"prov": {
"type": "string",
"maxLen": 32,
"description": "province or state",
"required": false
},
"ctry": {
"type": "string",
"length": 2,
"description": "country code (ISO 3166-1 alpha-2)",
"required": true
},
"lat": {
"type": "number",
"maxPrecision": 8,
"minVal": -90,
"maxVal": 90,
"required": true
},
"lon": {
"type": "number",
"maxPrecision": 8,
"minVal": -180,
"maxVal": 180,
"required": true
},
"contact": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": true
},
"email": {
"type": "string",
"maxLen": 64,
"regexType": "emailAddress",
"trimmedToLen": 64,
"required": false
},
"phone": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
}
}
}
}
}
}
},
"orderLines": {
"type": "array",
"required": false,
"items": [
{
"type": "object",
"required": true,
"properties": {
"orderLineID": {
"type": "string",
"maxLen": 32,
"required": false
},
"orderLineReference": {
"type": "string",
"maxLen": 32,
"required": false
},
"shippedPart": {
"type": "object",
"required": true,
"properties": {
"partNumber": {
"type": "string",
"maxLen": 32,
"required": true
},
"serialNum": {
"type": "array",
"required": false,
"items": [
{
"type": "string",
"maxLen": 32,
"required": true
}
]
},
"licensePlate": {
"type": "array",
"required": false,
"items": [
{
"type": "string",
"maxLen": 32,
"required": true
}
]
},
"quantity": {
"type": "integer",
"valueGt": 0,
"required": false
},
"dimensions": {
"type": "object",
"description": "dimensions per piece",
"required": false,
"properties": {
"grossWeight": {
"type": "number",
"valueGt": 0,
"unit": "kg",
"required": false
},
"netWeight": {
"type": "number",
"valueGt": 0,
"unit": "kg",
"required": false
},
"length": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"width": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"height": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"volume": {
"type": "number",
"valueGt": 0,
"unit": "cm³",
"required": false
}
}
},
"heavyPart": {
"type": "boolean",
"required": false
},
"hazardous": {
"type": "boolean",
"required": false
},
"returnable": {
"type": "boolean",
"required": false
}
}
}
}
}
]
}
}
}
},
"example": {
"event": "DHL/Order/activate",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"shipmentID": "abcdefgh",
"customerID": "abcdefgh",
"orderFields": {
"omsWmsOrderID": "abcdefgh",
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh",
"customerOrderNumber": "abcdefgh",
"orderReference2": "abcdefgh",
"orderReference3": "abcdefgh",
"orderReference4": "abcdefgh",
"orderReference5": "abcdefgh",
"orderReference6": "abcdefgh"
},
"origin": {
"shipFromID": "abcdefgh",
"standardID": "abcdefgh",
"wmsOmsID": "abcdefgh",
"customerID": "abcdefgh",
"data": {
"name": "abcdefgh",
"addr": "a",
"unit": "abcdefgh",
"city": "abcdefgh",
"post": "abcdefgh",
"prov": "abcdefgh",
"ctry": "ab",
"lat": 17.4236496,
"lon": -137.91916012,
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
}
},
"orderLines": [
{
"orderLineID": "abcdefgh",
"orderLineReference": "abcdefgh",
"shippedPart": {
"partNumber": "abcdefgh",
"serialNum": [
"abcdefgh"
],
"licensePlate": [
"abcdefgh"
],
"quantity": 1,
"dimensions": {
"grossWeight": 0.1,
"netWeight": 0.1,
"length": 0.1,
"width": 0.1,
"height": 0.1,
"volume": 0.1
},
"heavyPart": true,
"hazardous": true,
"returnable": true
}
}
]
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/event/DHL/Order/activate HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"event": "DHL/Order/activate",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"shipmentID": "abcdefgh",
"customerID": "abcdefgh",
"orderFields": {
"omsWmsOrderID": "abcdefgh",
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh",
"customerOrderNumber": "abcdefgh",
"orderReference2": "abcdefgh",
"orderReference3": "abcdefgh",
"orderReference4": "abcdefgh",
"orderReference5": "abcdefgh",
"orderReference6": "abcdefgh"
},
"origin": {
"shipFromID": "abcdefgh",
"standardID": "abcdefgh",
"wmsOmsID": "abcdefgh",
"customerID": "abcdefgh",
"data": {
"name": "abcdefgh",
"addr": "a",
"unit": "abcdefgh",
"city": "abcdefgh",
"post": "abcdefgh",
"prov": "abcdefgh",
"ctry": "ab",
"lat": 17.4236496,
"lon": -137.91916012,
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
}
},
"orderLines": [
{
"orderLineID": "abcdefgh",
"orderLineReference": "abcdefgh",
"shippedPart": {
"partNumber": "abcdefgh",
"serialNum": [
"abcdefgh"
],
"licensePlate": [
"abcdefgh"
],
"quantity": 1,
"dimensions": {
"grossWeight": 0.1,
"netWeight": 0.1,
"length": 0.1,
"width": 0.1,
"height": 0.1,
"volume": 0.1
},
"heavyPart": true,
"hazardous": true,
"returnable": true
}
}
]
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
event/DHL/Order/cancel
order has been cancelled
JSON Descriptor
{
"method": "/api/event/DHL/Order/cancel",
"description": "order has been cancelled",
"encoding": "utf8",
"request": {
"properties": {
"event": {
"type": "string",
"isEqual": "DHL/Order/cancel",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"origin": {
"type": "string",
"maxLen": 128,
"description": "host where this event originated from",
"required": true
},
"data": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"description": "unique argus order identifier",
"required": true
},
"customerID": {
"type": "string",
"maxLen": 32,
"required": true
},
"omsWmsOrderID": {
"type": "string",
"maxLen": 64,
"required": true
},
"orderFields": {
"type": "object",
"required": false,
"properties": {
"sourceSystem": {
"type": "string",
"maxLen": 32,
"required": true
},
"customerInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"dispatchInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"specialInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
}
}
},
"cancelType": {
"type": "string",
"maxLen": 16,
"inValues": [
"BEFORE_COLLECT",
"AFTER_COLLECT",
"FIRST_ATTEMPT",
"SECOND_ATTEMPT",
"THIRD_ATTEMPT"
],
"required": true
},
"reasonCode": {
"type": "string",
"maxLen": 32,
"required": true
}
}
}
},
"example": {
"event": "DHL/Order/cancel",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"customerID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"orderFields": {
"sourceSystem": "abcdefgh",
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh"
},
"cancelType": "abcdefgh",
"reasonCode": "abcdefgh"
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/event/DHL/Order/cancel HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"event": "DHL/Order/cancel",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"customerID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"orderFields": {
"sourceSystem": "abcdefgh",
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh"
},
"cancelType": "abcdefgh",
"reasonCode": "abcdefgh"
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
event/DHL/Order/deadlineCalculated
delivery deadline has been automatically calculated
JSON Descriptor
{
"method": "/api/event/DHL/Order/deadlineCalculated",
"description": "delivery deadline has been automatically calculated",
"encoding": "utf8",
"request": {
"properties": {
"event": {
"type": "string",
"isEqual": "DHL/Order/deadlineCalculated",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"origin": {
"type": "string",
"maxLen": 128,
"description": "host where this event originated from",
"required": true
},
"data": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"description": "unique argus order identifier",
"required": true
},
"omsWmsOrderID": {
"type": "string",
"maxLen": 64,
"required": true
},
"customerID": {
"type": "string",
"maxLen": 32,
"required": true
},
"deadline": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "deadline datetime",
"required": true
},
"deadlineLocale": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "deadline datetime (in local time)",
"required": true
},
"timezoneLocale": {
"type": "string",
"description": "local timezone",
"required": true
},
"reasonCode": {
"type": "string",
"maxLen": 32,
"description": "reason code; why has the schedule been changed",
"required": false
},
"remark": {
"type": "string",
"maxLen": 256,
"description": "remark; why has the schedule been changed",
"required": false
},
"reasonLateRev": {
"type": "string",
"maxLen": 32,
"description": "reason code; why has the schedule been changed late",
"required": false
},
"remarkLateRev": {
"type": "string",
"maxLen": 256,
"description": "remark; why has the schedule been changed late",
"required": false
},
"predictedDistance": {
"type": "number",
"valueGt": 0,
"unit": "km",
"required": false
}
}
}
},
"example": {
"event": "DHL/Order/deadlineCalculated",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"customerID": "abcdefgh",
"deadline": "2011-11-11 11:11:11",
"deadlineLocale": "2011-11-11 11:11:11",
"timezoneLocale": "abcdefgh",
"reasonCode": "abcdefgh",
"remark": "abcdefgh",
"reasonLateRev": "abcdefgh",
"remarkLateRev": "abcdefgh",
"predictedDistance": 0.1
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/event/DHL/Order/deadlineCalculated HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"event": "DHL/Order/deadlineCalculated",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"customerID": "abcdefgh",
"deadline": "2011-11-11 11:11:11",
"deadlineLocale": "2011-11-11 11:11:11",
"timezoneLocale": "abcdefgh",
"reasonCode": "abcdefgh",
"remark": "abcdefgh",
"reasonLateRev": "abcdefgh",
"remarkLateRev": "abcdefgh",
"predictedDistance": 0.1
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
event/DHL/Order/deadlineRevision
delivery deadline has been manually revised
JSON Descriptor
{
"method": "/api/event/DHL/Order/deadlineRevision",
"description": "delivery deadline has been manually revised",
"encoding": "utf8",
"request": {
"properties": {
"event": {
"type": "string",
"isEqual": "DHL/Order/deadlineRevision",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"origin": {
"type": "string",
"maxLen": 128,
"description": "host where this event originated from",
"required": true
},
"data": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"description": "unique argus order identifier",
"required": true
},
"customerID": {
"type": "string",
"maxLen": 32,
"required": true
},
"omsWmsOrderID": {
"type": "string",
"maxLen": 64,
"required": true
},
"deadline": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "deadline datetime",
"required": true
},
"deadlineLocale": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "deadline datetime (in local time)",
"required": true
},
"timezoneLocale": {
"type": "string",
"description": "local timezone",
"required": true
},
"reasonCode": {
"type": "string",
"maxLen": 32,
"description": "reason code; why has the schedule been changed",
"required": false
},
"remark": {
"type": "string",
"maxLen": 256,
"description": "remark; why has the schedule been changed",
"required": false
},
"reasonLateRev": {
"type": "string",
"maxLen": 32,
"description": "reason code; why has the schedule been changed late",
"required": false
},
"remarkLateRev": {
"type": "string",
"maxLen": 256,
"description": "remark; why has the schedule been changed late",
"required": false
},
"predictedDistance": {
"type": "number",
"valueGt": 0,
"unit": "km",
"required": false
}
}
}
},
"example": {
"event": "DHL/Order/deadlineRevision",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"customerID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"deadline": "2011-11-11 11:11:11",
"deadlineLocale": "2011-11-11 11:11:11",
"timezoneLocale": "abcdefgh",
"reasonCode": "abcdefgh",
"remark": "abcdefgh",
"reasonLateRev": "abcdefgh",
"remarkLateRev": "abcdefgh",
"predictedDistance": 0.1
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/event/DHL/Order/deadlineRevision HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"event": "DHL/Order/deadlineRevision",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"customerID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"deadline": "2011-11-11 11:11:11",
"deadlineLocale": "2011-11-11 11:11:11",
"timezoneLocale": "abcdefgh",
"reasonCode": "abcdefgh",
"remark": "abcdefgh",
"reasonLateRev": "abcdefgh",
"remarkLateRev": "abcdefgh",
"predictedDistance": 0.1
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
event/DHL/Order/insert
order has been created
JSON Descriptor
{
"method": "/api/event/DHL/Order/insert",
"description": "order has been created",
"encoding": "utf8",
"request": {
"properties": {
"event": {
"type": "string",
"isEqual": "DHL/Order/insert",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"origin": {
"type": "string",
"maxLen": 128,
"description": "host where this event originated from",
"required": true
},
"data": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"description": "unique argus order identifier",
"required": true
},
"orderFields": {
"type": "object",
"required": true,
"properties": {
"omsWmsOrderID": {
"type": "string",
"maxLen": 64,
"required": true
},
"sourceSystem": {
"type": "string",
"maxLen": 32,
"required": true
},
"principalID": {
"type": "string",
"maxLen": 32,
"required": true
},
"omsWmsServiceLevel": {
"type": "string",
"maxLen": 32,
"required": false
},
"customerOrderType": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"customerServiceLevel": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"standardServiceType": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"requestedDeliveryDatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": false
},
"routeDistance": {
"type": "integer",
"valueGt": 0,
"unit": "km",
"required": false
},
"routeDriveTime": {
"type": "integer",
"valueGt": 0,
"unit": "min",
"required": false
},
"allocationRule": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"requestorID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "order requestor identifier",
"required": false
},
"customerInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"dispatchInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"specialInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"customerOrderNumber": {
"type": "string",
"maxLen": 64,
"required": false
},
"businessUnit": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"consolidationNumber": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"orderReference2": {
"type": "string",
"maxLen": 64,
"required": false
},
"orderReference3": {
"type": "string",
"maxLen": 64,
"required": false
},
"orderReference4": {
"type": "string",
"maxLen": 64,
"required": false
},
"orderReference5": {
"type": "string",
"maxLen": 64,
"required": false
},
"orderReference6": {
"type": "string",
"maxLen": 64,
"required": false
},
"miscReference1": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"miscReference2": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"miscReference3": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"orderCreationDatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": false
},
"orderAcceptedDatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": false
},
"orderAssignedDatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": false
},
"geofence": {
"defValue": true,
"type": "boolean",
"required": false
},
"dynamicEta": {
"defValue": true,
"type": "boolean",
"required": false
},
"geoRadiusInner": {
"type": "integer",
"valueGte": 0,
"required": false
},
"geoRadiusOuter": {
"type": "integer",
"valueGte": 0,
"required": false
}
}
},
"customer": {
"type": "object",
"required": true,
"properties": {
"id": {
"type": "string",
"maxLen": 32,
"description": "UNIQUE customer identifier",
"required": true
},
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "name or description for this customer",
"required": false
},
"contact": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": true
},
"email": {
"type": "string",
"maxLen": 64,
"regexType": "emailAddress",
"trimmedToLen": 64,
"required": false
},
"phone": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
}
}
}
}
},
"engineer": {
"type": "object",
"required": false,
"properties": {
"id": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"description": "unique engineer identifier",
"required": true
},
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": true
},
"phone": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"email": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"regexType": "emailAddress",
"required": false
}
}
},
"origin": {
"type": "object",
"required": false,
"properties": {
"shipFromID": {
"type": "string",
"maxLen": 32,
"required": false
},
"standardID": {
"type": "string",
"maxLen": 32,
"required": false
},
"wmsOmsID": {
"type": "string",
"maxLen": 32,
"required": false
},
"customerID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"data": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "name or description for this location",
"required": false
},
"addr": {
"type": "string",
"minLen": 1,
"maxLen": 256,
"description": "street address",
"required": true
},
"unit": {
"type": "string",
"maxLen": 128,
"description": "unit, building, apartment",
"required": false
},
"city": {
"type": "string",
"maxLen": 64,
"description": "city name",
"required": true
},
"post": {
"type": "string",
"maxLen": 16,
"description": "post code/ZIP code, excluding country prefix",
"required": true
},
"prov": {
"type": "string",
"maxLen": 32,
"description": "province or state",
"required": false
},
"ctry": {
"type": "string",
"length": 2,
"description": "country code (ISO 3166-1 alpha-2)",
"required": true
},
"lat": {
"type": "number",
"maxPrecision": 8,
"minVal": -90,
"maxVal": 90,
"required": true
},
"lon": {
"type": "number",
"maxPrecision": 8,
"minVal": -180,
"maxVal": 180,
"required": true
},
"contact": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": true
},
"email": {
"type": "string",
"maxLen": 64,
"regexType": "emailAddress",
"trimmedToLen": 64,
"required": false
},
"phone": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
}
}
}
}
}
}
},
"destination": {
"type": "object",
"required": false,
"properties": {
"shipToID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"standardID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"wmsOmsID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"customerID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"data": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "name or description for this location",
"required": false
},
"addr": {
"type": "string",
"minLen": 1,
"maxLen": 256,
"trimmedToLen": 256,
"description": "street address",
"required": true
},
"addr4": {
"type": "string",
"trimmedToLen": 256,
"description": "additional address information",
"required": false
},
"unit": {
"type": "string",
"maxLen": 128,
"description": "unit, building, apartment",
"required": false
},
"city": {
"type": "string",
"maxLen": 64,
"description": "city name",
"required": true
},
"post": {
"type": "string",
"maxLen": 16,
"description": "post code/ZIP code, excluding country prefix",
"required": true
},
"prov": {
"type": "string",
"maxLen": 32,
"description": "province or state",
"required": false
},
"ctry": {
"type": "string",
"length": 2,
"description": "country code (ISO 3166-1 alpha-2)",
"required": true
},
"lat": {
"type": "number",
"maxPrecision": 8,
"minVal": -90,
"maxVal": 90,
"required": true
},
"lon": {
"type": "number",
"maxPrecision": 8,
"minVal": -180,
"maxVal": 180,
"required": true
},
"contact": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": true
},
"email": {
"type": "string",
"maxLen": 64,
"regexType": "emailAddress",
"trimmedToLen": 64,
"required": false
},
"phone": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"phone2": {
"type": "string",
"trimmedToLen": 32,
"required": false
}
}
}
}
}
}
},
"orderLines": {
"type": "array",
"required": false,
"items": [
{
"type": "object",
"required": true,
"properties": {
"orderLineID": {
"type": "string",
"maxLen": 32,
"required": false
},
"orderLineReference": {
"type": "string",
"maxLen": 32,
"required": false
},
"requestedPart": {
"type": "object",
"required": true,
"properties": {
"partNumber": {
"type": "string",
"maxLen": 32,
"required": true
},
"serialNum": {
"type": "string",
"maxLen": 32,
"required": false
},
"licensePlate": {
"type": "string",
"maxLen": 32,
"required": false
},
"quantity": {
"type": "integer",
"valueGt": 0,
"required": false
},
"currency": {
"type": "string",
"length": 3,
"unit": "ISO 4217 currency code",
"required": false
},
"value": {
"type": "number",
"valueGte": 0,
"description": "amount per piece",
"required": false
},
"dimensions": {
"type": "object",
"description": "dimensions per piece",
"required": false,
"properties": {
"grossWeight": {
"type": "number",
"valueGt": 0,
"unit": "kg",
"required": false
},
"netWeight": {
"type": "number",
"valueGt": 0,
"unit": "kg",
"required": false
},
"length": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"width": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"height": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"volume": {
"type": "number",
"valueGt": 0,
"unit": "cm³",
"required": false
}
}
},
"heavyPart": {
"type": "boolean",
"required": false
},
"hazardous": {
"type": "boolean",
"required": false
},
"returnable": {
"type": "boolean",
"required": false
},
"productClass": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"UOM": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"pickInstructions": {
"type": "string",
"trimmedToLen": 1024,
"required": false
},
"packInstructions": {
"type": "string",
"trimmedToLen": 1024,
"required": false
}
}
}
}
}
]
},
"pickupWindow": {
"type": "object",
"required": true,
"properties": {
"from": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"until": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
}
}
},
"deliveryWindow": {
"type": "object",
"required": true,
"properties": {
"from": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"until": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
}
}
},
"predictedDistance": {
"type": "number",
"valueGt": 0,
"unit": "km",
"required": false
},
"predictedDistanceMiles": {
"type": "number",
"valueGt": 0,
"unit": "mi",
"required": false
}
}
}
},
"example": {
"event": "DHL/Order/insert",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"orderFields": {
"omsWmsOrderID": "abcdefgh",
"sourceSystem": "abcdefgh",
"principalID": "abcdefgh",
"omsWmsServiceLevel": "abcdefgh",
"customerOrderType": "abcdefgh",
"customerServiceLevel": "abcdefgh",
"standardServiceType": "abcdefgh",
"requestedDeliveryDatetime": "2011-11-11 11:11:11",
"routeDistance": 1,
"routeDriveTime": 1,
"allocationRule": "abcdefgh",
"requestorID": "abcdefgh",
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh",
"customerOrderNumber": "abcdefgh",
"businessUnit": "abcdefgh",
"consolidationNumber": "abcdefgh",
"orderReference2": "abcdefgh",
"orderReference3": "abcdefgh",
"orderReference4": "abcdefgh",
"orderReference5": "abcdefgh",
"orderReference6": "abcdefgh",
"miscReference1": "abcdefgh",
"miscReference2": "abcdefgh",
"miscReference3": "abcdefgh",
"orderCreationDatetime": "2011-11-11 11:11:11",
"orderAcceptedDatetime": "2011-11-11 11:11:11",
"orderAssignedDatetime": "2011-11-11 11:11:11",
"geofence": true,
"dynamicEta": true,
"geoRadiusInner": 0,
"geoRadiusOuter": 0
},
"customer": {
"id": "abcdefgh",
"name": "abcdefgh",
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
},
"engineer": {
"id": "abcdefgh",
"name": "abcdefgh",
"phone": "abcdefgh",
"email": "abc@def.gh"
},
"origin": {
"shipFromID": "abcdefgh",
"standardID": "abcdefgh",
"wmsOmsID": "abcdefgh",
"customerID": "abcdefgh",
"data": {
"name": "abcdefgh",
"addr": "a",
"unit": "abcdefgh",
"city": "abcdefgh",
"post": "abcdefgh",
"prov": "abcdefgh",
"ctry": "ab",
"lat": -24.21179982,
"lon": 54.28204725,
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
}
},
"destination": {
"shipToID": "abcdefgh",
"standardID": "abcdefgh",
"wmsOmsID": "abcdefgh",
"customerID": "abcdefgh",
"data": {
"name": "abcdefgh",
"addr": "a",
"addr4": "abcdefgh",
"unit": "abcdefgh",
"city": "abcdefgh",
"post": "abcdefgh",
"prov": "abcdefgh",
"ctry": "ab",
"lat": -53.11489801,
"lon": 32.09969442,
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh",
"phone2": "abcdefgh"
}
}
},
"orderLines": [
{
"orderLineID": "abcdefgh",
"orderLineReference": "abcdefgh",
"requestedPart": {
"partNumber": "abcdefgh",
"serialNum": "abcdefgh",
"licensePlate": "abcdefgh",
"quantity": 1,
"currency": "abc",
"value": 0,
"dimensions": {
"grossWeight": 0.1,
"netWeight": 0.1,
"length": 0.1,
"width": 0.1,
"height": 0.1,
"volume": 0.1
},
"heavyPart": true,
"hazardous": true,
"returnable": true,
"productClass": "abcdefgh",
"UOM": "abcdefgh",
"pickInstructions": "abcdefgh",
"packInstructions": "abcdefgh"
}
}
],
"pickupWindow": {
"from": "2011-11-11 11:11:11",
"until": "2011-11-11 11:11:11"
},
"deliveryWindow": {
"from": "2011-11-11 11:11:11",
"until": "2011-11-11 11:11:11"
},
"predictedDistance": 0.1,
"predictedDistanceMiles": 0.1
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/event/DHL/Order/insert HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"event": "DHL/Order/insert",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"orderFields": {
"omsWmsOrderID": "abcdefgh",
"sourceSystem": "abcdefgh",
"principalID": "abcdefgh",
"omsWmsServiceLevel": "abcdefgh",
"customerOrderType": "abcdefgh",
"customerServiceLevel": "abcdefgh",
"standardServiceType": "abcdefgh",
"requestedDeliveryDatetime": "2011-11-11 11:11:11",
"routeDistance": 1,
"routeDriveTime": 1,
"allocationRule": "abcdefgh",
"requestorID": "abcdefgh",
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh",
"customerOrderNumber": "abcdefgh",
"businessUnit": "abcdefgh",
"consolidationNumber": "abcdefgh",
"orderReference2": "abcdefgh",
"orderReference3": "abcdefgh",
"orderReference4": "abcdefgh",
"orderReference5": "abcdefgh",
"orderReference6": "abcdefgh",
"miscReference1": "abcdefgh",
"miscReference2": "abcdefgh",
"miscReference3": "abcdefgh",
"orderCreationDatetime": "2011-11-11 11:11:11",
"orderAcceptedDatetime": "2011-11-11 11:11:11",
"orderAssignedDatetime": "2011-11-11 11:11:11",
"geofence": true,
"dynamicEta": true,
"geoRadiusInner": 0,
"geoRadiusOuter": 0
},
"customer": {
"id": "abcdefgh",
"name": "abcdefgh",
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
},
"engineer": {
"id": "abcdefgh",
"name": "abcdefgh",
"phone": "abcdefgh",
"email": "abc@def.gh"
},
"origin": {
"shipFromID": "abcdefgh",
"standardID": "abcdefgh",
"wmsOmsID": "abcdefgh",
"customerID": "abcdefgh",
"data": {
"name": "abcdefgh",
"addr": "a",
"unit": "abcdefgh",
"city": "abcdefgh",
"post": "abcdefgh",
"prov": "abcdefgh",
"ctry": "ab",
"lat": -24.21179982,
"lon": 54.28204725,
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
}
},
"destination": {
"shipToID": "abcdefgh",
"standardID": "abcdefgh",
"wmsOmsID": "abcdefgh",
"customerID": "abcdefgh",
"data": {
"name": "abcdefgh",
"addr": "a",
"addr4": "abcdefgh",
"unit": "abcdefgh",
"city": "abcdefgh",
"post": "abcdefgh",
"prov": "abcdefgh",
"ctry": "ab",
"lat": -53.11489801,
"lon": 32.09969442,
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh",
"phone2": "abcdefgh"
}
}
},
"orderLines": [
{
"orderLineID": "abcdefgh",
"orderLineReference": "abcdefgh",
"requestedPart": {
"partNumber": "abcdefgh",
"serialNum": "abcdefgh",
"licensePlate": "abcdefgh",
"quantity": 1,
"currency": "abc",
"value": 0,
"dimensions": {
"grossWeight": 0.1,
"netWeight": 0.1,
"length": 0.1,
"width": 0.1,
"height": 0.1,
"volume": 0.1
},
"heavyPart": true,
"hazardous": true,
"returnable": true,
"productClass": "abcdefgh",
"UOM": "abcdefgh",
"pickInstructions": "abcdefgh",
"packInstructions": "abcdefgh"
}
}
],
"pickupWindow": {
"from": "2011-11-11 11:11:11",
"until": "2011-11-11 11:11:11"
},
"deliveryWindow": {
"from": "2011-11-11 11:11:11",
"until": "2011-11-11 11:11:11"
},
"predictedDistance": 0.1,
"predictedDistanceMiles": 0.1
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
event/DHL/Order/kpiReady
order has been collected
JSON Descriptor
{
"method": "/api/event/DHL/Order/kpiReady",
"description": "order has been collected",
"encoding": "utf8",
"request": {
"properties": {
"event": {
"type": "string",
"isEqual": "DHL/Order/kpiReady",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"origin": {
"type": "string",
"maxLen": 128,
"description": "host where this event originated from",
"required": true
},
"data": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"description": "unique argus order identifier",
"required": true
},
"customerID": {
"type": "string",
"maxLen": 32,
"required": true
},
"omsWmsOrderID": {
"type": "string",
"maxLen": 64,
"required": true
},
"reasonChanged": {
"type": "string",
"maxLen": 32,
"description": "reason code; why has the schedule been changed",
"required": false
},
"remarkChanged": {
"type": "string",
"maxLen": 256,
"description": "remark; why has the schedule been changed",
"required": false
},
"reasonChangedCorrected": {
"type": "number",
"valueGte": 0,
"description": "counter to indicate number of reason code corrections",
"required": true
},
"reasonLateRev": {
"type": "string",
"maxLen": 32,
"description": "reason code; why has the schedule been changed late",
"required": false
},
"remarkLateRev": {
"type": "string",
"maxLen": 256,
"description": "remark; why has the schedule been changed late",
"required": false
},
"reasonLateRevCorrected": {
"type": "number",
"valueGte": 0,
"description": "counter to indicate number of reason code corrections",
"required": true
},
"reasonNotOntime": {
"type": "string",
"maxLen": 32,
"description": "reason code; why is the actual early/late",
"required": false
},
"remarkNotOntime": {
"type": "string",
"maxLen": 256,
"description": "remark; why is the actual early/late",
"required": false
},
"reasonNotOntimeCorrected": {
"type": "number",
"valueGte": 0,
"description": "counter to indicate number of reason code corrections",
"required": true
},
"reasonLateInput": {
"type": "string",
"maxLen": 32,
"description": "reason code; why was there a delay in entering the actual",
"required": false
},
"remarkLateInput": {
"type": "string",
"maxLen": 256,
"description": "remark; why was there a delay in entering the actual",
"required": false
},
"reasonLateInputCorrected": {
"type": "number",
"valueGte": 0,
"description": "counter to indicate number of reason code corrections",
"required": true
}
}
}
},
"example": {
"event": "DHL/Order/kpiReady",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"customerID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"reasonChanged": "abcdefgh",
"remarkChanged": "abcdefgh",
"reasonChangedCorrected": 0,
"reasonLateRev": "abcdefgh",
"remarkLateRev": "abcdefgh",
"reasonLateRevCorrected": 0,
"reasonNotOntime": "abcdefgh",
"remarkNotOntime": "abcdefgh",
"reasonNotOntimeCorrected": 0,
"reasonLateInput": "abcdefgh",
"remarkLateInput": "abcdefgh",
"reasonLateInputCorrected": 0
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/event/DHL/Order/kpiReady HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"event": "DHL/Order/kpiReady",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"customerID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"reasonChanged": "abcdefgh",
"remarkChanged": "abcdefgh",
"reasonChangedCorrected": 0,
"reasonLateRev": "abcdefgh",
"remarkLateRev": "abcdefgh",
"reasonLateRevCorrected": 0,
"reasonNotOntime": "abcdefgh",
"remarkNotOntime": "abcdefgh",
"reasonNotOntimeCorrected": 0,
"reasonLateInput": "abcdefgh",
"remarkLateInput": "abcdefgh",
"reasonLateInputCorrected": 0
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
event/DHL/Order/pickup
order has been collected
JSON Descriptor
{
"method": "/api/event/DHL/Order/pickup",
"description": "order has been collected",
"encoding": "utf8",
"request": {
"properties": {
"event": {
"type": "string",
"isEqual": "DHL/Order/pickup",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"origin": {
"type": "string",
"maxLen": 128,
"description": "host where this event originated from",
"required": true
},
"data": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"description": "unique argus order identifier",
"required": true
},
"customerID": {
"type": "string",
"maxLen": 32,
"required": true
},
"omsWmsOrderID": {
"type": "string",
"maxLen": 64,
"required": true
},
"pickupActual": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "pickup datetime",
"required": true
},
"pickupActualLocale": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "pickup datetime (in local timezone)",
"required": true
},
"timezoneLocale": {
"type": "string",
"description": "local timezone",
"required": true
},
"courierInfo": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"email": {
"type": "string",
"maxLen": 128,
"regexType": "emailAddress",
"trimmedToLen": 128,
"required": false
},
"phone": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
}
}
}
}
}
},
"example": {
"event": "DHL/Order/pickup",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"customerID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"pickupActual": "2011-11-11 11:11:11",
"pickupActualLocale": "2011-11-11 11:11:11",
"timezoneLocale": "abcdefgh",
"courierInfo": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/event/DHL/Order/pickup HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"event": "DHL/Order/pickup",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"customerID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"pickupActual": "2011-11-11 11:11:11",
"pickupActualLocale": "2011-11-11 11:11:11",
"timezoneLocale": "abcdefgh",
"courierInfo": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
event/DHL/Order/proofOfDelivery
order has been delivered
JSON Descriptor
{
"method": "/api/event/DHL/Order/proofOfDelivery",
"description": "order has been delivered",
"encoding": "utf8",
"request": {
"properties": {
"event": {
"type": "string",
"isEqual": "DHL/Order/proofOfDelivery",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"origin": {
"type": "string",
"maxLen": 128,
"description": "host where this event originated from",
"required": true
},
"data": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"description": "unique argus order identifier",
"required": true
},
"customerID": {
"type": "string",
"maxLen": 32,
"required": true
},
"omsWmsOrderID": {
"type": "string",
"maxLen": 64,
"required": true
},
"onsiteActual": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "on site datetime",
"required": false
},
"onsiteActualLocale": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "on site datetime (in local timezone)",
"required": true
},
"timezoneLocale": {
"type": "string",
"description": "local timezone",
"required": true
},
"deliveryLocale": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "delivery datetime (in local timezone)",
"required": true
},
"delivery": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "delivery datetime",
"required": true
},
"reasonCode": {
"type": "string",
"maxLen": 32,
"description": "reason code; why is the actual early/late",
"required": false
},
"remark": {
"type": "string",
"maxLen": 256,
"description": "remark; why is the actual early/late",
"required": false
},
"reasonLateInput": {
"type": "string",
"maxLen": 32,
"description": "reason code; why was there a delay in entering the actual",
"required": false
},
"remarkLateInput": {
"type": "string",
"maxLen": 256,
"description": "remark; why was there a delay in entering the actual",
"required": false
},
"recipientName": {
"type": "string",
"maxLen": 64,
"required": true
},
"signature": {
"type": "object",
"description": "recipient's signature",
"required": false,
"properties": {
"fileType": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"inValues": [
"image/png",
"image/svg",
"PNG",
"png",
"GIF",
"gif"
],
"description": "MIME Content-Type",
"required": true
},
"fileData": {
"type": "string",
"description": "base64-encoded binary data",
"required": true
}
}
},
"reportedDistance": {
"type": "number",
"valueGt": 0,
"unit": "km",
"required": false
}
}
}
},
"example": {
"event": "DHL/Order/proofOfDelivery",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"customerID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"onsiteActual": "2011-11-11 11:11:11",
"onsiteActualLocale": "2011-11-11 11:11:11",
"timezoneLocale": "abcdefgh",
"deliveryLocale": "2011-11-11 11:11:11",
"delivery": "2011-11-11 11:11:11",
"reasonCode": "abcdefgh",
"remark": "abcdefgh",
"reasonLateInput": "abcdefgh",
"remarkLateInput": "abcdefgh",
"recipientName": "abcdefgh",
"signature": {
"fileType": "abcdefgh",
"fileData": "abcdefgh"
},
"reportedDistance": 0.1
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/event/DHL/Order/proofOfDelivery HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"event": "DHL/Order/proofOfDelivery",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"customerID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"onsiteActual": "2011-11-11 11:11:11",
"onsiteActualLocale": "2011-11-11 11:11:11",
"timezoneLocale": "abcdefgh",
"deliveryLocale": "2011-11-11 11:11:11",
"delivery": "2011-11-11 11:11:11",
"reasonCode": "abcdefgh",
"remark": "abcdefgh",
"reasonLateInput": "abcdefgh",
"remarkLateInput": "abcdefgh",
"recipientName": "abcdefgh",
"signature": {
"fileType": "abcdefgh",
"fileData": "abcdefgh"
},
"reportedDistance": 0.1
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
event/DHL/Order/readyForBilling
order has been collected
JSON Descriptor
{
"method": "/api/event/DHL/Order/readyForBilling",
"description": "order has been collected",
"encoding": "utf8",
"request": {
"properties": {
"event": {
"type": "string",
"isEqual": "DHL/Order/readyForBilling",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"origin": {
"type": "string",
"maxLen": 128,
"description": "host where this event originated from",
"required": true
},
"data": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"description": "unique argus order identifier",
"required": true
},
"customerID": {
"type": "string",
"maxLen": 32,
"required": true
},
"omsWmsOrderID": {
"type": "string",
"maxLen": 64,
"required": true
},
"actualDistanceDriven": {
"type": "number",
"valueGte": 0,
"required": true
},
"gpsDistanceDriven": {
"type": "number",
"valueGte": 0,
"required": true
},
"deliveryComment": {
"type": "string",
"maxLen": 256,
"required": false
},
"deliveryAnomaly": {
"type": "boolean",
"required": true
},
"charges": {
"type": "array",
"required": true,
"items": [
{
"type": "object",
"required": true,
"properties": {
"type": {
"type": "string",
"maxLen": 32,
"required": true
},
"cost": {
"type": "number",
"valueGt": 0,
"required": true
},
"currency": {
"type": "string",
"length": 3,
"unit": "ISO 4217 currency code",
"required": true
},
"comment": {
"type": "string",
"maxLen": 256,
"required": false
}
}
}
]
}
}
}
},
"example": {
"event": "DHL/Order/readyForBilling",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"customerID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"actualDistanceDriven": 0,
"gpsDistanceDriven": 0,
"deliveryComment": "abcdefgh",
"deliveryAnomaly": true,
"charges": [
{
"type": "abcdefgh",
"cost": 0.1,
"currency": "abc",
"comment": "abcdefgh"
}
]
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/event/DHL/Order/readyForBilling HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"event": "DHL/Order/readyForBilling",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"customerID": "abcdefgh",
"omsWmsOrderID": "abcdefgh",
"actualDistanceDriven": 0,
"gpsDistanceDriven": 0,
"deliveryComment": "abcdefgh",
"deliveryAnomaly": true,
"charges": [
{
"type": "abcdefgh",
"cost": 0.1,
"currency": "abc",
"comment": "abcdefgh"
}
]
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
event/DHL/Order/syncPositions
order tracking: sync one or more GPS positions
JSON Descriptor
{
"method": "/api/event/DHL/Order/syncPositions",
"description": "order tracking: sync one or more GPS positions",
"encoding": "utf8",
"request": {
"properties": {
"event": {
"type": "string",
"isEqual": "DHL/Order/syncPositions",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"origin": {
"type": "string",
"maxLen": 128,
"description": "host where this event originated from",
"required": true
},
"data": {
"type": "object",
"required": true,
"properties": {
"positions": {
"type": "array",
"valueGt": 0,
"required": true,
"items": [
{
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "unique argus order identifier",
"required": true
},
"recorded": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime when this position was recorded",
"required": true
},
"windowStart": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime at which the tracking window of the order starts",
"required": true
},
"windowEnd": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"description": "datetime at which the tracking window of the order ends",
"required": true
},
"lat": {
"type": "number",
"maxPrecision": 8,
"minVal": -90,
"maxVal": 90,
"required": true
},
"lon": {
"type": "number",
"maxPrecision": 8,
"minVal": -180,
"maxVal": 180,
"required": true
}
}
}
]
}
}
}
},
"example": {
"event": "DHL/Order/syncPositions",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"positions": [
{
"orderID": "abcdefgh",
"recorded": "2011-11-11 11:11:11",
"windowStart": "2011-11-11 11:11:11",
"windowEnd": "2011-11-11 11:11:11",
"lat": -32.1447858,
"lon": -151.84150912
}
]
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/event/DHL/Order/syncPositions HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"event": "DHL/Order/syncPositions",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"positions": [
{
"orderID": "abcdefgh",
"recorded": "2011-11-11 11:11:11",
"windowStart": "2011-11-11 11:11:11",
"windowEnd": "2011-11-11 11:11:11",
"lat": -32.1447858,
"lon": -151.84150912
}
]
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
event/DHL/Order/trackingEvent
order tracking event
JSON Descriptor
{
"method": "/api/event/DHL/Order/trackingEvent",
"description": "order tracking event",
"encoding": "utf8",
"request": {
"properties": {
"event": {
"type": "string",
"isEqual": "DHL/Order/trackingEvent",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"origin": {
"type": "string",
"maxLen": 128,
"description": "host where this event originated from",
"required": true
},
"data": {
"type": "object",
"required": true,
"properties": {
"shipmentID": {
"type": "string",
"maxLen": 32,
"required": false
},
"orderID": {
"type": "string",
"maxLen": 64,
"description": "unique argus order identifier",
"required": true
},
"trackingEventTime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"trackingEventCode": {
"type": "string",
"maxLen": 32,
"required": true
},
"trackingEventDescription": {
"type": "string",
"maxLen": 256,
"required": false
},
"trackingNumber": {
"type": "string",
"maxLen": 256,
"required": true
}
}
}
},
"example": {
"event": "DHL/Order/trackingEvent",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"shipmentID": "abcdefgh",
"orderID": "abcdefgh",
"trackingEventTime": "2011-11-11 11:11:11",
"trackingEventCode": "abcdefgh",
"trackingEventDescription": "abcdefgh",
"trackingNumber": "abcdefgh"
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/event/DHL/Order/trackingEvent HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"event": "DHL/Order/trackingEvent",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"shipmentID": "abcdefgh",
"orderID": "abcdefgh",
"trackingEventTime": "2011-11-11 11:11:11",
"trackingEventCode": "abcdefgh",
"trackingEventDescription": "abcdefgh",
"trackingNumber": "abcdefgh"
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}
event/DHL/Order/update
order has been updated
JSON Descriptor
{
"method": "/api/event/DHL/Order/update",
"description": "order has been updated",
"encoding": "utf8",
"request": {
"properties": {
"event": {
"type": "string",
"isEqual": "DHL/Order/update",
"required": true
},
"datetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"origin": {
"type": "string",
"maxLen": 128,
"description": "host where this event originated from",
"required": true
},
"data": {
"type": "object",
"required": true,
"properties": {
"orderID": {
"type": "string",
"maxLen": 64,
"description": "unique argus order identifier",
"required": true
},
"orderFields": {
"type": "object",
"required": true,
"properties": {
"omsWmsOrderID": {
"type": "string",
"maxLen": 64,
"required": true
},
"sourceSystem": {
"type": "string",
"maxLen": 32,
"required": true
},
"principalID": {
"type": "string",
"maxLen": 32,
"required": true
},
"omsWmsServiceLevel": {
"type": "string",
"maxLen": 32,
"required": false
},
"customerOrderType": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"customerServiceLevel": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": true
},
"standardServiceType": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"requestedDeliveryDatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": false
},
"routeDistance": {
"type": "integer",
"valueGt": 0,
"unit": "km",
"required": false
},
"routeDriveTime": {
"type": "integer",
"valueGt": 0,
"unit": "min",
"required": false
},
"allocationRule": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"requestorID": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "order requestor identifier",
"required": false
},
"customerInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"dispatchInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"specialInstructions": {
"type": "string",
"maxLen": 1024,
"trimmedToLen": 1024,
"required": false
},
"customerOrderNumber": {
"type": "string",
"maxLen": 64,
"required": false
},
"businessUnit": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"consolidationNumber": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"orderReference2": {
"type": "string",
"maxLen": 64,
"required": false
},
"orderReference3": {
"type": "string",
"maxLen": 64,
"required": false
},
"orderReference4": {
"type": "string",
"maxLen": 64,
"required": false
},
"orderReference5": {
"type": "string",
"maxLen": 64,
"required": false
},
"orderReference6": {
"type": "string",
"maxLen": 64,
"required": false
},
"miscReference1": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"miscReference2": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"miscReference3": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": false
},
"orderCreationDatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": false
},
"orderAcceptedDatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": false
},
"orderAssignedDatetime": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": false
},
"geofence": {
"defValue": true,
"type": "boolean",
"required": false
},
"dynamicEta": {
"defValue": true,
"type": "boolean",
"required": false
},
"geoRadiusInner": {
"type": "integer",
"valueGte": 0,
"required": false
},
"geoRadiusOuter": {
"type": "integer",
"valueGte": 0,
"required": false
}
}
},
"customer": {
"type": "object",
"required": true,
"properties": {
"id": {
"type": "string",
"maxLen": 32,
"description": "UNIQUE customer identifier",
"required": true
},
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "name or description for this customer",
"required": false
},
"contact": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": true
},
"email": {
"type": "string",
"maxLen": 64,
"regexType": "emailAddress",
"trimmedToLen": 64,
"required": false
},
"phone": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
}
}
}
}
},
"engineer": {
"type": "object",
"required": false,
"properties": {
"id": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"description": "unique engineer identifier",
"required": true
},
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": true
},
"phone": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"email": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"regexType": "emailAddress",
"required": false
}
}
},
"origin": {
"type": "object",
"required": false,
"properties": {
"shipFromID": {
"type": "string",
"maxLen": 32,
"required": false
},
"standardID": {
"type": "string",
"maxLen": 32,
"required": false
},
"wmsOmsID": {
"type": "string",
"maxLen": 32,
"required": false
},
"customerID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"data": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "name or description for this location",
"required": false
},
"addr": {
"type": "string",
"minLen": 1,
"maxLen": 256,
"description": "street address",
"required": true
},
"unit": {
"type": "string",
"maxLen": 128,
"description": "unit, building, apartment",
"required": false
},
"city": {
"type": "string",
"maxLen": 64,
"description": "city name",
"required": true
},
"post": {
"type": "string",
"maxLen": 16,
"description": "post code/ZIP code, excluding country prefix",
"required": true
},
"prov": {
"type": "string",
"maxLen": 32,
"description": "province or state",
"required": false
},
"ctry": {
"type": "string",
"length": 2,
"description": "country code (ISO 3166-1 alpha-2)",
"required": true
},
"lat": {
"type": "number",
"maxPrecision": 8,
"minVal": -90,
"maxVal": 90,
"required": true
},
"lon": {
"type": "number",
"maxPrecision": 8,
"minVal": -180,
"maxVal": 180,
"required": true
},
"contact": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": true
},
"email": {
"type": "string",
"maxLen": 64,
"regexType": "emailAddress",
"trimmedToLen": 64,
"required": false
},
"phone": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
}
}
}
}
}
}
},
"destination": {
"type": "object",
"required": false,
"properties": {
"shipToID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"standardID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"wmsOmsID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"customerID": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"data": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"description": "name or description for this location",
"required": false
},
"addr": {
"type": "string",
"minLen": 1,
"maxLen": 256,
"trimmedToLen": 256,
"description": "street address",
"required": true
},
"addr4": {
"type": "string",
"trimmedToLen": 256,
"description": "additional address information",
"required": false
},
"unit": {
"type": "string",
"maxLen": 128,
"description": "unit, building, apartment",
"required": false
},
"city": {
"type": "string",
"maxLen": 64,
"description": "city name",
"required": true
},
"post": {
"type": "string",
"maxLen": 16,
"description": "post code/ZIP code, excluding country prefix",
"required": true
},
"prov": {
"type": "string",
"maxLen": 32,
"description": "province or state",
"required": false
},
"ctry": {
"type": "string",
"length": 2,
"description": "country code (ISO 3166-1 alpha-2)",
"required": true
},
"lat": {
"type": "number",
"maxPrecision": 8,
"minVal": -90,
"maxVal": 90,
"required": true
},
"lon": {
"type": "number",
"maxPrecision": 8,
"minVal": -180,
"maxVal": 180,
"required": true
},
"contact": {
"type": "object",
"required": false,
"properties": {
"name": {
"type": "string",
"maxLen": 64,
"trimmedToLen": 64,
"required": true
},
"email": {
"type": "string",
"maxLen": 64,
"regexType": "emailAddress",
"trimmedToLen": 64,
"required": false
},
"phone": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"phone2": {
"type": "string",
"trimmedToLen": 32,
"required": false
}
}
}
}
}
}
},
"orderLines": {
"type": "array",
"required": false,
"items": [
{
"type": "object",
"required": true,
"properties": {
"orderLineID": {
"type": "string",
"maxLen": 32,
"required": false
},
"orderLineReference": {
"type": "string",
"maxLen": 32,
"required": false
},
"requestedPart": {
"type": "object",
"required": true,
"properties": {
"partNumber": {
"type": "string",
"maxLen": 32,
"required": true
},
"serialNum": {
"type": "string",
"maxLen": 32,
"required": false
},
"licensePlate": {
"type": "string",
"maxLen": 32,
"required": false
},
"quantity": {
"type": "integer",
"valueGt": 0,
"required": false
},
"currency": {
"type": "string",
"length": 3,
"unit": "ISO 4217 currency code",
"required": false
},
"value": {
"type": "number",
"valueGte": 0,
"description": "amount per piece",
"required": false
},
"dimensions": {
"type": "object",
"description": "dimensions per piece",
"required": false,
"properties": {
"grossWeight": {
"type": "number",
"valueGt": 0,
"unit": "kg",
"required": false
},
"netWeight": {
"type": "number",
"valueGt": 0,
"unit": "kg",
"required": false
},
"length": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"width": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"height": {
"type": "number",
"valueGt": 0,
"unit": "cm",
"required": false
},
"volume": {
"type": "number",
"valueGt": 0,
"unit": "cm³",
"required": false
}
}
},
"heavyPart": {
"type": "boolean",
"required": false
},
"hazardous": {
"type": "boolean",
"required": false
},
"returnable": {
"type": "boolean",
"required": false
},
"productClass": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"UOM": {
"type": "string",
"maxLen": 32,
"trimmedToLen": 32,
"required": false
},
"pickInstructions": {
"type": "string",
"trimmedToLen": 1024,
"required": false
},
"packInstructions": {
"type": "string",
"trimmedToLen": 1024,
"required": false
}
}
}
}
}
]
},
"pickupWindow": {
"type": "object",
"required": true,
"properties": {
"from": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"until": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
}
}
},
"deliveryWindow": {
"type": "object",
"required": true,
"properties": {
"from": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
},
"until": {
"type": "datetime",
"format": "YYYY-MM-DD hh:mm:ss",
"timezone": "UTC",
"required": true
}
}
},
"predictedDistance": {
"type": "number",
"valueGt": 0,
"unit": "km",
"required": false
},
"predictedDistanceMiles": {
"type": "number",
"valueGt": 0,
"unit": "mi",
"required": false
}
}
}
},
"example": {
"event": "DHL/Order/update",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"orderFields": {
"omsWmsOrderID": "abcdefgh",
"sourceSystem": "abcdefgh",
"principalID": "abcdefgh",
"omsWmsServiceLevel": "abcdefgh",
"customerOrderType": "abcdefgh",
"customerServiceLevel": "abcdefgh",
"standardServiceType": "abcdefgh",
"requestedDeliveryDatetime": "2011-11-11 11:11:11",
"routeDistance": 1,
"routeDriveTime": 1,
"allocationRule": "abcdefgh",
"requestorID": "abcdefgh",
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh",
"customerOrderNumber": "abcdefgh",
"businessUnit": "abcdefgh",
"consolidationNumber": "abcdefgh",
"orderReference2": "abcdefgh",
"orderReference3": "abcdefgh",
"orderReference4": "abcdefgh",
"orderReference5": "abcdefgh",
"orderReference6": "abcdefgh",
"miscReference1": "abcdefgh",
"miscReference2": "abcdefgh",
"miscReference3": "abcdefgh",
"orderCreationDatetime": "2011-11-11 11:11:11",
"orderAcceptedDatetime": "2011-11-11 11:11:11",
"orderAssignedDatetime": "2011-11-11 11:11:11",
"geofence": true,
"dynamicEta": true,
"geoRadiusInner": 0,
"geoRadiusOuter": 0
},
"customer": {
"id": "abcdefgh",
"name": "abcdefgh",
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
},
"engineer": {
"id": "abcdefgh",
"name": "abcdefgh",
"phone": "abcdefgh",
"email": "abc@def.gh"
},
"origin": {
"shipFromID": "abcdefgh",
"standardID": "abcdefgh",
"wmsOmsID": "abcdefgh",
"customerID": "abcdefgh",
"data": {
"name": "abcdefgh",
"addr": "a",
"unit": "abcdefgh",
"city": "abcdefgh",
"post": "abcdefgh",
"prov": "abcdefgh",
"ctry": "ab",
"lat": -45.38886658,
"lon": -73.99245103,
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
}
},
"destination": {
"shipToID": "abcdefgh",
"standardID": "abcdefgh",
"wmsOmsID": "abcdefgh",
"customerID": "abcdefgh",
"data": {
"name": "abcdefgh",
"addr": "a",
"addr4": "abcdefgh",
"unit": "abcdefgh",
"city": "abcdefgh",
"post": "abcdefgh",
"prov": "abcdefgh",
"ctry": "ab",
"lat": -68.53831633,
"lon": 94.21776023,
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh",
"phone2": "abcdefgh"
}
}
},
"orderLines": [
{
"orderLineID": "abcdefgh",
"orderLineReference": "abcdefgh",
"requestedPart": {
"partNumber": "abcdefgh",
"serialNum": "abcdefgh",
"licensePlate": "abcdefgh",
"quantity": 1,
"currency": "abc",
"value": 0,
"dimensions": {
"grossWeight": 0.1,
"netWeight": 0.1,
"length": 0.1,
"width": 0.1,
"height": 0.1,
"volume": 0.1
},
"heavyPart": true,
"hazardous": true,
"returnable": true,
"productClass": "abcdefgh",
"UOM": "abcdefgh",
"pickInstructions": "abcdefgh",
"packInstructions": "abcdefgh"
}
}
],
"pickupWindow": {
"from": "2011-11-11 11:11:11",
"until": "2011-11-11 11:11:11"
},
"deliveryWindow": {
"from": "2011-11-11 11:11:11",
"until": "2011-11-11 11:11:11"
},
"predictedDistance": 0.1,
"predictedDistanceMiles": 0.1
}
}
},
"response": {
"properties": {
"success": {
"type": "boolean",
"description": "Whether the method was completed successfully."
},
"errormsg": {
"type": "string",
"description": "Error message, if method was not successful."
}
},
"example": {
"success": true,
"errormsg": null
}
}
}
HTTP Request
POST /api/event/DHL/Order/update HTTP/1.1
host: dhl.slickss.com
content-type: application/json; charset=utf-8
{
"event": "DHL/Order/update",
"datetime": "2011-11-11 11:11:11",
"origin": "abcdefgh",
"data": {
"orderID": "abcdefgh",
"orderFields": {
"omsWmsOrderID": "abcdefgh",
"sourceSystem": "abcdefgh",
"principalID": "abcdefgh",
"omsWmsServiceLevel": "abcdefgh",
"customerOrderType": "abcdefgh",
"customerServiceLevel": "abcdefgh",
"standardServiceType": "abcdefgh",
"requestedDeliveryDatetime": "2011-11-11 11:11:11",
"routeDistance": 1,
"routeDriveTime": 1,
"allocationRule": "abcdefgh",
"requestorID": "abcdefgh",
"customerInstructions": "abcdefgh",
"dispatchInstructions": "abcdefgh",
"specialInstructions": "abcdefgh",
"customerOrderNumber": "abcdefgh",
"businessUnit": "abcdefgh",
"consolidationNumber": "abcdefgh",
"orderReference2": "abcdefgh",
"orderReference3": "abcdefgh",
"orderReference4": "abcdefgh",
"orderReference5": "abcdefgh",
"orderReference6": "abcdefgh",
"miscReference1": "abcdefgh",
"miscReference2": "abcdefgh",
"miscReference3": "abcdefgh",
"orderCreationDatetime": "2011-11-11 11:11:11",
"orderAcceptedDatetime": "2011-11-11 11:11:11",
"orderAssignedDatetime": "2011-11-11 11:11:11",
"geofence": true,
"dynamicEta": true,
"geoRadiusInner": 0,
"geoRadiusOuter": 0
},
"customer": {
"id": "abcdefgh",
"name": "abcdefgh",
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
},
"engineer": {
"id": "abcdefgh",
"name": "abcdefgh",
"phone": "abcdefgh",
"email": "abc@def.gh"
},
"origin": {
"shipFromID": "abcdefgh",
"standardID": "abcdefgh",
"wmsOmsID": "abcdefgh",
"customerID": "abcdefgh",
"data": {
"name": "abcdefgh",
"addr": "a",
"unit": "abcdefgh",
"city": "abcdefgh",
"post": "abcdefgh",
"prov": "abcdefgh",
"ctry": "ab",
"lat": -45.38886658,
"lon": -73.99245103,
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh"
}
}
},
"destination": {
"shipToID": "abcdefgh",
"standardID": "abcdefgh",
"wmsOmsID": "abcdefgh",
"customerID": "abcdefgh",
"data": {
"name": "abcdefgh",
"addr": "a",
"addr4": "abcdefgh",
"unit": "abcdefgh",
"city": "abcdefgh",
"post": "abcdefgh",
"prov": "abcdefgh",
"ctry": "ab",
"lat": -68.53831633,
"lon": 94.21776023,
"contact": {
"name": "abcdefgh",
"email": "abc@def.gh",
"phone": "abcdefgh",
"phone2": "abcdefgh"
}
}
},
"orderLines": [
{
"orderLineID": "abcdefgh",
"orderLineReference": "abcdefgh",
"requestedPart": {
"partNumber": "abcdefgh",
"serialNum": "abcdefgh",
"licensePlate": "abcdefgh",
"quantity": 1,
"currency": "abc",
"value": 0,
"dimensions": {
"grossWeight": 0.1,
"netWeight": 0.1,
"length": 0.1,
"width": 0.1,
"height": 0.1,
"volume": 0.1
},
"heavyPart": true,
"hazardous": true,
"returnable": true,
"productClass": "abcdefgh",
"UOM": "abcdefgh",
"pickInstructions": "abcdefgh",
"packInstructions": "abcdefgh"
}
}
],
"pickupWindow": {
"from": "2011-11-11 11:11:11",
"until": "2011-11-11 11:11:11"
},
"deliveryWindow": {
"from": "2011-11-11 11:11:11",
"until": "2011-11-11 11:11:11"
},
"predictedDistance": 0.1,
"predictedDistanceMiles": 0.1
}
}
HTTP Response
HTTP/1.1 200 OK
date: Mon, 1 Jan 2001 00:00:00 GMT
content-type: application/json; charset=utf-8
{
"success": true,
"errormsg": null
}