Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

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" } }

OrderUpdatedCustomer

Customer information of the order (billing address, organization information)

Data related to the accounting contact in the organization

Customer billing address

Data related to the delivery contact in the organization

Data related to the organization that created the order (B2B transactions)

Sample
{ "accountingContact": { "__typename": "OrderUpdatedCustomerContact" }, "billingAddress": { "__typename": "OrderCustomerBillingAddress" }, "deliveryContact": { "__typename": "OrderUpdatedCustomerContact" }, "organization": { "__typename": "OrderUpdatedCustomerOrganization" } }
Referenced in

OrderUpdatedCustomerContact

Data related to the contact in the organization

customerId

Customer contact's identifier

Sample
{ "customerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }

OrderUpdatedCustomerOrganization

Data related to the organization that created the order (B2B transactions)

Address of the organization

identificationNumber

Identification number of the organization

name

Name of the organization

taxIdentificationNumber

Tax identification number of the organization

Sample
{ "address": { "__typename": "CustomerOrganizationAddress" }, "identificationNumber": "Example String", "name": "Example String", "taxIdentificationNumber": "Example String" }

OrderUpdatedOrderLine

Details of the modified order line

cancelations

List of cancelations

ecoContributions

List of eco-contribution amounts and corresponding producer identifiers, if applicable

orderLineId
ID!,non-null

Order line identifier

refunds

List of refunds

Sample
{ "cancelations": [ { "__typename": "OrderUpdatedCancelation" } ], "ecoContributions": [ { "__typename": "OrderUpdatesEcoContribution" } ], "orderLineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "refunds": [ { "__typename": "OrderUpdatedRefund" } ] }

OrderUpdatedCancelation

cancelationId

Cancelation identifier

ecoContributions

List of eco-contribution amounts and corresponding producer identifiers, if applicable

Sample
{ "cancelationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "ecoContributions": [ { "__typename": "OrderUpdatesEcoContribution" } ] }

OrderUpdatesEcoContribution

eprCategoryCode

Extended Producer Responsibility category

producerId

Producer identifier of the eco-contribution. Not present if the producer identifier belongs to the operator.

producerIdOwner

Owner of the producerId

totalAmount

Total amount of the eco-contribution

unitAmount

Unit amount of the eco-contribution

Sample
{ "eprCategoryCode": "Example String", "producerId": "Example String", "producerIdOwner": "Example String", "totalAmount": 40, "unitAmount": 40 }

OrderUpdatedRefund

refundId

Refund identifier

ecoContributions

List of eco-contribution amounts and corresponding producer identifiers, if applicable

Sample
{ "refundId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "ecoContributions": [ { "__typename": "OrderUpdatesEcoContribution" } ] }

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview