Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

OpenIncidentResponse

order
Order!,non-null
Sample
{ "order": { "__typename": "Order" } }

CloseIncidentResponse

order
Order!,non-null
Sample
{ "order": { "__typename": "Order" } }

CreateOrdersResponse

Represents the list of created orders and the list of offers that could not be shipped

offersNotShippable

List of offers not shippable

orders
[Order!]!,non-null

List of orders

Sample
{ "offersNotShippable": [ { "__typename": "CreateOrdersOfferNotShippable" } ], "orders": [ { "__typename": "Order" } ] }

CreateOrdersOfferNotShippable

Contains information about non shippable offers

errorCode
String!,non-null

Error code associated with the offer not shippable

offerId
String!,non-null

Offer's identifier not shippable

Sample
{ "errorCode": "Example String", "offerId": "Example String" }

ReceiveOrderResponse

order

The received order

Sample
{ "order": { "__typename": "Order" } }

PatchOrdersUpdatedOrder

List of errors encountered when updating order

id
ID!,non-null

Order identifier

Details of the modified order

Sample
{ "errors": [ { "__typename": "PatchOrderError" } ], "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "order": { "__typename": "OrderUpdated" } }

OrderUpdatedDeliveryDateTimeInterval

earliest

Earliest order delivery date

latest

Latest order delivery date

Sample
{ "earliest": "Example Custom Scalar", "latest": "Example Custom Scalar" }

OrderUpdatedInvoiceDetails

documentDetails

Invoice document information

paymentTerms

Payment terms

Sample
{ "documentDetails": [ { "__typename": "OrderInvoiceDetail" } ], "paymentTerms": { "__typename": "PaymentTerms" } }

OrderUpdated

customer

Customer information of the order

Expected order delivery date

Invoice information linked to the order

leadTimeToShip

Lead time to ship of the order

orderLines

Details of the modified order line

paymentDestination

Payment destination in case of bank transfer

paymentWorkflow

Order payment workflow

references

Order references

shippingDeadline

Latest date of order shipment

shopStatistics

Information about order exclusion from seller statistics

Sample
{ "customer": { "__typename": "OrderUpdatedCustomer" }, "deliveryDate": { "__typename": "OrderUpdatedDeliveryDateTimeInterval" }, "invoiceDetails": { "__typename": "OrderUpdatedInvoiceDetails" }, "leadTimeToShip": 40, "orderLines": [ { "__typename": "OrderUpdatedOrderLine" } ], "paymentDestination": { "__typename": "IbanOrderPaymentDestination" }, "paymentWorkflow": "Example String", "references": { "__typename": "OrderReference" }, "shippingDeadline": "Example Custom Scalar", "shopStatistics": { "__typename": "ShopStatistics" } }

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview