Orders Export - API Connector
📄 Exported JSON Structure
Payload structure
Example – Order - JSON Export
{
"reference": "172-189-1896838-1",
"accountExternalId": "1234",
"supplierExternalId": "4567",
"createdAt": "2024-06-04T10:30:00Z",
"orderLines": [
{
"orderLineId": "7894",
"offerPriceExternalId": "6549",
"variantExternalId": "SKU123",
"quantityPerItem": "2",
"gtin": "17244701",
"quantity": 2
}
]
}Fields
| Field | Definition |
|---|---|
reference | Internal unique ID of the Order Logistic |
accountExternalId | External unique ID of the Account |
createdAt | Timestamp when the Order Logistic was created |
supplierExternalId | External identifier of the supplier handling the logistic |
orderLines | List of ordered items in the Order Logistic |
orderLineId | Internal unique ID of the Order Line |
offerPriceExternalId | External unique ID of the Offer Price |
variantExternalId | External unique ID of the Product Variant |
quantityPerItem | Number of item per article |
gtin | GTIN |
quantity | Quantity of the product ordered |
| Field | Definition |
|---|---|
| Order-level fields | |
| Order id | Unique identifier of the order in the system |
| Order Creation Date | Timestamp when the order was first created |
| Order Update Date | Timestamp of the last modification of the order |
| Order Reference | Reference number for the order (Internal unique ID of the Order Logistic) |
| Order External Id | Order identifier in an external system |
| Order Commercial Id | Unique identifier of the order (its made of one or multiple logistic orders) |
| Order Commercial Reference | Commercial tracking reference |
| Order Incident Declared | Indicates if an incident (issue claim) is linked to the order |
| Shipping Tracking Url | URL where the customer can track the shipment |
| Order External Source | Originating platform |
| Order status | Current status (Pending, Shipped...) |
| Order Payment Status | Status of payment (Paid, Refunded...) |
| Order Payment Option | Payment method used (Credit Card, Bank Transfer…). |
| Order Origin | Channel through which the order was placed |
| Shipping Type | Delivery type (Standard, Express...) |
| Partially Declined By Supplier | Indicates if some items were rejected by the supplier |
| Fulfillment Message | Additional notes or messages related to fulfillment |
| Lead Time To Ship | Estimated time required to prepare the order before shipment |
| Order Validated At | Date/time when the order was validated/confirmed |
| Order Product Count | Number of distinct products in the order |
| Line Count | Total number of lines in the order |
| Supplier & logistics | |
| Supplier Id | Unique identifier of the supplier |
| Supplier Name | Name of the supplier/vendor |
| Supplier Description | Textual description of the supplier |
| Supplier Total Offers | Total number of offers available from the supplier |
| Supplier Total Orders | Historical total of orders processed by this supplier |
| Supplier Total Sales | Historical total of sales value for this supplier |
| Supplier Return Policy | Supplier’s return/refund policy |
| Supplier External Id | Supplier identifier in an external system |
| Payment Due Date Delay | Allowed payment delay in days |
| Payment Due Date Mode | Mode for computing due date |
| Shipping & Billing addresses | |
| Shipping | |
| shippingAddressSnapshot.Id | Internal ID of the shipping address snapshot |
| shippingAddressSnapshot.country | Country of the shipping address |
| shippingAddressSnapshot.label | Label or nickname for the shipping address |
| shippingAddressSnapshot.fullName | Full name of the recipient |
| shippingAddressSnapshot.address | Address of the recipient (street...) |
| shippingAddressSnapshot.additionalAddress | Additional address details (apartment, room, etc.). |
| shippingAddressSnapshot.city | City of the shipping address |
| shippingAddressSnapshot.state | State/province/region of the shipping address |
| shippingAddressSnapshot.zipcode | Postal/ZIP code of the shipping address |
| shippingAddressSnapshot.phone | Contact phone number for shipping |
| shippingAddressSnapshot.externalId | External system identifier for the shipping address |
| shippingAddressSnapshot.company | Company name at the shipping address |
| Billing | |
| billingAddressSnapshot.id | Internal ID of the billing address snapshot |
| billingAddressSnapshot.country | Country of the billing address |
| billingAddressSnapshot.label | Label/nickname of the billing address |
| billingAddressSnapshot.fullName | Full name of the billing recipient |
| billingAddressSnapshot.address | Street address of the billing contact |
| billingAddressSnapshot.additionalAddress | Additional address details (apartment, room, etc.). |
| billingAddressSnapshot.city | City of the billing address |
| billingAddressSnapshot.state | State/province/region of the billing address |
| billingAddressSnapshot.zipcode | Postal/ZIP code of the billing address |
| billingAddressSnapshot.phone | Phone number linked to billing |
| billingAddressSnapshot.externalId | External reference for billing address |
| billingAddressSnapshot.company | Company name at the billing address |
| Customer details | |
| Customer User Id | Unique identifier of the customer user |
| Customer Account Id | Identifier for the customer’s account |
| Customer Account Name | Name associated with the customer account |
| Customer Civility | Title (Mr, Mrs, Ms, Dr…) |
| Customer First Name | Customer’s first name |
| Customer Last Name | Customer’s last name |
| Customer Email | Customer’s email address |
| Customer Account External Id | Customer’s account ID in an external system |
| Customer Phone | Customer’s phone number |
| Customer Account TVA Number | VAT/Tax identification number |
| Order totals (Price & Taxes) | |
| Total Shipping Fees | Total shipping costs |
| Total Item Price | Sum of item prices (excluding taxes) |
| Total Order Price | Final total price of the order (incl. taxes, shipping) |
| Total Tax Amount | Total amount of tax applied |
| Total Price Without Tax | Order subtotal before taxes |
| Total Price With Tax | Order total including tax |
| Total Shipping Tax Amount | Total tax applied on shipping costs |
| Total Shipping Fees Without Tax | Shipping fees excluding taxes |
| Total Shipping Fees With Tax | Shipping fees including taxes |
| Total Product Tax Amount | Tax applied to products |
| Total Product Without Tax | Product total before tax |
| Total Product With Tax | Product total including tax |
| Currency | Currency code (e.g., USD, EUR) |
| Payments | |
| payments | Payment records linked to the order |
| -> Payment Amount | Amount paid in one transaction |
| -> Payment Transaction Id | Unique identifier of the transaction |
| Order Lines | |
| -> Order Line Id | Unique identifier for the line item |
| -> Order Line External Id | Line ID in an external system |
| -> Order Line External Source | Origin source |
| -> Order Line Quantity | Number of units ordered |
| -> Order Line Confirmed Quantity | Quantity confirmed by supplier |
| -> Order Line Status | Status of the line (Pending, Shipped, Cancelled…) |
| -> Order Line Incident Declared | Indicator of an incident for the line |
| -> Order Line Payment Status | Payment status for this line |
| -> Quote Line External Id | Reference to a quotation line in an external system |
| -> Confirmed Price | Price confirmed by supplier |
| -> Price | Base price for the line |
| -> Item Price Without Taxes | Price per item excluding tax |
| -> Tax Rate | Tax percentage applied |
| -> Tax Amount | Tax amount for the line |
| -> Price With Taxes | Price including taxes |
| -> Type | Type |
| -> Type Value | Value |
| -> Item Per Pack | Units per package |
| -> Quantity Per Item | Units contained per product reference |
| -> External Source | External origin of the product line |
| -> Currency | Currency used for this line |
| -> Packing Type | Packaging details (box, pallet, etc.) |
| -> External Offer Id | Reference to external offer |
| -> Shipping Price Without Taxes | Shipping price excluding taxes |
| -> Shipping Tax Amount | Tax on shipping |
| -> Shipping Price With Taxes | Shipping including tax |
| -> Total Item Price | Total price of items in this line |
| -> Total Item Price With Taxes | Item total including taxes |
| -> Total Price With Taxes | Line total including taxes |
| -> Total Item Tax Amount | Tax applied to items in this line |
| -> Total Price Without Taxes | Line total excluding tax |
| -> Total Taxes | Total tax for the line |
| -> Product Tax Code | Tax classification code for the product |
| -> Product Tax Rate | Tax rate applied to the product. |
| -> Product Tax Amount | Tax amount applied to the product |
| -> Shipping Tax Code | Tax code for shipping |
| -> Shipping Tax Rate | Tax rate on shipping |
| -> Shipping Tax Amount | Shipping tax amount |
| -> Tax Legal Notice | Legal note on taxes |
| -> Product SKU | Stock Keeping Unit identifier |
| -> Djust Product UUID | Unique product identifier in Djust |
| -> Product External Id | Product ID in external system |
| -> Product Tags | Tags or keywords linked to product |
| -> Product External Source | Product source system |
| -> Product Unit | Measurement unit (piece, kg, liter…) |
| -> Product Name | Name of the product |
| -> Product GTIN | Global Trade Item Number |
| -> Classification Category | Category assigned to the product |
| -> Classification Category External Id | External ID for product category |
| -> Product Brand | Brand of the product |
| -> Product MPN | Manufacturer Part Number |
| -> Product Default Language | Default language for product data |
| -> Product Description | Text description of the product |
| -> Navigation Categories | Navigation/category structure for e-commerce site |
| -> Product Main Image URL | Main product image link |
| -> Variant SKU | Stock Keeping Unit identifier for variant |
| -> Variant Name | Name of the variant |
| -> Variant Description | Description of the variant |
| -> Variant External Id | Variant ID in external system |
| -> Variant External Source | Source of the variant data |
| -> Variant GTIN | GTIN of the variant |
| -> Variant EAN | European Article Number |
| -> Variant MPN | Manufacturer Part Number for variant |
| -> Variant Main Image URL | Main image of the variant |
| -> Product Attribute Values | Attribute values (size, color, etc.). |
For now, the mapping of attributes and custom fields is not supported.
Custom FieldsCustom Fields can be exported as well upon request
Updated about 1 month ago
