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

FieldDefinition
referenceInternal unique ID of the Order Logistic
accountExternalIdExternal unique ID of the Account
createdAtTimestamp when the Order Logistic was created
supplierExternalIdExternal identifier of the supplier handling the logistic
orderLinesList of ordered items in the Order Logistic
orderLineIdInternal unique ID of the Order Line
offerPriceExternalIdExternal unique ID of the Offer Price
variantExternalIdExternal unique ID of the Product Variant
quantityPerItemNumber of item per article
gtinGTIN
quantityQuantity of the product ordered

FieldDefinition
Order-level fields
Order idUnique identifier of the order in the system
Order Creation DateTimestamp when the order was first created
Order Update DateTimestamp of the last modification of the order
Order ReferenceReference number for the order (Internal unique ID of the Order Logistic)
Order External IdOrder identifier in an external system
Order Commercial IdUnique identifier of the order (its made of one or multiple logistic orders)
Order Commercial ReferenceCommercial tracking reference
Order Incident DeclaredIndicates if an incident (issue claim) is linked to the order
Shipping Tracking UrlURL where the customer can track the shipment
Order External SourceOriginating platform
Order statusCurrent status (Pending, Shipped...)
Order Payment StatusStatus of payment (Paid, Refunded...)
Order Payment OptionPayment method used (Credit Card, Bank Transfer…).
Order OriginChannel through which the order was placed
Shipping TypeDelivery type (Standard, Express...)
Partially Declined By SupplierIndicates if some items were rejected by the supplier
Fulfillment MessageAdditional notes or messages related to fulfillment
Lead Time To ShipEstimated time required to prepare the order before shipment
Order Validated AtDate/time when the order was validated/confirmed
Order Product CountNumber of distinct products in the order
Line CountTotal number of lines in the order
Supplier & logistics
Supplier IdUnique identifier of the supplier
Supplier NameName of the supplier/vendor
Supplier DescriptionTextual description of the supplier
Supplier Total OffersTotal number of offers available from the supplier
Supplier Total OrdersHistorical total of orders processed by this supplier
Supplier Total SalesHistorical total of sales value for this supplier
Supplier Return PolicySupplier’s return/refund policy
Supplier External IdSupplier identifier in an external system
Payment Due Date DelayAllowed payment delay in days
Payment Due Date ModeMode for computing due date
Shipping & Billing addresses
Shipping
shippingAddressSnapshot.IdInternal ID of the shipping address snapshot
shippingAddressSnapshot.countryCountry of the shipping address
shippingAddressSnapshot.labelLabel or nickname for the shipping address
shippingAddressSnapshot.fullNameFull name of the recipient
shippingAddressSnapshot.addressAddress of the recipient (street...)
shippingAddressSnapshot.additionalAddressAdditional address details (apartment, room, etc.).
shippingAddressSnapshot.cityCity of the shipping address
shippingAddressSnapshot.stateState/province/region of the shipping address
shippingAddressSnapshot.zipcodePostal/ZIP code of the shipping address
shippingAddressSnapshot.phoneContact phone number for shipping
shippingAddressSnapshot.externalIdExternal system identifier for the shipping address
shippingAddressSnapshot.companyCompany name at the shipping address
Billing
billingAddressSnapshot.idInternal ID of the billing address snapshot
billingAddressSnapshot.countryCountry of the billing address
billingAddressSnapshot.labelLabel/nickname of the billing address
billingAddressSnapshot.fullNameFull name of the billing recipient
billingAddressSnapshot.addressStreet address of the billing contact
billingAddressSnapshot.additionalAddressAdditional address details (apartment, room, etc.).
billingAddressSnapshot.cityCity of the billing address
billingAddressSnapshot.stateState/province/region of the billing address
billingAddressSnapshot.zipcodePostal/ZIP code of the billing address
billingAddressSnapshot.phonePhone number linked to billing
billingAddressSnapshot.externalIdExternal reference for billing address
billingAddressSnapshot.companyCompany name at the billing address
Customer details
Customer User IdUnique identifier of the customer user
Customer Account IdIdentifier for the customer’s account
Customer Account NameName associated with the customer account
Customer CivilityTitle (Mr, Mrs, Ms, Dr…)
Customer First NameCustomer’s first name
Customer Last NameCustomer’s last name
Customer EmailCustomer’s email address
Customer Account External IdCustomer’s account ID in an external system
Customer PhoneCustomer’s phone number
Customer Account TVA NumberVAT/Tax identification number
Order totals (Price & Taxes)
Total Shipping FeesTotal shipping costs
Total Item PriceSum of item prices (excluding taxes)
Total Order PriceFinal total price of the order (incl. taxes, shipping)
Total Tax AmountTotal amount of tax applied
Total Price Without TaxOrder subtotal before taxes
Total Price With TaxOrder total including tax
Total Shipping Tax AmountTotal tax applied on shipping costs
Total Shipping Fees Without TaxShipping fees excluding taxes
Total Shipping Fees With TaxShipping fees including taxes
Total Product Tax AmountTax applied to products
Total Product Without TaxProduct total before tax
Total Product With TaxProduct total including tax
CurrencyCurrency code (e.g., USD, EUR)
Payments
paymentsPayment records linked to the order
-> Payment AmountAmount paid in one transaction
-> Payment Transaction IdUnique identifier of the transaction
Order Lines
-> Order Line IdUnique identifier for the line item
-> Order Line External IdLine ID in an external system
-> Order Line External SourceOrigin source
-> Order Line QuantityNumber of units ordered
-> Order Line Confirmed QuantityQuantity confirmed by supplier
-> Order Line StatusStatus of the line (Pending, Shipped, Cancelled…)
-> Order Line Incident DeclaredIndicator of an incident for the line
-> Order Line Payment StatusPayment status for this line
-> Quote Line External IdReference to a quotation line in an external system
-> Confirmed PricePrice confirmed by supplier
-> PriceBase price for the line
-> Item Price Without TaxesPrice per item excluding tax
-> Tax RateTax percentage applied
-> Tax AmountTax amount for the line
-> Price With TaxesPrice including taxes
-> TypeType
-> Type ValueValue
-> Item Per PackUnits per package
-> Quantity Per ItemUnits contained per product reference
-> External SourceExternal origin of the product line
-> CurrencyCurrency used for this line
-> Packing TypePackaging details (box, pallet, etc.)
-> External Offer IdReference to external offer
-> Shipping Price Without TaxesShipping price excluding taxes
-> Shipping Tax AmountTax on shipping
-> Shipping Price With TaxesShipping including tax
-> Total Item PriceTotal price of items in this line
-> Total Item Price With TaxesItem total including taxes
-> Total Price With TaxesLine total including taxes
-> Total Item Tax AmountTax applied to items in this line
-> Total Price Without TaxesLine total excluding tax
-> Total TaxesTotal tax for the line
-> Product Tax CodeTax classification code for the product
-> Product Tax RateTax rate applied to the product.
-> Product Tax AmountTax amount applied to the product
-> Shipping Tax CodeTax code for shipping
-> Shipping Tax RateTax rate on shipping
-> Shipping Tax AmountShipping tax amount
-> Tax Legal NoticeLegal note on taxes
-> Product SKUStock Keeping Unit identifier
-> Djust Product UUIDUnique product identifier in Djust
-> Product External IdProduct ID in external system
-> Product TagsTags or keywords linked to product
-> Product External SourceProduct source system
-> Product UnitMeasurement unit (piece, kg, liter…)
-> Product NameName of the product
-> Product GTINGlobal Trade Item Number
-> Classification CategoryCategory assigned to the product
-> Classification Category External IdExternal ID for product category
-> Product BrandBrand of the product
-> Product MPNManufacturer Part Number
-> Product Default LanguageDefault language for product data
-> Product DescriptionText description of the product
-> Navigation CategoriesNavigation/category structure for e-commerce site
-> Product Main Image URLMain product image link
-> Variant SKUStock Keeping Unit identifier for variant
-> Variant NameName of the variant
-> Variant DescriptionDescription of the variant
-> Variant External IdVariant ID in external system
-> Variant External SourceSource of the variant data
-> Variant GTINGTIN of the variant
-> Variant EANEuropean Article Number
-> Variant MPNManufacturer Part Number for variant
-> Variant Main Image URLMain image of the variant
-> Product Attribute ValuesAttribute values (size, color, etc.).

❗️

For now, the mapping of attributes and custom fields is not supported.




💡

Custom Fields

Custom Fields can be exported as well upon request