Format description for orders

Last modified: 9. October 2020

Data for deals (i.e. orders) is available in XML and JSON output formats.

Deal

Detailed information about an order

NameCompulsory fieldData typeDescription
orderIdYesString (250)Unique ITscope key of the purchase order
ownOrderId String (250)Own order ID
customerOrderId String (250)End customer’s order ID
cartId String (250)ID of the shopping cart containing the order only available in API 2.1
statusYesString (255)Current order status of the order, see section 8: ‘Order status overview’ further down
statusMessageYesString (8192)Additional textual order status notes, sometimes transmitted directly by the seller
statusDateYesDateLast modification date of the order
archivedYesBooleanIndicates if an order has been archived only available in API 2.1
deeplinkYesString (2048)Deep link to the ITscope.com platform only available in API 2.1
vendor Vendor (255)Reference to the seller (internal key, n:1)
orders List <order>Details about the list of OpenTrans 2.1 ORDER documents
orderresponses List <orderresponse>Details about the list of OpenTrans 2.1 ORDERRESPONSE documents
dispatchnotifications List <dispatchnotification>Details about the list of OpenTrans 2.1 DISPATCHNOTIFICATION documents
invoices List <invoice>Details about the list of OpenTrans 2.1 INVOICE documents

Vendor

Seller data for an order

NameCompulsory fieldData typeDescription
nameYesString (255)Name of the company
supplierYessupplierReference to the supplier object; Only available if this company is a supplier

Supplier

Supplier of a source of supply

NameCompulsory fieldData typeDescription
idYeslongUnique key
nameYesString (255)Supplier identifier
deeplinkYesString (2048)URL, link to the supplier page on the ITscope platform
customerAccountNumber String (255)Customer number in case of partnership. Can be used as a filter to determine if there is a partnership with this supplier

Orders

Details about the list of OpenTrans 2.1 ORDER documents

NameCompulsory fieldData typeDescription
transactionId String (36)ITscope transactional ID
lastUpdate DateDate of the last document update
documentUrl String (255)API business documents URL to download the document. If no URL exists, this transaction has no ORDER document

Order responses

Details about the list of OpenTrans 2.1 ORDERRESPONSE documents

NameCompulsory fieldData typeDescription
transactionId String (36)ITscope transactional ID
lastUpdate DateDate of the last document update
documentUrl String (255)API business documents URL to download the document. If no URL is available, this transaction has no ORDERRESPONSE document, e.g. because the transaction was initiated manually on the salesboard

Dispatch notifications

Details about the list of OpenTrans 2.1 DISPATCHNOTIFICATION documents

NameCompulsory fieldData typeDescription
transactionId String (36)ITscope Transactional ID
lastUpdate DateDate of the last document update
documentUrl String (255)API business documents URL to download the document. If no URL is available, this transaction has no DISPATCHNOTIFICATION document, e.g. because the transaction was initiated manually on the salesboard

Invoices

Details about the list of OpenTrans 2.1 INVOICE documents

NameCompulsory fieldData typeDescription
transactionId String (36)ITscope Transactional ID
lastUpdate DateDate of the last document update
documentUrl String (255)API business documents URL to download the document. If no URL is available, this transaction has no INVOICE document, e.g. because the transaction was initiated manually on the salesboard

Order status overview

API statusPlatform statusDescription
PREPARINGSuggestionThe order is available as an order proposal, only the orderer can see this order
TRANSMITTINGIs currently being sentThe order is being sent to the seller’s system
SENTSent outThe order has been transmitted to the seller
ARRIVEDArrivedThe order has arrived at the seller
ARRIVED_WARNINGArrived with warningThe order has arrived at the seller, but there were some warning notices on the seller’s side. These notices are recorded in the statusMessage field e.g. some of your ordered items have been cancelled or are on backorder e.g. x of your ordered items have been canceled alternatively a specific notice has been provided by the seller
PROCESSINGOrder confirmedThe order has been confirmed by the seller
ADVISEDIn shipmentThe order has been dispatched by the seller
INVOICEDInvoicedThe order has been invoiced by the seller
CANCELEDRejectedThe complete order was rejected by the seller or all items in the order were set to cancellation
BLOCKEDBlockedThe order was blocked by the seller, this can only be explicitly released by the seller
ERRORErrorThe order has been successfully transmitted technically to the vendor’s system, but the system has reported an error in the initial check of the order. The corresponding error message is recorded in the statusMessage field
Was this article helpful?
Dislike 0
Views: 27