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

 

Deal

Detailed information about an order

Name Compulsory field Data type Description
orderId Yes String (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

status Yes String (255) Current order status of the order, see section 8: 'Order status overview' further down
statusMessage Yes String (8192) Additional textual order status notes, sometimes transmitted directly by the seller
statusDate Yes Date Last modification date of the order
archived Yes Boolean

Indicates if an order has been archived

only available in API 2.1

deeplink Yes String (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

Name Compulsory field Data type Description
name Yes String (255) Name of the company
supplier Yes supplier Reference to the supplier object; Only available if this company is a supplier

Supplier

Supplier of a source of supply

Name Compulsory field Data type Description
id Yes long Unique key
name Yes String (255) Supplier identifier
deeplink Yes String (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

Name Compulsory field Data type Description
transactionId   String (36) ITscope transactional ID
lastUpdate   Date Date 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

Name Compulsory field Data type Description
transactionId   String (36) ITscope transactional ID
lastUpdate   Date Date 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

Name Compulsory field Data type Description
transactionId   String (36) ITscope Transactional ID
lastUpdate   Date Date 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

Name Compulsory field Data type Description
transactionId   String (36) ITscope Transactional ID
lastUpdate   Date Date 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 status Platform status Description
PREPARING Suggestion The order is available as an order proposal, only the orderer can see this order
TRANSMITTING Is currently being sent The order is being sent to the seller's system
SENT Sent out The order has been transmitted to the seller
ARRIVED Arrived The order has arrived at the seller
ARRIVED_WARNING Arrived with warning

The 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
PROCESSING Order confirmed The order has been confirmed by the seller
ADVISED In shipment The order has been dispatched by the seller
INVOICED Invoiced The order has been invoiced by the seller
CANCELED Rejected The complete order was rejected by the seller or all items in the order were set to cancellation
BLOCKED Blocked The order was blocked by the seller, this can only be explicitly released by the seller
ERROR Error The 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

Note: This page has been translated with the Google Translation Service.

Have more questions? Submit a request