Find order by id
const url = 'https://api.tradecloud1.com/v2/order/example';const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.tradecloud1.com/v2/order/example \ --header 'Authorization: <Authorization>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Order id
Responses
Section titled “Responses”Order view
object
object
The optional buyer, buyer accounting or supplier company party:
- buyer: the legal entity that purchases the goods or services.
- buyer accounting: the legal entity that receives and handles the invoice. The supplier must send the invoice to the buyer accounting party when specified.
- supplier: the legal entity that sells the goods or services.
object
The optional identifier for the party.
The optional scheme, providing context to the identifier. Eg. KvK, GLN, etc.
The location names. It is recommended to provide at least one name.
The location address lines. It is recommended to provide at least one address line.
Location postal code
Location city
ISO 3166-1 alpha-2 country code.
Optional country name.
The optional buyer, buyer accounting or supplier company party:
- buyer: the legal entity that purchases the goods or services.
- buyer accounting: the legal entity that receives and handles the invoice. The supplier must send the invoice to the buyer accounting party when specified.
- supplier: the legal entity that sells the goods or services.
object
The optional identifier for the party.
The optional scheme, providing context to the identifier. Eg. KvK, GLN, etc.
The location names. It is recommended to provide at least one name.
The location address lines. It is recommended to provide at least one address line.
Location postal code
Location city
ISO 3166-1 alpha-2 country code.
Optional country name.
The optional buyer, buyer accounting or supplier company party:
- buyer: the legal entity that purchases the goods or services.
- buyer accounting: the legal entity that receives and handles the invoice. The supplier must send the invoice to the buyer accounting party when specified.
- supplier: the legal entity that sells the goods or services.
object
The optional identifier for the party.
The optional scheme, providing context to the identifier. Eg. KvK, GLN, etc.
The location names. It is recommended to provide at least one name.
The location address lines. It is recommended to provide at least one address line.
Location postal code
Location city
ISO 3166-1 alpha-2 country code.
Optional country name.
object
object
Order indicators set by the buyer.
object
If this flag set to true then the order lines will be automatically confirmed in case of a supplier proposal or reopen request.
object
object
Optional document short name
Description of the attached document.
The type of the attached document. Eg. General, Class Product Certificate, Manual, Packing Instructions, etc…
The object ID as known by the Tradecloud Object Storage, if this document stored in Tradecloud.
Location of the document if is not stored in Tradecloud.
Meta information about the document, set by Tradecloud.
object
The ISO-8601 date time (with milliseconds and UTC ‘Z’ designator) at which the document was first attached to or embedded on the order or order line. Absent for a document that predates Tradecloud recording this date.
The ISO-8601 date time (with milliseconds and UTC ‘Z’ designator) at which the document was last attached or embedded with changed values. Equal to addedAt when the document has never changed. Not updated when an unchanged document is sent again.
Optional value-added services labels on order level. Please note the practicable number of labels is dependent on the supplier.
object
The order type, one of:
Purchase- This is a purchase order (default).Forecast- This is a forecast order.RFQ- This is a request for quotation order.
Optional custom labels on order header level to make supply or quality issues visible.
Custom label to make supply or quality issues visible.
object
Free format label text.
Free format label reason.
Buyer-imposed requirements stamped onto the order from the buyer’s order settings at issue time.
object
If true, the supplier must provide a salesOrderNumber.
Date in ISO 8601 format
object
Date in ISO 8601 format
object
object
object
object
Optional document short name
Description of the attached document.
The type of the attached document. Eg. General, Class Product Certificate, Manual, Packing Instructions, etc…
The object ID as known by the Tradecloud Object Storage, if this document stored in Tradecloud.
Location of the document if is not stored in Tradecloud.
Meta information about the document, set by Tradecloud.
object
The ISO-8601 date time (with milliseconds and UTC ‘Z’ designator) at which the document was first attached to or embedded on the order or order line. Absent for a document that predates Tradecloud recording this date.
The ISO-8601 date time (with milliseconds and UTC ‘Z’ designator) at which the document was last attached or embedded with changed values. Equal to addedAt when the document has never changed. Not updated when an unchanged document is sent again.
object
Optional custom labels on order header level to make supply or quality issues visible.
Custom label to make supply or quality issues visible.
object
Free format label text.
Free format label reason.
Date in ISO 8601 format
object
object
The optional order line type set by the buyer or supplier, one of:
Item- This is an item line (default).Service- This is a service line.Charge- This is a charge line.
The optional charge reason code set by the buyer or supplier, in case of a charge line.
object
Required position identifier in the purchase order. The position should be unique within the order and immutable.
Optional row label for this position. Do NOT use row as identifier.
object
The purchase unit of measure for this item, passed through as-is to the supplier. No standard is enforced; UN/ECE Recommendation N°20 (Codes for Units of Measure) is recommended if you want a standard.
Array of dimensions related to the item
Defines measurable dimensions (length, width, area, weight or volume) of an item
object
Measurement type of item
Measurement value
The unit of measure for this dimension, passed through as-is. No standard is enforced; UN/ECE Recommendation N°20 (Codes for Units of Measure) is recommended if you want a standard.
The buyer may send item details to inform the supplier about part information. The supplier may check, change and add item details if they are not correct or incomplete.
object
The country of manufacture, production, or growth where an article or product comes from
A tool for classifying goods, set up to meet the requirements both of the Common Customs Tariff and of the EU’s external trade statistics
Net weight of one item
The net weight unit of measure, passed through as-is. Mandatory when netWeight is provided. No standard is enforced; UN/ECE Recommendation N°20 (Codes for Units of Measure) is recommended if you want a standard.
UN numbers or UN IDs are four-digit numbers that identify dangerous goods, hazardous substances and articles in the framework of international transport
Unique identifier assigned incrementally or sequentially to an item, to uniquely identify it
Identification number assigned to a particular quantity or lot of material from a single manufacturer
object
object
object
object
object
object
object
The price unit of measure, passed through as-is. No standard is enforced; UN/ECE Recommendation N°20 is recommended if you want a standard. The purchase unit and price unit may be different.
The item quantity at which the price applies. Typically this is 1 (unit price) or 100 (the price applies to 100 items). This number must be greater than 0
object
object
Deprecated: Use lineType with value ‘Charge’ and chargeReasonCode on the order line instead.
Deprecated: Use lineType with value ‘Charge’ and chargeReasonCode on the order line instead. The Charge Line that is included in an order line.
object
The position used to identify a Charge Line.
The reason code of this Charge Line.
The description of this Charge Line.
The quantity ordered of this Charge Line
object
object
object
The price unit of measure, passed through as-is. No standard is enforced; UN/ECE Recommendation N°20 is recommended if you want a standard. The purchase unit and price unit may be different.
object
object
object
object
object
object
object
object
object
The price unit of measure, passed through as-is. No standard is enforced; UN/ECE Recommendation N°20 is recommended if you want a standard. The purchase unit and price unit may be different.
The item quantity at which the price applies. Typically this is 1 (unit price) or 100 (the price applies to 100 items). This number must be greater than 0
object
The position of the delivery schedule line. Omitted/null in case of a split delivery schedule line.
The original position of the delivery schedule line in case of a split delivery schedule line.
Reconfirmation request as requested by the buyer.
object
object
object
If set to true, when supplier confirms a line then this line becomes a proposal
object
object
Optional document short name
Description of the attached document.
The type of the attached document. Eg. General, Class Product Certificate, Manual, Packing Instructions, etc…
The object ID as known by the Tradecloud Object Storage, if this document stored in Tradecloud.
Location of the document if is not stored in Tradecloud.
Meta information about the document, set by Tradecloud.
object
The ISO-8601 date time (with milliseconds and UTC ‘Z’ designator) at which the document was first attached to or embedded on the order or order line. Absent for a document that predates Tradecloud recording this date.
The ISO-8601 date time (with milliseconds and UTC ‘Z’ designator) at which the document was last attached or embedded with changed values. Equal to addedAt when the document has never changed. Not updated when an unchanged document is sent again.
Optional value-added services labels on line level. Please note the practicable number of labels is dependent on the supplier.
object
Optional custom labels on order line level to make supply or quality issues visible.
Custom label to make supply or quality issues visible.
object
Free format label text.
Free format label reason.
object
The buyer may send item details to inform the supplier about part information. The supplier may check, change and add item details if they are not correct or incomplete.
object
The country of manufacture, production, or growth where an article or product comes from
A tool for classifying goods, set up to meet the requirements both of the Common Customs Tariff and of the EU’s external trade statistics
Net weight of one item
The net weight unit of measure, passed through as-is. Mandatory when netWeight is provided. No standard is enforced; UN/ECE Recommendation N°20 (Codes for Units of Measure) is recommended if you want a standard.
UN numbers or UN IDs are four-digit numbers that identify dangerous goods, hazardous substances and articles in the framework of international transport
Unique identifier assigned incrementally or sequentially to an item, to uniquely identify it
Identification number assigned to a particular quantity or lot of material from a single manufacturer
Deprecated: Use lineType with value ‘Charge’ and chargeReasonCode on the order line instead.
Deprecated: Use lineType with value ‘Charge’ and chargeReasonCode on the order line instead. The Charge Line that is included in an order line.
object
The position used to identify a Charge Line.
The reason code of this Charge Line.
The description of this Charge Line.
The quantity ordered of this Charge Line
object
object
object
The price unit of measure, passed through as-is. No standard is enforced; UN/ECE Recommendation N°20 is recommended if you want a standard. The purchase unit and price unit may be different.
object
object
object
object
object
object
object
object
object
The price unit of measure, passed through as-is. No standard is enforced; UN/ECE Recommendation N°20 is recommended if you want a standard. The purchase unit and price unit may be different.
The item quantity at which the price applies. Typically this is 1 (unit price) or 100 (the price applies to 100 items). This number must be greater than 0
object
The position of the delivery schedule line. Omitted/null in case of a split delivery schedule line.
The original position of the delivery schedule line in case of a split delivery schedule line.
Deprecated: Use lineType with value ‘Charge’ and chargeReasonCode on the order line instead.
Deprecated: Use lineType with value ‘Charge’ and chargeReasonCode on the order line instead. The Charge Line that is included in an order line.
object
The position used to identify a Charge Line.
The reason code of this Charge Line.
The description of this Charge Line.
The quantity ordered of this Charge Line
object
object
object
The price unit of measure, passed through as-is. No standard is enforced; UN/ECE Recommendation N°20 is recommended if you want a standard. The purchase unit and price unit may be different.
object
object
object
object
object
object
object
object
The price unit of measure, passed through as-is. No standard is enforced; UN/ECE Recommendation N°20 is recommended if you want a standard. The purchase unit and price unit may be different.
The item quantity at which the price applies. Typically this is 1 (unit price) or 100 (the price applies to 100 items). This number must be greater than 0
object
The position of the delivery schedule line. Omitted/null in case of a split delivery schedule line.
The original position of the delivery schedule line in case of a split delivery schedule line.
Shipment request as requested by the supplier.
object
Requested delivery schedule for shipment.
object
The position of the delivery schedule line. Omitted/null in case of a split delivery schedule line.
The original position of the delivery schedule line in case of a split delivery schedule line.
Optional reason for the shipment request.
object
object
Optional document short name
Description of the attached document.
The type of the attached document. Eg. General, Class Product Certificate, Manual, Packing Instructions, etc…
The object ID as known by the Tradecloud Object Storage, if this document stored in Tradecloud.
Location of the document if is not stored in Tradecloud.
Meta information about the document, set by Tradecloud.
object
The ISO-8601 date time (with milliseconds and UTC ‘Z’ designator) at which the document was first attached to or embedded on the order or order line. Absent for a document that predates Tradecloud recording this date.
The ISO-8601 date time (with milliseconds and UTC ‘Z’ designator) at which the document was last attached or embedded with changed values. Equal to addedAt when the document has never changed. Not updated when an unchanged document is sent again.
Optional custom labels on order line level to make supply or quality issues visible.
Custom label to make supply or quality issues visible.
object
Free format label text.
Free format label reason.
object
object
object
object
object
object
object
object
The price unit of measure, passed through as-is. No standard is enforced; UN/ECE Recommendation N°20 is recommended if you want a standard. The purchase unit and price unit may be different.
The item quantity at which the price applies. Typically this is 1 (unit price) or 100 (the price applies to 100 items). This number must be greater than 0
object
The position of the delivery schedule line. Omitted/null in case of a split delivery schedule line.
The original position of the delivery schedule line in case of a split delivery schedule line.
Deprecated: Use lineType with value ‘Charge’ and chargeReasonCode on the order line instead.
Deprecated: Use lineType with value ‘Charge’ and chargeReasonCode on the order line instead. The Charge Line that is included in an order line.
object
The position used to identify a Charge Line.
The reason code of this Charge Line.
The description of this Charge Line.
The quantity ordered of this Charge Line
object
object
object
The price unit of measure, passed through as-is. No standard is enforced; UN/ECE Recommendation N°20 is recommended if you want a standard. The purchase unit and price unit may be different.
Aggregated delivery schedule with logistics info
An aggregated delivery schedule line with logistics info
object
The optional position in the delivery schedule.
The optional delivery local date (without time zone) of this delivery line. Date has ISO 8601 date format.
The optional quantity of this delivery line. Quantity has a decimal format.
The order, line or optional delivery line logistics status:
Open- No or partial quantity Produced, ReadyToShip, Shipped or DeliveredProduced- Full quantity produced by the supplierReadyToShip- Full quantity ready to be shipped by the supplierShipped- Full quantity shipped by the supplierDelivered- Full quantity delivered at the buyerCancelled- Cancelled by the buyer
object
True if this delivery line is not Delivered yet and its date is in the past.
The Mode of Transport used for the delivery of goods. UNECE.org Recommendation 19 is advised for Mode of Transport values.
The optional logistics Estimated Time of Departure local date (without time zone) of this delivery line. Date has ISO 8601 date format.
The optional logistics Estimated Time of Arrival local date (without time zone) of this delivery line. Date has ISO 8601 date format.
Aggregated delivery schedule with logistics info and merged with requests
An aggregated delivery schedule line with logistics info
object
The optional position in the delivery schedule.
The optional delivery local date (without time zone) of this delivery line. Date has ISO 8601 date format.
The optional quantity of this delivery line. Quantity has a decimal format.
The order, line or optional delivery line logistics status:
Open- No or partial quantity Produced, ReadyToShip, Shipped or DeliveredProduced- Full quantity produced by the supplierReadyToShip- Full quantity ready to be shipped by the supplierShipped- Full quantity shipped by the supplierDelivered- Full quantity delivered at the buyerCancelled- Cancelled by the buyer
object
True if this delivery line is not Delivered yet and its date is in the past.
The Mode of Transport used for the delivery of goods. UNECE.org Recommendation 19 is advised for Mode of Transport values.
The optional logistics Estimated Time of Departure local date (without time zone) of this delivery line. Date has ISO 8601 date format.
The optional logistics Estimated Time of Arrival local date (without time zone) of this delivery line. Date has ISO 8601 date format.
Information about the shipment lines that were created in the shipment module for this order line.
Information about a shipment line that was created in the shipment module for an order line.
object
The Tradecloud ID of the shipment in which the shipmentLine was included.
The shipment number of the shipment in which the shipmentLine was included.
The position in the deliverySchedule that this shipmentLine applies to.
The quantity that was dispatched.
The backorder quantity.
The backorder expected delivery date.
object
object
object
object
object
object
object
The price unit of measure, passed through as-is. No standard is enforced; UN/ECE Recommendation N°20 is recommended if you want a standard. The purchase unit and price unit may be different.
The item quantity at which the price applies. Typically this is 1 (unit price) or 100 (the price applies to 100 items). This number must be greater than 0
object
object
object
object
object
object
object
The price unit of measure, passed through as-is. No standard is enforced; UN/ECE Recommendation N°20 is recommended if you want a standard. The purchase unit and price unit may be different.
The item quantity at which the price applies. Typically this is 1 (unit price) or 100 (the price applies to 100 items). This number must be greater than 0
Deprecated: Use lineType with value ‘Charge’ and chargeReasonCode on the order line instead. Aggregated charge lines for this order line.
Deprecated: Use lineType with value ‘Charge’ and chargeReasonCode on the order line instead. The Charge Line that is included in an order line.
object
The position used to identify a Charge Line.
The reason code of this Charge Line.
The description of this Charge Line.
The quantity ordered of this Charge Line
object
object
object
The price unit of measure, passed through as-is. No standard is enforced; UN/ECE Recommendation N°20 is recommended if you want a standard. The purchase unit and price unit may be different.
Deprecated: Use lineType with value ‘Charge’ and chargeReasonCode on the order line instead. Aggregated charge lines, merged with requests, for this order line.
Deprecated: Use lineType with value ‘Charge’ and chargeReasonCode on the order line instead. The Charge Line that is included in an order line.
object
The position used to identify a Charge Line.
The reason code of this Charge Line.
The description of this Charge Line.
The quantity ordered of this Charge Line
object
object
object
The price unit of measure, passed through as-is. No standard is enforced; UN/ECE Recommendation N°20 is recommended if you want a standard. The purchase unit and price unit may be different.
object
True if a delivery line of this order line is not Delivered yet and its date is in the past.
object
The order or line process status:
Issued- (Re)issued by the buyerInProgress- Under negotiation between buyer and supplierConfirmed- Agreed between buyer and supplierRejected- Rejected by supplierCompleted- Completed at the buyerCancelled- Cancelled by the buyer
More fine-grained status when an order line has processStatus InProgress, explaining why it is in progress:
OpenSupplierProposal- There is an open proposal from the supplier.RejectedSupplierProposal- The proposal from the supplier was rejected and no other requests are open.ApprovedDeliverySchedule- The order line delivery schedule was approved by the buyer.RejectedDeliverySchedule- The order line delivery schedule was rejected by the buyer.ReissuedRejectedLine- The rejected order line was reissued by the buyer.OpenBuyerReconfirmationRequest- The buyer has requested to reconfirmed the order line.OpenSupplierReopenRequest- There is an open reopen request from the supplier.OpenSupplierShipmentRescheduleRequest- There is an open shipment reschedule request from the supplier.OpenBuyerReopenRequest- There is an open reopen request from the buyer.RevertedCompletedLine- The completion of this line was reverted.RevertedCancelledLine- The cancellation of this line was reverted.
The order, line or optional delivery line logistics status:
Open- No or partial quantity Produced, ReadyToShip, Shipped or DeliveredProduced- Full quantity produced by the supplierReadyToShip- Full quantity ready to be shipped by the supplierShipped- Full quantity shipped by the supplierDelivered- Full quantity delivered at the buyerCancelled- Cancelled by the buyer
object
The buyer may send item details to inform the supplier about part information. The supplier may check, change and add item details if they are not correct or incomplete.
object
The country of manufacture, production, or growth where an article or product comes from
A tool for classifying goods, set up to meet the requirements both of the Common Customs Tariff and of the EU’s external trade statistics
Net weight of one item
The net weight unit of measure, passed through as-is. Mandatory when netWeight is provided. No standard is enforced; UN/ECE Recommendation N°20 (Codes for Units of Measure) is recommended if you want a standard.
UN numbers or UN IDs are four-digit numbers that identify dangerous goods, hazardous substances and articles in the framework of international transport
Unique identifier assigned incrementally or sequentially to an item, to uniquely identify it
Identification number assigned to a particular quantity or lot of material from a single manufacturer
object
object
Object containing all predictions that are done for this order line.
object
A prediction for a particular event to happen
object
The predicted score of a particular property
Object describing which properties had a positive or negative attribution to a prediction.
object
The baseline score of the current model, being the chance of an exception happening when an order line had average values for all properties.
Ordered list with the 5 most relevant properties that had a positive impact on the predicted score.
The attribution of a feature to a particular prediction.
object
The JSON path of an OrderLine property that attributed to a prediction. Can be used as i18n key by the portal.
The amount that this property has increased (positive) or decreased (negative) the prediction score compared to the model baseline score. Number between -1 and 1, rounded to 4 decimals.
Ordered list with the 5 most relevant properties that had a negative impact on the predicted score.
The attribution of a feature to a particular prediction.
object
The JSON path of an OrderLine property that attributed to a prediction. Can be used as i18n key by the portal.
The amount that this property has increased (positive) or decreased (negative) the prediction score compared to the model baseline score. Number between -1 and 1, rounded to 4 decimals.
The meta information related to a Prediction
object
Unique identifier of the model that was used for a prediction.
The version of the model that was used for a prediction.
The ISO-8601 date time (with milliseconds and UTC ‘Z’ designator) that denotes the date time at which the prediction was retrieved.
The ISO-8601 date time (with milliseconds and UTC ‘Z’ designator) that denotes the latest date time the order line has been changed
object
True if a order line is not Delivered yet and the order line is overdue.
object
The order or line process status:
Issued- (Re)issued by the buyerInProgress- Under negotiation between buyer and supplierConfirmed- Agreed between buyer and supplierRejected- Rejected by supplierCompleted- Completed at the buyerCancelled- Cancelled by the buyer
The order, line or optional delivery line logistics status:
Open- No or partial quantity Produced, ReadyToShip, Shipped or DeliveredProduced- Full quantity produced by the supplierReadyToShip- Full quantity ready to be shipped by the supplierShipped- Full quantity shipped by the supplierDelivered- Full quantity delivered at the buyerCancelled- Cancelled by the buyer
object
object
object
The ISO-8601 date time (with milliseconds and UTC ‘Z’ designator) that denotes the latest date time the order has been changed
Example
{ "buyerOrder": { "buyerParty": { "id": "123", "idScheme": "GLN", "names": [ "My Company Warehouse", "Dock 12" ], "addressLines": [ "Street 123", "Area 52" ], "postalCode": "1234 AB", "city": "Rotterdam", "countryCodeIso2": "NL", "countryName": "The Netherlands" }, "buyerAccountingParty": { "id": "123", "idScheme": "GLN", "names": [ "My Company Warehouse", "Dock 12" ], "addressLines": [ "Street 123", "Area 52" ], "postalCode": "1234 AB", "city": "Rotterdam", "countryCodeIso2": "NL", "countryName": "The Netherlands" }, "supplierParty": { "id": "123", "idScheme": "GLN", "names": [ "My Company Warehouse", "Dock 12" ], "addressLines": [ "Street 123", "Area 52" ], "postalCode": "1234 AB", "city": "Rotterdam", "countryCodeIso2": "NL", "countryName": "The Netherlands" }, "indicators": { "autoConfirm": false }, "documents": [ { "code": "10007563", "revision": "B", "name": "Tradecloud API Manual", "description": "General document", "type": "General", "objectId": "05d251f0-0166-4e1e-8110-8d7a507b18f4", "url": "https://my-company.com/storage/my_file.pdf", "meta": { "addedAt": "2019-12-31T10:11:12.123Z", "lastUpdatedAt": "2019-12-31T10:11:12.123Z" } } ], "labels": [ "first label for this order", "second label for this order" ], "contact": { "status": "Assigned" }, "orderType": "Purchase", "customLabels": [ { "text": "Urgent", "reason": "Out of stock" } ], "requirements": { "salesOrderNumberRequired": false }, "erpIssueDateTime": "2020-05-19T15:41:23.000", "erpLastChangeDateTime": "2020-05-19T15:41:23.000" }, "supplierOrder": { "documents": [ { "code": "10007563", "revision": "B", "name": "Tradecloud API Manual", "description": "General document", "type": "General", "objectId": "05d251f0-0166-4e1e-8110-8d7a507b18f4", "url": "https://my-company.com/storage/my_file.pdf", "meta": { "addedAt": "2019-12-31T10:11:12.123Z", "lastUpdatedAt": "2019-12-31T10:11:12.123Z" } } ], "contact": { "status": "Suggested" }, "customLabels": [ { "text": "Urgent", "reason": "Out of stock" } ], "erpLastResponseDateTime": "2020-05-19T15:41:23.000" }, "lines": [ { "lineType": "Item", "chargeReasonCode": "FC", "buyerLine": { "position": "0001", "row": "1", "item": { "dimensions": [ { "attribute": "Length", "measure": 50.5, "unitOfMeasureUnece": "m" } ] }, "itemDetails": { "countryOfOriginCodeIso2": "NL", "combinedNomenclatureCode": "6406 10 10", "netWeight": 41.241, "netWeightUnitOfMeasureIso": "KG", "dangerousGoodsCodeUnece": "0060", "serialNumber": "0x0000000000028000", "batchNumber": "#18001" }, "prices": { "priceUnitQuantity": 100 }, "chargeLines": [ { "position": "001", "chargeTypeCode": "FC", "chargeDescription": "Additional coating", "quantity": 2, "priceUnitOfMeasureIso": "PCE" } ], "requests": { "reopenRequest": { "prices": { "priceUnitQuantity": 100 }, "status": "Open" }, "reconfirmationRequest": { "status": "Open" } }, "documents": [ { "code": "10007563", "revision": "B", "name": "Tradecloud API Manual", "description": "General document", "type": "General", "objectId": "05d251f0-0166-4e1e-8110-8d7a507b18f4", "url": "https://my-company.com/storage/my_file.pdf", "meta": { "addedAt": "2019-12-31T10:11:12.123Z", "lastUpdatedAt": "2019-12-31T10:11:12.123Z" } } ], "labels": [ "first label for this line", "second label for this line" ], "customLabels": [ { "text": "Urgent", "reason": "Out of stock" } ] }, "supplierLine": { "itemDetails": { "countryOfOriginCodeIso2": "NL", "combinedNomenclatureCode": "6406 10 10", "netWeight": 41.241, "netWeightUnitOfMeasureIso": "KG", "dangerousGoodsCodeUnece": "0060", "serialNumber": "0x0000000000028000", "batchNumber": "#18001" }, "chargeLines": [ { "position": "001", "chargeTypeCode": "FC", "chargeDescription": "Additional coating", "quantity": 2, "priceUnitOfMeasureIso": "PCE" } ], "requests": { "proposal": { "prices": { "priceUnitQuantity": 100 }, "chargeLines": [ { "position": "001", "chargeTypeCode": "FC", "chargeDescription": "Additional coating", "quantity": 2, "priceUnitOfMeasureIso": "PCE" } ], "status": "Open" }, "reopenRequest": { "prices": { "priceUnitQuantity": 100 }, "status": "Open" }, "shipmentRescheduleRequest": { "status": "Open" } }, "documents": [ { "code": "10007563", "revision": "B", "name": "Tradecloud API Manual", "description": "General document", "type": "General", "objectId": "05d251f0-0166-4e1e-8110-8d7a507b18f4", "url": "https://my-company.com/storage/my_file.pdf", "meta": { "addedAt": "2019-12-31T10:11:12.123Z", "lastUpdatedAt": "2019-12-31T10:11:12.123Z" } } ], "customLabels": [ { "text": "Urgent", "reason": "Out of stock" } ] }, "confirmedLine": { "prices": { "priceUnitQuantity": 100 }, "chargeLines": [ { "position": "001", "chargeTypeCode": "FC", "chargeDescription": "Additional coating", "quantity": 2, "priceUnitOfMeasureIso": "PCE" } ] }, "deliverySchedule": [ { "position": "01", "date": "2019-12-31", "quantity": 1234.56, "status": "Open", "indicators": { "deliveryOverdue": false }, "transportMode": "Road transport", "etd": "2019-12-31", "eta": "2019-12-31" } ], "deliveryScheduleIncludingRequests": [ { "position": "01", "date": "2019-12-31", "quantity": 1234.56, "status": "Open", "indicators": { "deliveryOverdue": false }, "transportMode": "Road transport", "etd": "2019-12-31", "eta": "2019-12-31" } ], "shipmentHistory": [ { "shipmentId": "0827f1b5-af43-4fbb-8f7e-6bc20c7dcd44-S12345", "shipmentNumber": "S12345", "deliverySchedulePosition": "D01", "despatchQuantity": "15.5", "backorderQuantity": "5.5", "backorderDate": "2024-12-31" } ], "prices": { "priceUnitQuantity": 100 }, "pricesIncludingRequests": { "priceUnitQuantity": 100 }, "chargeLines": [ { "position": "001", "chargeTypeCode": "FC", "chargeDescription": "Additional coating", "quantity": 2, "priceUnitOfMeasureIso": "PCE" } ], "chargeLinesIncludingRequests": [ { "position": "001", "chargeTypeCode": "FC", "chargeDescription": "Additional coating", "quantity": 2, "priceUnitOfMeasureIso": "PCE" } ], "indicators": { "deliveryOverdue": false }, "status": { "processStatus": "Issued", "inProgressStatus": "OpenSupplierProposal", "logisticsStatus": "Open" }, "mergedItemDetails": { "countryOfOriginCodeIso2": "NL", "combinedNomenclatureCode": "6406 10 10", "netWeight": 41.241, "netWeightUnitOfMeasureIso": "KG", "dangerousGoodsCodeUnece": "0060", "serialNumber": "0x0000000000028000", "batchNumber": "#18001" }, "predictions": { "confirmationExceptionPrediction": { "score": 0.42, "featureAttributions": { "modelBaselineScore": 0.2512, "positiveAttributions": [ { "path": "buyerLine.deliverySchedule.2.date", "score": 0.1251 } ], "negativeAttributions": [ { "path": "buyerLine.deliverySchedule.2.date", "score": 0.1251 } ] }, "meta": { "modelId": "model-123", "modelVersion": "v2", "predictedAt": "2021-04-23T10:01:53.812Z" } } }, "lastUpdatedAt": "2021-04-23T10:01:53.812Z" } ], "indicators": { "deliveryOverdue": false }, "status": { "processStatus": "Issued", "logisticsStatus": "Open" }, "lastUpdatedAt": "2021-04-23T10:01:53.812Z"}Bad request, the user should check the response body for more info.
Not authenticated, the user should authenticate using a valid access token, use Basic Authentication, or refresh to get a valid token.
Not authorized, the user is authenticated but does not have the necessary permission.
Order not found.
An unexpected error occurred, Tradecloud ops will be alerted.
Service is not healthy (bad gateway), Tradecloud ops will be alerted.
Service is unavailable (overloaded or down for maintenance), Tradecloud ops will be alerted.
Service is unavailable (gateway timeout), Tradecloud ops will be alerted.