The data for Deals (orders) are in the output formats available XML and JSON.

 

deal

Detailed information about an order, order

name Compulsory field Data type description
orderId   String (250) Unique key of the purchase order (internal)
customerOrderId   String (250) Individual order number of the customer
status   String (255) Order status in which the order is located, see item 8 Order Status overview in this article below
statusMessage   String (8192) Additional textual order status notes, partly directly from the seller.
statusDate   Date Last change date of the order
vendor   Vendor (255) Reference to the seller (internal key, n: 1)
order   List <order> Details List of OpenTrans 2.1 ORDER documents
orderresponse   List <orderresponse> Details List of OpenTrans 2.1 ORDERRESPONSE documents
dispatchnotification   List <dispatchnotification> Details List of OpenTrans 2.1 DISPATCHNOTIFICATION documents
invoice   List <invoice> Details List of OpenTrans 2.1 INVOICE documents

vendor

Seller data for an order, order

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

supplier

Supplier of a reference source.

name Compulsory field Data type description
id Yes long Unique key
name Yes String (255) Identifier of the supplier
deeplink Yes String (2048) URL, link to the supplier within 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

order

Details List of OpenTrans 2.1 ORDER documents

name Compulsory field Data type description
transactionId   String (36) ITscope TransactionalId
lastUpdate   Date Date of the last update of the document
documentUrl   String (255) API business documents URL to download the document. If no URL exists, this transaction has no ORDER document.

orderresponse

Details List of OpenTrans 2.1 ORDERRESPONSE documents

name Compulsory field Data type description
transactionId   String (36) ITscope TransactionalId
lastUpdate   Date Date of the last update of the document
documentUrl   String (255) API business documents URL to download the document. If no URL available, this transaction has no ORDERRESPONSE document, for example because the transaction manually on the sales board is pressed.

dispatchnotification

Details List of OpenTrans 2.1 DISPATCHNOTIFICATION documents

name Compulsory field Data type description
transactionId   String (36) ITscope TransactionalId
lastUpdate   Date Date of the last update of the document
documentUrl   String (255) API business documents URL to download the document. If no URL available has this transaction no DISPATCHNOTIFICATION document, for example because the transaction manually on the sales board is pressed.

invoice

Details List of OpenTrans 2.1 INVOICE documents

name Compulsory field Data type description
transactionId   String (36) ITscope TransactionalId
lastUpdate   Date Date of the last update of the document
documentUrl   String (255) API business documents URL to download the document. If no URL available, this transaction has no INVOICE document, for example because the transaction manually on the sales board is pressed.

 

Order Status / Order Status Overview

API status Platform status description
PREPARING suggestion The order is available as an order proposal, only the orderer sees this order
TRANSMITTING Is currently being sent The order is being sent to the seller's system. Platform status
SENT Sent out The order has been sent 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 notes are in the status message field

  • Eg some of your ordered items have been canceled or are on backorder.
  • Eg x of your ordered items have been canceled.
  • Or a specific note from the seller
PROCESSING order confirmed The order has been confirmed by the seller
ADVISED. *** " In shipment The order was shipped by the seller
INVOICED Calculated The order was calculated 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 then only be explicitly released by the seller again
ERROR Error The order has been technically successfully transmitted to the vendor's system, but the system has reported an error in the initial check of the order. The corresponding error message is then accordingly the status message box

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

Have more questions? Submit a request