{"id":1914,"date":"2020-09-22T14:59:11","date_gmt":"2020-09-22T14:59:11","guid":{"rendered":"https:\/\/support.itscope.hostpress.me\/?post_type=kb&p=1914"},"modified":"2025-01-24T21:44:47","modified_gmt":"2025-01-24T19:44:47","slug":"format-description-for-orders","status":"publish","type":"kb","link":"https:\/\/guide.itscope.com\/en\/kb\/format-description-for-orders\/","title":{"rendered":"Format description for deals (orders)"},"content":{"rendered":"\n

Data for deals (i.e. orders) is available in XML and JSON output formats<\/a>.
<\/p>\n\n\n\n

Deal<\/h2>\n\n\n\n

Detailed information about an order:<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
orderId<\/td>Yes<\/td>String (250)<\/td>Unique ITscope key of the purchase order<\/td><\/tr>
ownOrderId<\/td> <\/td>String (250)<\/td>Own order ID<\/td><\/tr>
customerOrderId<\/td> <\/td>String (250)<\/td>End customer’s order ID<\/td><\/tr>
cartId<\/td>Yes<\/td>String (250)<\/td>ID of the shopping cart containing the order, only available in API 2.1<\/a><\/td><\/tr>
status<\/td>Yes<\/td>String (255)<\/td>Current order status of the order, see section 8: ‘Order status overview’ further down<\/td><\/tr>
statusMessage<\/td>Yes<\/td>String (8192)<\/td>Additional textual order status notes, sometimes transmitted directly by the seller<\/td><\/tr>
statusDate<\/td>Yes<\/td>Date<\/td>Last modification date of the order<\/td><\/tr>
archived<\/td>Yes<\/td>Boolean<\/td>Indicates if an order has been archived, only available in API 2.1<\/a><\/td><\/tr>
deeplink<\/td>Yes<\/td>String (2048)<\/td>Deep link to the ITscope.com platform, only available in API 2.1<\/a><\/td><\/tr>
imported<\/td><\/td>Boolean<\/td>Indicates if an order has been imported via api, only available in API 2.1<\/a><\/td><\/tr>
automated<\/td><\/td>Boolean<\/td>Indicates if an order has been automated via shop order automation only in b2b shops, only available in API 2.1<\/a><\/td><\/tr>
businessType<\/td><\/td>String (255)<\/td>Describes the type of an order PURCHASE<\/a> if incoming, SALE<\/a> if outgoing, only available in API 2.1<\/a><\/td><\/tr>
b2bOrder<\/td><\/td>Boolean<\/td>true<\/strong> indicates if an order was created in b2b shops,
false<\/strong> indicates if an order was created in the itscope platform
only available in API 2.1<\/a><\/td><\/tr>
vendor<\/td> <\/td>vendor<\/td>Reference to the seller (internal key, 1:1)<\/td><\/tr>
buyer<\/td><\/td>buyer<\/td>Reference to the buyer (internal key, 1:1)<\/td><\/tr>
orders<\/td> <\/td>List <order><\/td>Details about the list of OpenTrans 2.1<\/a> ORDER documents<\/td><\/tr>
orderresponses<\/td> <\/td>List <orderresponse><\/td>Details about the list of OpenTrans 2.1<\/a> ORDERRESPONSE documents<\/td><\/tr>
dispatchnotifications<\/td> <\/td>List <dispatchnotification><\/td>Details about the list of OpenTrans 2.1<\/a> DISPATCHNOTIFICATION documents<\/td><\/tr>
invoices<\/td> <\/td>List <invoice><\/td>Details about the list of OpenTrans 2.1<\/a> INVOICE documents.<\/td><\/tr>
payment<\/td><\/td>payment<\/td>Details about payments (only in b2b shops)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Vendor<\/h2>\n\n\n\n

Seller data for an order:<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
name<\/td>Yes<\/td>String (255)<\/td>Name of the company<\/td><\/tr>
supplier<\/td>Yes<\/td>supplier<\/td>Reference to the supplier object; only available if this company is a supplier.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Supplier<\/h2>\n\n\n\n

Supplier of a source of supply:<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
id<\/td>Yes<\/td>long<\/td>Unique key<\/td><\/tr>
name<\/td>Yes<\/td>String (255)<\/td>Supplier identifier<\/td><\/tr>
deeplink<\/td>Yes<\/td>String (2048)<\/td>URL, link to the supplier’s page on the ITscope platform<\/td><\/tr>
customerAccountNumber<\/td> <\/td>String (255)<\/td>Customer number in case of partnership. Can be used as a filter to determine if there is a partnership with this supplier.<\/td><\/tr>
weeeRegNo<\/td><\/td>String (255)<\/td>The WEEE-Reg.-Nr. of the supplier (law \u00a76 ElektroG)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Buyer<\/h2>\n\n\n\n

Buyer data for an order<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
name<\/td>Yes<\/td>String (255)<\/td>Name of the company<\/td><\/tr>
customer<\/td>Yes<\/td>customer<\/td>Reference to the customer object of a buyer<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Customer<\/h2>\n\n\n\n

Customer data from a buyer for an order<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
id<\/td>Yes<\/td>Integer<\/td>Unique ITscopeId of a customerobject from a buyer<\/td><\/tr>
name<\/td>Yes<\/td>String (255)<\/td>Name of the customer<\/td><\/tr>
deeplink<\/td>Yes<\/td>String (255)<\/td>URL, Deeplink to the customer inside the ITscope platform<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Orders<\/h2>\n\n\n\n

Details about the list of OpenTrans 2.1<\/a> ORDER documents:<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
transactionId<\/td> <\/td>String (36)<\/td>ITscope transactional ID<\/td><\/tr>
lastUpdate<\/td> <\/td>Date<\/td>Date of the last document update<\/td><\/tr>
documentUrl<\/td> <\/td>String (255)<\/td>API business documents URL<\/a> to download the document. If no URL exists, this transaction has no ORDER document.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Order responses<\/h2>\n\n\n\n

Details about the list of OpenTrans 2.1<\/a> ORDERRESPONSE documents:<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
transactionId<\/td> <\/td>String (36)<\/td>ITscope transactional ID<\/td><\/tr>
lastUpdate<\/td> <\/td>Date<\/td>Date of the last document update<\/td><\/tr>
documentUrl<\/td> <\/td>String (255)<\/td>API business documents URL<\/a> 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<\/a>.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Dispatch notifications<\/h2>\n\n\n\n

Details about the list of OpenTrans 2.1<\/a> DISPATCHNOTIFICATION documents:<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
transactionId<\/td> <\/td>String (36)<\/td>ITscope Transactional ID<\/td><\/tr>
lastUpdate<\/td> <\/td>Date<\/td>Date of the last document update<\/td><\/tr>
documentUrl<\/td> <\/td>String (255)<\/td>API business documents URL<\/a> 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<\/a>.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Invoices<\/h2>\n\n\n\n

Details about the list of OpenTrans 2.1<\/a> INVOICE documents:<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
transactionId<\/td> <\/td>String (36)<\/td>ITscope Transactional ID<\/td><\/tr>
lastUpdate<\/td> <\/td>Date<\/td>Date of the last document update<\/td><\/tr>
documentUrl<\/td> <\/td>String (255)<\/td>API business documents URL<\/a> 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<\/a>.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Payment<\/h2>\n\n\n\n

Details to payments (only for B2B Shop order)<\/p>\n\n\n\n

Name<\/th>Compulsory field<\/th>Data type<\/th>Description<\/th><\/tr><\/thead>
transactionId<\/td><\/td>String (36)<\/td>Transactional ID of the payment service provider<\/td><\/tr>
lastUpdate<\/td><\/td>Date<\/td>Date of the last document update<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Order status overview<\/h2>\n\n\n\n
API status<\/strong><\/td>Platform status<\/strong><\/td>Description<\/strong><\/strong><\/td><\/tr>
PREPARING<\/td>Suggestion<\/td>The order is available as an order proposal, only the orderer can see this order<\/td><\/tr>
PAYMENT_AWAITING<\/td>Payment awaiting\/outstanding<\/td>For some orders it is possible to make a payment before the order is sent. This status indicates that a payment process is currently taking place<\/td><\/tr>
PAYMENT_SUCCESSFUL<\/td>Payment successful<\/td>For some orders it is possible to make a payment before the order is sent. This status indicates that the payment was successful<\/td><\/tr>
TRANSMITTING<\/td>Is currently being sent<\/td>The order is being sent to the seller’s system<\/td><\/tr>
SENT<\/td>Sent out<\/td>The order has been transmitted to the seller<\/td><\/tr>
ARRIVED<\/td>Arrived<\/td>The order has arrived at the seller<\/td><\/tr>
ARRIVED_WARNING<\/td>Arrived with warning<\/td>The order has arrived at the seller, but there were some warning notices on the seller’s side. See the statusMessage<\/strong> field for more information. This status may occur if, for example, some of your ordered items have been cancelled or are on backorder. Alternatively, some of your ordered items may have been cancelled or a specific message has been provided by the seller in the field mentioned above<\/td><\/tr>
PARTIALLY_PROCESSING<\/td>Order partially confirmed<\/td>The order has been partially confirmed by the seller, i.e. not all line items have been confirmed. See the statusMessage<\/strong> field for more information. This status may occur if, for example, some of your ordered items have been cancelled or are on backorder. Alternatively, some of your ordered items may have been cancelled or a specific message has been provided by the seller in the field mentioned above<\/td><\/tr>
PROCESSING<\/td>Order confirmed<\/td>The full order (all line items) has been confirmed by the seller<\/td><\/tr>
PARTIALLY_ADVISED<\/td>Partially in shipment<\/td>The order has been partially shipped by the seller, i.e. not all order items have been dispatched yet<\/td><\/tr>
ADVISED<\/td>In shipment<\/td>The full order (all line items) has been dispatched by the seller<\/td><\/tr>
PARTIALLY_INVOICED<\/td>Partially invoiced<\/td>The order has been partially invoiced by the seller, i.e. not all order items have been invoiced yet<\/td><\/tr>
INVOICED<\/td>Invoiced<\/td>The full order (all line items) has been invoiced by the seller<\/td><\/tr>
CANCELED<\/td>Cancelled<\/td>The full order has now been rejected by the seller, even though parts of the order may have already been confirmed<\/td><\/tr>
REJECTED<\/td>Rejected<\/td>The entire order has been rejected by the seller, or all items in the order have been set to ‘cancelled’<\/td><\/tr>
BLOCKED<\/td>Blocked<\/td>Die Bestellung wurde vom Verk\u00e4ufer gesperrt, diese kann dann nur explizit vom Verk\u00e4ufer wieder freigegeben werden<\/td><\/tr>
BLOCKED_BYLIMIT<\/td>Blocked due to exceeding a limit<\/td>The order has been blocked because the credit limit or budget has been exceeded<\/td><\/tr>
ERROR<\/td>Error<\/td>The order has been successfully transmitted technically to the seller’s system, but the system has reported an error in the initial review of the order. The corresponding error message is recorded in the statusMessage<\/strong> field<\/td><\/tr>
ORDERED_ELSEWHERE<\/td>Ordered elsewhere<\/td>This status can be set manually or via the ITscope API, and indicates that the orderer has placed this order elsewhere (email, phone, seller’s shop,\u2026). Under this status, the order is not sent to the seller, but it is still possible to receive EDI response messages from the seller.<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"

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 …<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"kbtopic":[173],"kbtag":[],"class_list":["post-1914","kb","type-kb","status-publish","hentry","kbtopic-api-export-output-formats-business-data-metadata"],"_links":{"self":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/1914","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb"}],"about":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/types\/kb"}],"author":[{"embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/comments?post=1914"}],"version-history":[{"count":12,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/1914\/revisions"}],"predecessor-version":[{"id":17420,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/1914\/revisions\/17420"}],"wp:attachment":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/media?parent=1914"}],"wp:term":[{"taxonomy":"kbtopic","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtopic?post=1914"},{"taxonomy":"kbtag","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtag?post=1914"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}