Order Instruction

This interface is used to inform AdOr5 of a delivery instruction to a specified customer. Orders can be updated up until the time that allocation has occurred – thereafter no updates will be accepted. Order cancellations are handled outside of interfacing.

VAS instructions on line level must be enabled by the VAS flag on the header. VAS instruction on header level takes precedence over VAS on the line level.

DestinationLocation object takes precedence over the destination properties in the header.

Below you will find the Actions with descriptions and the Specfication for the requests.

VIEW

This method allows you to view an empty orderinstruction.json file

Request details

Method	Endpoint	Header key	Header Value
VIEW	BaseURL/api/outbound	X-AUTH-TOKEN	Integration Service API key

Request Response

{
    "OrderID": 0,
    "ClientID": 0,
    "CustomerID": 0,
    "ClientNo": null,
    "CustomerNo": null,
    "OrderNo": null,
    "Priority": 0,
    "DueDate": null,
    "OrderTypeID": 0,
    "OrderSource": null,
    "CreateDate": "0001-01-01T00:00:00",
    "CreateUID": 0,
    "ShipFromDate": null,
    "DespatchUID": 0,
    "DespatchDate": null,
    "StartDate": null,
    "VAS": false,
    "VASText": null,
    "SubPack": false,
    "CheckMethodID": null,
    "ServiceLevelID": null,
    "CourierID": null,
    "CourierRef": null,
    "DestNo": null,
    "DestName1": null,
    "DestName2": null,
    "DestAddress1": null,
    "DestAddress2": null,
    "DestAddress3": null,
    "DestAddress4": null,
    "DestCity": null,
    "DestTownCode": null,
    "DestPostalCode": null,
    "DestCountryCode": null,
    "DestHub": null,
    "DestContact": null,
    "DestTelephone": null,
    "DestRef": null,
    "DeliveryDate": null,
    "DeliveryTime": null,
    "Reference1": null,
    "Reference2": null,
    "Reference3": null,
    "Reference4": null,
    "Note1": null,
    "Note2": null,
    "CampaignNo": null,
    "CampaignDesc": null,
    "CloseDate": "0001-01-01T00:00:00",
    "CloseUID": 0,
    "CloseReason": null,
    "SealUID": 0,
    "SealStart": "0001-01-01T00:00:00",
    "ExportTrigger": null,
    "SalesOrg": null,
    "InputLine": null,
    "ExportID": 0,
    "StatusID": 0,
    "SalesOrderID": null,
    "SubPackVersion": 0,
    "DestRef2": null,
    "PrintDespatchNote": false,
    "PrintConsignmentNote": false,
    "XDP": null,
    "ExportID_PP": 0,
    "Line": null,
    "LogFileID": 0,
    "AllocationResult": null,
    "ModeId": 0,
    "UnpackBinId": null,
    "RequireWeightAndDims": true,
    "CourierName": null,
    "CourierDesc": null,
    "CourierBin": null,
    "OrderTypeNo": null,
    "OrderTypeDesc": null,
    "CheckMethodDesc": null,
    "ServiceLevelCode": null,
    "DestinationLocation": {
        "LocationID": 0,
        "LocationTypeID": 0,
        "LocationNo": null,
        "Address1": null,
        "Address2": null,
        "Address3": null,
        "Address4": null,
        "PostalCode": null,
        "CountryCode": null,
        "Telephone": null,
        "Fax": null,
        "Email": null,
        "Ref1": null,
        "CreateDate": "0001-01-01T00:00:00",
        "CreateUID": 0,
        "SubPack": false,
        "RequireWeightAndDims": false,
        "CheckMethodID": 0,
        "LocationName1": null,
        "LocationName2": null,
        "VAS": false,
        "VASText": null,
        "ParentLocationID": null,
        "Hub": null,
        "IsXDock": false,
        "UnpackBinId": null
    },
    "Lines": [
        {
            "LineNo": 0,
            "CustomerNo": null,
            "CustomerId": null,
            "SKUNo": null,
            "ItemAtt1": null,
            "ItemAtt2": null,
            "ItemAtt3": null,
            "ItemAtt4": null,
            "ItemAtt5": null,
            "ItemAttValue1": null,
            "ItemAttValue2": null,
            "ItemAttValue3": null,
            "OrderedQty": 0,
            "VASText": null,
            "Ref1": null,
            "Ref2": null
        }
    ]
}

POST

This method allows you to post to the OrderInstructionSTD_API Interface.

Request details

Method	Endpoint	Header key	Header Value
POST	BaseURL/api/outbound	X-AUTH-TOKEN	Integration Service API key

Request Body

{
  "interfaceName" : "OrderInstructionSTD_API",
  "returnDetailedData" : true,
  "data": [{
        "OrderID": 0,
        "ClientID": 0,
        "CustomerID": 0,
        "ClientNo": "CL01",
        "CustomerNo": "CU01",
        "OrderNo": "326194875.748192636",
        "Priority": 1,
        "DueDate": null,
        "OrderTypeID": 0,
        "OrderSource": "Customer",
        "CreateDate": "0001-01-01T00:00:00",
        "CreateUID": 0,
        "ShipFromDate": null,
        "DespatchUID": 0,
        "DespatchDate": null,
        "StartDate": null,
        "VAS": false,
        "VASText": null,
        "SubPack": false,
        "CheckMethodID": null,
        "ServiceLevelID": null,
        "CourierID": null,
        "CourierRef": null,
        "DestNo": null,
        "DestName1": null,
        "DestName2": null,
        "DestAddress1": null,
        "DestAddress2": null,
        "DestAddress3": null,
        "DestAddress4": null,
        "DestCity": null,
        "DestTownCode": null,
        "DestPostalCode": null,
        "DestCountryCode": null,
        "DestHub": null,
        "DestContact": null,
        "DestTelephone": null,
        "DestRef": null,
        "DeliveryDate": null,
        "DeliveryTime": null,
        "Reference1": null,
        "Reference2": null,
        "Reference3": null,
        "Reference4": null,
        "Note1": null,
        "Note2": null,
        "CampaignNo": null,
        "CampaignDesc": null,
        "CloseDate": "0001-01-01T00:00:00",
        "CloseUID": 0,
        "CloseReason": null,
        "SealUID": 0,
        "SealStart": "0001-01-01T00:00:00",
        "ExportTrigger": null,
        "SalesOrg": null,
        "InputLine": null,
        "ExportID": 0,
        "StatusID": 0,
        "SalesOrderID": null,
        "SubPackVersion": 0,
        "DestRef2": null,
        "PrintDespatchNote": false,
        "PrintConsignmentNote": false,
        "XDP": null,
        "ExportID_PP": 0,
        "Line": null,
        "LogFileID": 0,
        "AllocationResult": null,
        "ModeId": 0,
        "UnpackBinId": null,
        "RequireWeightAndDims": true,
        "CourierName": null,
        "CourierDesc": null,
        "CourierBin": null,
        "OrderTypeNo": "1",
        "OrderTypeDesc": "Default",
        "CheckMethodDesc": null,
        "ServiceLevelCode": null,
        "DestinationLocation": {
            "LocationID": 0,
            "LocationTypeID": 0,
            "LocationNo": "LOC123",
            "Address1": null,
            "Address2": null,
            "Address3": null,
            "Address4": null,
            "PostalCode": null,
            "CountryCode": null,
            "Telephone": null,
            "Fax": null,
            "Email": null,
            "Ref1": null,
            "CreateDate": "0001-01-01T00:00:00",
            "CreateUID": 0,
            "SubPack": false,
            "RequireWeightAndDims": false,
            "CheckMethodID": 0,
            "LocationName1": null,
            "LocationName2": null,
            "VAS": false,
            "VASText": null,
            "ParentLocationID": null,
            "Hub": null,
            "IsXDock": false,
            "UnpackBinId": null
        },
        "Lines": [
            {
                "LineNo": 1,
                "CustomerNo": null,
                "CustomerId": 0,
                "SKUNo": "885522",
                "ItemAtt1": null,
                "ItemAtt2": null,
                "ItemAtt3": null,
                "ItemAtt4": null,
                "ItemAtt5": null,
                "ItemAttValue1": null,
                "ItemAttValue2": null,
                "ItemAttValue3": null,
                "OrderedQty": 10,
                "VASText": null,
                "Ref1": null,
                "Ref2": null
            }
        ]
    }]
}

Request Response

{
    "success": true,
    "message": null,
    "errorData": null,
    "returnData": [
        {
            "orderID": 25173,
            "clientID": 1,
            "customerID": 1,
            "clientNo": "CL01",
            "customerNo": "CU01",
            "orderNo": "326194875.748192636",
            "priority": 1,
            "dueDate": "2020-11-18T00:00:00+02:00",
            "orderTypeID": 14,
            "orderSource": "APITEST",
            "createDate": "2020-11-18T11:44:53.9957612+02:00",
            "createUID": 0,
            "shipFromDate": "2020-11-18T00:00:00+02:00",
            "despatchUID": 0,
            "despatchDate": null,
            "startDate": "2020-11-18T00:00:00+02:00",
            "vas": false,
            "vasText": null,
            "subPack": false,
            "checkMethodID": "0",
            "serviceLevelID": 1,
            "courierID": 1,
            "courierRef": null,
            "destNo": "LOC123",
            "destName1": null,
            "destName2": null,
            "destAddress1": null,
            "destAddress2": null,
            "destAddress3": null,
            "destAddress4": null,
            "destCity": null,
            "destTownCode": null,
            "destPostalCode": null,
            "destCountryCode": null,
            "destHub": null,
            "destContact": null,
            "destTelephone": null,
            "destRef": null,
            "deliveryDate": null,
            "deliveryTime": null,
            "reference1": null,
            "reference2": null,
            "reference3": null,
            "reference4": null,
            "note1": null,
            "note2": null,
            "campaignNo": null,
            "campaignDesc": null,
            "closeDate": "0001-01-01T00:00:00",
            "closeUID": 0,
            "closeReason": null,
            "sealUID": 0,
            "sealStart": "0001-01-01T00:00:00",
            "exportTrigger": "DESPATCH",
            "salesOrg": null,
            "inputLine": null,
            "exportID": 0,
            "statusID": 1400,
            "salesOrderID": null,
            "subPackVersion": 0,
            "destRef2": null,
            "printDespatchNote": false,
            "printConsignmentNote": false,
            "xdp": null,
            "exportID_PP": 0,
            "line": null,
            "logFileID": 0,
            "allocationResult": null,
            "modeId": 0,
            "unpackBinId": null,
            "requireWeightAndDims": true,
            "courierName": null,
            "courierDesc": null,
            "courierBin": null,
            "orderTypeNo": "7",
            "orderTypeDesc": "Demo Type",
            "checkMethodDesc": null,
            "serviceLevelCode": null,
            "destinationLocation": {
                "locationID": 824,
                "locationTypeID": 2,
                "locationNo": "LOC123",
                "address1": null,
                "address2": null,
                "address3": null,
                "address4": null,
                "postalCode": null,
                "countryCode": null,
                "telephone": null,
                "fax": null,
                "email": null,
                "ref1": null,
                "createDate": "0001-01-01T00:00:00",
                "createUID": 0,
                "subPack": false,
                "requireWeightAndDims": false,
                "checkMethodID": 0,
                "locationName1": null,
                "locationName2": null,
                "vas": false,
                "vasText": null,
                "parentLocationID": null,
                "hub": null,
                "isXDock": false,
                "unpackBinId": null
            },
            "lines": [
                {
                    "lineNo": 1,
                    "customerNo": null,
                    "customerId": 1,
                    "skuNo": "885522",
                    "itemAtt1": null,
                    "itemAtt2": null,
                    "itemAtt3": null,
                    "itemAtt4": null,
                    "itemAtt5": null,
                    "itemAttValue1": null,
                    "itemAttValue2": null,
                    "itemAttValue3": null,
                    "orderedQty": 10,
                    "vasText": null,
                    "ref1": null,
                    "ref2": null
                }
            ]
        }
    ]
}

PUT

This method allows you to put to the OrderInstructionSTD_API Interface.

Request details

Method	Endpoint	Header key	Header Value
PUT	BaseURL/api/outbound	X-AUTH-TOKEN	Integration Service API key

Request Body

{
  "interfaceName" : "OrderInstructionSTD_API",
  "returnDetailedData" : true,
  "data": [{
        "OrderID": 0,
        "ClientID": 0,
        "CustomerID": 0,
        "ClientNo": "CL01",
        "CustomerNo": "CU01",
        "OrderNo": "326194875.748192636",
        "Priority": 1,
        "DueDate": null,
        "OrderTypeID": 0,
        "OrderSource": "APITEST",
        "CreateDate": "0001-01-01T00:00:00",
        "CreateUID": 0,
        "ShipFromDate": null,
        "DespatchUID": 0,
        "DespatchDate": null,
        "StartDate": null,
        "VAS": false,
        "VASText": null,
        "SubPack": false,
        "CheckMethodID": null,
        "ServiceLevelID": null,
        "CourierID": null,
        "CourierRef": null,
        "DestNo": null,
        "DestName1": null,
        "DestName2": null,
        "DestAddress1": null,
        "DestAddress2": null,
        "DestAddress3": null,
        "DestAddress4": null,
        "DestCity": null,
        "DestTownCode": null,
        "DestPostalCode": null,
        "DestCountryCode": null,
        "DestHub": null,
        "DestContact": null,
        "DestTelephone": null,
        "DestRef": null,
        "DeliveryDate": null,
        "DeliveryTime": null,
        "Reference1": null,
        "Reference2": null,
        "Reference3": null,
        "Reference4": null,
        "Note1": null,
        "Note2": null,
        "CampaignNo": null,
        "CampaignDesc": null,
        "CloseDate": "0001-01-01T00:00:00",
        "CloseUID": 0,
        "CloseReason": null,
        "SealUID": 0,
        "SealStart": "0001-01-01T00:00:00",
        "ExportTrigger": null,
        "SalesOrg": null,
        "InputLine": null,
        "ExportID": 0,
        "StatusID": 0,
        "SalesOrderID": null,
        "SubPackVersion": 0,
        "DestRef2": null,
        "PrintDespatchNote": false,
        "PrintConsignmentNote": false,
        "XDP": null,
        "ExportID_PP": 0,
        "Line": null,
        "LogFileID": 0,
        "AllocationResult": null,
        "ModeId": 0,
        "UnpackBinId": null,
        "RequireWeightAndDims": true,
        "CourierName": null,
        "CourierDesc": null,
        "CourierBin": null,
        "OrderTypeNo": "7",
        "OrderTypeDesc": "Demo Type",
        "CheckMethodDesc": null,
        "ServiceLevelCode": null,
        "DestinationLocation": {
            "LocationID": 0,
            "LocationTypeID": 0,
            "LocationNo": "LOC123",
            "Address1": null,
            "Address2": null,
            "Address3": null,
            "Address4": null,
            "PostalCode": null,
            "CountryCode": null,
            "Telephone": null,
            "Fax": null,
            "Email": null,
            "Ref1": null,
            "CreateDate": "0001-01-01T00:00:00",
            "CreateUID": 0,
            "SubPack": false,
            "RequireWeightAndDims": false,
            "CheckMethodID": 0,
            "LocationName1": null,
            "LocationName2": null,
            "VAS": false,
            "VASText": null,
            "ParentLocationID": null,
            "Hub": null,
            "IsXDock": false,
            "UnpackBinId": null
        },
        "Lines": [
            {
                "LineNo": 1,
                "CustomerNo": null,
                "CustomerId": 0,
                "SKUNo": "885522",
                "ItemAtt1": null,
                "ItemAtt2": null,
                "ItemAtt3": null,
                "ItemAtt4": null,
                "ItemAtt5": null,
                "ItemAttValue1": null,
                "ItemAttValue2": null,
                "ItemAttValue3": null,
                "OrderedQty": 101,
                "VASText": null,
                "Ref1": null,
                "Ref2": null
            }
        ]
    }]
}

Response

{
    "success": true,
    "message": null,
    "errorData": null,
    "returnData": [
        {
            "orderID": 25173,
            "clientID": 1,
            "customerID": 1,
            "clientNo": "CL01",
            "customerNo": "CU01",
            "orderNo": "326194875.748192636",
            "priority": 1,
            "dueDate": "2020-11-18T00:00:00+02:00",
            "orderTypeID": 14,
            "orderSource": "APITEST",
            "createDate": "0001-01-01T00:00:00",
            "createUID": 0,
            "shipFromDate": "2020-11-18T00:00:00+02:00",
            "despatchUID": 0,
            "despatchDate": null,
            "startDate": "2020-11-18T00:00:00+02:00",
            "vas": false,
            "vasText": null,
            "subPack": false,
            "checkMethodID": "0",
            "serviceLevelID": 1,
            "courierID": 1,
            "courierRef": null,
            "destNo": "LOC123",
            "destName1": null,
            "destName2": null,
            "destAddress1": null,
            "destAddress2": null,
            "destAddress3": null,
            "destAddress4": null,
            "destCity": null,
            "destTownCode": null,
            "destPostalCode": null,
            "destCountryCode": null,
            "destHub": null,
            "destContact": null,
            "destTelephone": null,
            "destRef": null,
            "deliveryDate": null,
            "deliveryTime": null,
            "reference1": null,
            "reference2": null,
            "reference3": null,
            "reference4": null,
            "note1": null,
            "note2": null,
            "campaignNo": null,
            "campaignDesc": null,
            "closeDate": "0001-01-01T00:00:00",
            "closeUID": 0,
            "closeReason": null,
            "sealUID": 0,
            "sealStart": "0001-01-01T00:00:00",
            "exportTrigger": null,
            "salesOrg": null,
            "inputLine": null,
            "exportID": 0,
            "statusID": 1400,
            "salesOrderID": null,
            "subPackVersion": 0,
            "destRef2": null,
            "printDespatchNote": false,
            "printConsignmentNote": false,
            "xdp": null,
            "exportID_PP": 0,
            "line": null,
            "logFileID": 0,
            "allocationResult": null,
            "modeId": 0,
            "unpackBinId": null,
            "requireWeightAndDims": true,
            "courierName": null,
            "courierDesc": null,
            "courierBin": null,
            "orderTypeNo": "7",
            "orderTypeDesc": "Demo Type",
            "checkMethodDesc": null,
            "serviceLevelCode": null,
            "destinationLocation": {
                "locationID": 824,
                "locationTypeID": 2,
                "locationNo": "LOC123",
                "address1": null,
                "address2": null,
                "address3": null,
                "address4": null,
                "postalCode": null,
                "countryCode": null,
                "telephone": null,
                "fax": null,
                "email": null,
                "ref1": null,
                "createDate": "0001-01-01T00:00:00",
                "createUID": 0,
                "subPack": false,
                "requireWeightAndDims": false,
                "checkMethodID": 0,
                "locationName1": null,
                "locationName2": null,
                "vas": false,
                "vasText": null,
                "parentLocationID": null,
                "hub": null,
                "isXDock": false,
                "unpackBinId": null
            },
            "lines": [
                {
                    "lineNo": 1,
                    "customerNo": null,
                    "customerId": 1,
                    "skuNo": "885522",
                    "itemAtt1": null,
                    "itemAtt2": null,
                    "itemAtt3": null,
                    "itemAtt4": null,
                    "itemAtt5": null,
                    "itemAttValue1": null,
                    "itemAttValue2": null,
                    "itemAttValue3": null,
                    "orderedQty": 101,
                    "vasText": null,
                    "ref1": null,
                    "ref2": null
                }
            ]
        }
    ]
}

Specification

Order Header

Field	Type	Notes	Req
OrderID	Integer		N
ClientID	Integer		N
CustomerID	Integer		N
ClientNo	String (30)		Y
CustomerNo	String (30)		Y
OrderNo	String (30)		Y
Priority	Integer	Must be higher than 0	Y
DueDate	Timestamp		N
OrderTypeID	Integer		N
OrderSource	String (30)		Y
CreateDate	Timestamp		N
CreateUID	Integer		N
ShipFromDate	Timestamp		N
DespatchUID	Integer		N
DespatchDate	Timestamp		N
StartDate	Timestamp		N
VAS	Boolean		N
VASText	String (2048)		N
SubPack	Boolean		N
CheckMethodID	String (50)		N
ServiceLevelID	Integer		N
CourierID	Integer		N
CourierRef	String (30)		N
DestNo	String (20)		N
DestName1	String (60)		N
DestName2	String (60)		N
DestAddress1	String (50)		N
DestAddress2	String (50)		N
DestAddress3	String (50)		N
DestAddress4	String (50)		N
DestCity	String (30)		N
DestTownCode	String (10)		N
DestPostalCode	String (20)		N
DestCountryCode	String (10)		N
DestHub	String (10)		N
DestContact	String (30)		N
DestTelephone	String (30)		N
DestRef	String (30)		N
DeliveryDate	String (50)		N
DeliveryTime	String (50)		N
Reference1	String (30)		N
Reference2	String (30)		N
Reference3	String (30)		N
Reference4	String (30)		N
Note1	String (255)		N
Note2	String (255)		N
CampaignNo	String (20)		N
CampaignDesc	String (50)		N
CloseDate	Timestamp		N
CloseUID	Integer		N
CloseReason	String (255)		N
SealUID	Integer		N
SealStart	Timestamp		N
ExportTrigger	String (40)		N
SalesOrg	String (20)		N
InputLine	String (700)	Will be populated with the current line object	N
ExportID	Integer		N
StatusID	Integer		N
SalesOrderID	Integer		N
SubPackVersion	Integer		N
DestRef2	String (30)		N
PrintDespatchNote	Boolean		N
PrintConsignmentNote	Boolean		N
XDP	String (30)		N
ExportID_PP	Integer		N
Line	String (50)		N
LogFileID	Integer		N
AllocationResult	String (500)		N
ModeId	Integer		N
UnpackBinId	Integer		N
RequireWeightAndDims	Boolean		N
CourierName	String (15)	Will use the default courier if not supplied	N
CourierDesc	String (30)	Recomended for new Couriers	N
CourierBin	String (30)	Bin must exist in AdOr	N
OrderTypeNo	String (10)		Y
OrderTypeDesc	String (30)	Recomended for new types	N
CheckMethodDesc	String (20)		N
ServiceLevelCode	String (10)		N

Destination Location

Field	Type	Req
LocationID	Integer	N
LocationTypeID	Integer	N
LocationNo	String (10)	Y
Address1	String (50)	N
Address2	String (50)	N
Address3	String (50)	N
Address4	String (50)	N
PostalCode	String (20)	N
CountryCode	String (10)	N
Telephone	String (30)	N
Fax	String (30)	N
Email	String (50)	N
Ref1	String (30)	N
CreateDate	Timestamp	N
CreateUID	Integer	N
SubPack	Boolean	N
RequireWeightAndDims	Boolean	N
CheckMethodID	Integer	N
LocationName1	String (60)	N
LocationName2	String (60)	N
VAS	Boolean	N
VASText	String (255)	N
ParentLocationID	Integer	N
Hub	String (10)	N
IsXDock	Boolean	N
UnpackBinId	Integer	N

Lines

Field	Type	Req
LineNo	Integer	Y
CustomerNo	String (50)	Y
CustomerDesc	String (50)	N
SkuNo	String (30)	Y
OrderedQty	Integer	Y
Ref1	String (50)	N
ItemAtt1	String (40)	N
ItemAtt2	String (40)	N
ItemAtt3	String (40)	N
ItemAtt4	String (40)	N
ItemAtt5	String (40)	N
ItemAttValue1	Double	N
ItemAttValue2	Double	N
ItemAttValue3	Double	N

Actions​

VIEW​

Request details​

Request Response​

POST​

Request details​

Request Body​

Request Response​

PUT​

Request details​

Request Body​

Response​

Specification​

Order Header​

Destination Location​

Lines​

Actions

VIEW

Request details

Request Response

POST

Request details

Request Body

Request Response

PUT

Request details

Request Body

Response

Specification

Order Header

Destination Location

Lines