Order
Represents a product linked to an order line
List of all product's media associated to the order line
Associated offer sku (this is the sku of the offer defined by the shop)
Title of the product associated with the order line
Product's category information
{ "media": [ { "__typename": "ProductMedia" } ], "sku": "Example String", "title": "Example String", "category": { "__typename": "OrderLineCategory" } }
Cancelation
Cancelation represents the cancellation details of an order item (OrderLine).
Cancellation's amount
Cancellation's creation date
List of eco-contribution amounts and corresponding producer identifiers, if applicable Only available if the operator activates the circular economy information collection.
Cancellation's id
The quantity of products canceled (This quantity is informative only)
Cancellation reason's code
Cancellation's shipping amount and shipping taxes
The taxes on the price
{ "amount": { "__typename": "PriceAmount" }, "createdDate": "Example Custom Scalar", "ecoContributions": [ { "__typename": "EcoContribution" } ], "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "quantity": 40, "reasonCode": "Example String", "shippingAmount": { "__typename": "ShippingAmountAndTaxes" }, "taxes": [ { "__typename": "OrderTaxAmount" } ] }
Amount
Represent a part of an amount. The sum of each part's amount is equal to the total amount.
Part's amount. The sum of each part's amount is equal to the total amount.
Should this amount be debited to the customer. If true, the amount is taken into account when generating the debit file. If false, the amount is not taken into account when generating the debit file.
{ "amount": 40, "debitableFromCustomer": true }
Order
Represents the amount of a tax.
Tax amount
The breakdown of the tax amount, only available when advanced features are enabled
Tax code
Tax rate
{ "amount": 40, "breakdown": { "__typename": "AmountBreakdown" }, "code": "Example String", "rate": 40 }
Order
Represents measurement information of an order item (OrderLine)
Actual measurement on the order line
Measurement unit of the order line. Possible values: GRAM, KILOGRAM, TON, POUND, OUNCE, MILLILITER, CENTILITER, CUBIC_METER, LITER, GALLON, FLUID_OUNCE, PINT, BARREL, CENTIMETER, METER, INCH, FEET, SQUARE_CENTIMETER, SQUARE_METER, SQUARE_INCH, SQUARE_FOOT
Total measurement ordered on the order line
{ "actualMeasurement": 40, "measurementUnit": "Example String", "orderedMeasurement": 40 }
Order
Represents an order's promotions
The promotions applied on this order
The total amount deduced on this order thanks to the promotions
{ "appliedPromotions": [ { "__typename": "AppliedPromotion" } ], "totalDeducedAmount": 40 }
Applied
Represents a promotion applied to an element
Whether the promotion's deduced amount has been divided among multiple order lines
Configuration used to calculate the applied promotion
Promotion's amount.
Promotion's id, defined by the shop
The quantity of free items offered by the promotion for this line. Only applicable when promotion is of type FREE_ITEMS, null otherwise.
Promo code associated to the promotion
{ "apportioned": true, "configuration": { "__typename": "AppliedPromotionConfiguration" }, "deducedAmount": 40, "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "offeredQuantity": 40, "promoCode": "Example String" }
Applied
Represents a promotion's configuration
The amount off of the promotion. Only applicable when promotion is of type AMOUNT_OFF, null otherwise.
The free item target quantity of the promotion. Only applicable when promotion is of type FREE_ITEMS, null otherwise.
The percentage off of the promotion. Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise.
The reduced unit price of this promotion. Only applicable when the promotion is of type REDUCED_UNIT_PRICE, null otherwise.
Promotion's type, whether it is applied to this item (ITEM), or every items in the basket for this shop (BASKET). Possible values are: ALL, AMOUNT_OFF, FREE_ITEMS, PERCENTAGE_OFF, REDUCED_UNIT_PRICE
{ "amountOff": 40, "freeItemsQuantity": 40, "percentageOff": 40, "reducedUnitPrice": 40, "type": "Example String" }