Price
Represents a price
The context is not returned for default prices
Price of the offer. If a discount is defined and is currently active (within the validity interval), it represents the unit discount price. In other cases, it represents the unit_origin_price.
Discount of the offer
Volume prices for each quantity threshold. Returns at least the price for a quantity threshold of one.
{ "context": { "__typename": "PriceContext" }, "price": 40, "discount": { "__typename": "DiscountPrice" }, "volumePrice": [ { "__typename": "VolumePrice" } ] }
Price
Represents the criteria on which a specific price applies
The start date of a specific price
The end date of a specific price
The channels on which a specific price applies
The customer organization ids on which a specific price applies
The customer group ids on which a specific price applies
{ "start": "Example Custom Scalar", "end": "Example Custom Scalar", "channels": [ { "__typename": "Channel" } ], "customerOrganizationIds": [ "Example String" ], "customerGroupIds": [ "Example String" ] }
Discount
Represents a discount price
Discount price for a quantity of one, i.e. the discount price for a quantity of one regardless of the discount activation. Set to null if no discount is defined or if no discount price for a quantity of one is defined.
Start date of the discount, or null if the discount does not have a start date
End date of the discount, or null if the discount does not have an end date
{ "price": 40, "start": "Example Custom Scalar", "end": "Example Custom Scalar" }
Orders
The connection type for Order.
Information to aid in pagination.
A list of edges.
Implements interfaces
{ "pageInfo": { "endCursor": "Example String", "hasNextPage": true, "hasPreviousPage": true, "startCursor": "Example String" }, "edges": [ { "node": { "additionalFields": [ { "__typename": "BooleanAdditionalFieldValue" } ], "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "canCancel": true, "canEvaluate": true, "commercialId": "Example String", "createdDate": "Example Custom Scalar", "currency": "Example Custom Scalar", "customer": { "__typename": "OrderCustomer" }, "customerDebitedDate": "Example Custom Scalar", "customerDirectlyPaysSeller": true, "deliveryDate": { "__typename": "DeliveryDateTimeInterval" }, "documents": { "__typename": "OrderDocuments" }, "evaluation": { "__typename": "Evaluation" }, "fullyRefunded": true, "hasIncident": true, "hasInvoice": true, "invoiceDetails": { "__typename": "OrderInvoice" }, "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "lastUpdateDate": "Example Custom Scalar", "orderLines": [ { "__typename": "OrderLine" } ], "orderTaxMode": "Example String", "paymentDestination": { "__typename": "IbanOrderPaymentDestination" }, "paymentDuration": 40, "paymentType": "Example String", "paymentWorkflow": "Example String", "price": 40, "promotions": { "__typename": "OrderComputedPromotions" }, "references": { "__typename": "OrderReference" }, "shipping": { "__typename": "OrderShipping" }, "shipments": [ { "__typename": "Shipment" } ], "shop": { "__typename": "Shop" }, "status": { "__typename": "OrderStatus" }, "totalPrice": 40, "threads": { "__typename": "ThreadConnection" } } } ] }
Order
An edge in a connection.
The item of the edge.
{ "node": { "additionalFields": [ { "__typename": "BooleanAdditionalFieldValue" } ], "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "canCancel": true, "canEvaluate": true, "commercialId": "Example String", "createdDate": "Example Custom Scalar", "currency": "Example Custom Scalar", "customer": { "__typename": "OrderCustomer" }, "customerDebitedDate": "Example Custom Scalar", "customerDirectlyPaysSeller": true, "deliveryDate": { "__typename": "DeliveryDateTimeInterval" }, "documents": { "__typename": "OrderDocuments" }, "evaluation": { "__typename": "Evaluation" }, "fullyRefunded": true, "hasIncident": true, "hasInvoice": true, "invoiceDetails": { "__typename": "OrderInvoice" }, "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "lastUpdateDate": "Example Custom Scalar", "orderLines": [ { "__typename": "OrderLine" } ], "orderTaxMode": "Example String", "paymentDestination": { "__typename": "IbanOrderPaymentDestination" }, "paymentDuration": 40, "paymentType": "Example String", "paymentWorkflow": "Example String", "price": 40, "promotions": { "__typename": "OrderComputedPromotions" }, "references": { "__typename": "OrderReference" }, "shipping": { "__typename": "OrderShipping" }, "shipments": [ { "__typename": "Shipment" } ], "shop": { "__typename": "Shop" }, "status": { "__typename": "OrderStatus" }, "totalPrice": 40, "threads": { "__typename": "ThreadConnection" } } }
Order
Represents an order placed by a customer
Order's additional fields
Order's internal identifier
Indicate if the order can be cancelled
Indicates if the order can be evaluated by the customer
Commercial order's identifier
Order's creation date
Shop's currency (iso format)
Information of the customer who ordered
The payment's date of the order by the customer
True if order is paid directly to seller. False otherwise.
Expected order delivery date
All the documents available on the order
Order's evaluation
Refunds have been requested and their cumulated amounts correspond to the sum of all remaining active order lines.
Indicate if order has incident on at least one order line
Is an invoice available for this order.
Invoice information linked to the order
Order's identifier
Order's last updated date
Order lines
Please note: In case there is no tax, the prices will show the same amount in TAX_EXCLUDED and TAX_INCLUDED mode. The tax mode is only useful if taxes are specified in the order. Possible values: - TAX_EXCLUDED: the price fields (price, unit price, shipping price, cancellation amount, refund amount and order total prices) are expressed without tax (taxes should be added to these prices in order to get the full amount including taxes). - TAX_INCLUDED: the price fields include the tax amount.
Payment destination in case of bank transfer
The payment's duration (i.e. the delay after which the order is supposed to be paid), in days. Only applicable for PAY_ON_DUE_DATE orders, null otherwise. Note that this field has currently no impact on the order workflow, it is provided for information purposes.
The payment's type used by the customer to pay this order
The payment workflow followed by the order. Possible values are: PAY_ON_ACCEPTANCE, PAY_ON_DELIVERY, PAY_ON_DUE_DATE, PAY_ON_SHIPMENT, NO_CUSTOMER_PAYMENT_CONFIRMATION
Order's price (sum of order line's price)
Promotions' summary applied to the order
Order references
Order's shipping information
Order's shipments information
Shop associated to the order
Order's status
Total order's price (sum of the order's price and the order's shipping price).
Order's threads
Implements interfaces
{ "additionalFields": [ { "__typename": "BooleanAdditionalFieldValue" } ], "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "canCancel": true, "canEvaluate": true, "commercialId": "Example String", "createdDate": "Example Custom Scalar", "currency": "Example Custom Scalar", "customer": { "__typename": "OrderCustomer" }, "customerDebitedDate": "Example Custom Scalar", "customerDirectlyPaysSeller": true, "deliveryDate": { "__typename": "DeliveryDateTimeInterval" }, "documents": { "__typename": "OrderDocuments" }, "evaluation": { "__typename": "Evaluation" }, "fullyRefunded": true, "hasIncident": true, "hasInvoice": true, "invoiceDetails": { "__typename": "OrderInvoice" }, "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "lastUpdateDate": "Example Custom Scalar", "orderLines": [ { "__typename": "OrderLine" } ], "orderTaxMode": "Example String", "paymentDestination": { "__typename": "IbanOrderPaymentDestination" }, "paymentDuration": 40, "paymentType": "Example String", "paymentWorkflow": "Example String", "price": 40, "promotions": { "__typename": "OrderComputedPromotions" }, "references": { "__typename": "OrderReference" }, "shipping": { "__typename": "OrderShipping" }, "shipments": [ { "__typename": "Shipment" } ], "shop": { "__typename": "Shop" }, "status": { "__typename": "OrderStatus" }, "totalPrice": 40, "threads": { "__typename": "ThreadConnection" } }
Order
Represents a customer who placed an order
Data related to the accounting contact in the organization. Null before shipping (or acceptance, depending on platform setting).
Customer's billing address. Null before shipping (or acceptance, depending on platform setting).
Customer's civility
Customer's identifier
Data related to the delivery contact in the organization. Null before shipping (or acceptance, depending on platform setting).
Customer's email
Customer's first name
Customer's last name
Customer's locale
Data related to the organization that created the order (B2B transactions)
Customer's Shipping address. Null before shipping (or acceptance, depending on platform setting).
{ "accountingContact": { "__typename": "OrderCustomerAccountingContact" }, "billingAddress": { "__typename": "OrderCustomerBillingAddress" }, "civility": "Example String", "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "deliveryContact": { "__typename": "OrderCustomerDeliveryContact" }, "email": "Example String", "firstname": "Example String", "lastname": "Example String", "locale": "Example Custom Scalar", "organization": { "__typename": "CustomerOrganization" }, "shippingAddress": { "__typename": "OrderCustomerShippingAddress" } }