Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Inputs

Overview

OrderInvoiceInput

Invoice information linked to the order

documentDetails

Invoice document information

paymentTerms

Payment terms

Sample
{ "documentDetails": [ { "__typename": "OrderInvoiceDetailInput" } ], "paymentTerms": { "__typename": "PaymentTermsInput" } }

OrderInvoiceDetailInput

Invoice document information

format

Accounting document format One of: PDF, cXML

Sample
{ "format": "Example String" }

PaymentTermsInput

Payment terms

days
Int!,non-null

Number of days

type
String!,non-null

Payment terms type. Possible values:

  • END_OF_MONTH: payment is due after a number of calendar days following the invoice issue date, at the end of the given month.
  • NET: payment is due after a number of calendar days following the invoice issue date.
Sample
{ "days": 40, "type": "Example String" }

OrderPaymentInfoInput

Payment information

imprintNumber

Payment's imprint number

Payment destination in case of bank transfer

paymentType

Payment type

Sample
{ "imprintNumber": "Example String", "paymentDestination": { "__typename": "OrderPaymentDestinationInput" }, "paymentType": "Example String" }

OrderPaymentDestinationInput

Payment destination in case of bank transfer

ibanPaymentDestination
Sample
{ "ibanPaymentDestination": { "__typename": "IbanOrderPaymentDestinationInput" } }

IbanOrderPaymentDestinationInput

iban
String!,non-null

Bank account IBAN

paymentReference

The payment reference for bank transfer

Sample
{ "iban": "Example String", "paymentReference": "Example String" }

OrderPromotionInput

Promotion

promoCodes
[String!],non-null
Sample
{ "promoCodes": [ "Example String" ] }

OrderReferencesInput

Order references

orderReferenceForCustomer

Order reference for customer. May not be blank.

Sample
{ "orderReferenceForCustomer": "Example String" }

OrderOfferInput

Represents an offer of the commercial order

adjustmentLimit

If used, the provided adjustment limit should be less than the one at the platform level.

currency

The currency used by the shop (iso format) The field is required if the shop is not using the default Operator platform currency

Expected order delivery date

offerId
String!,non-null

Offer's identifier

offerPrice
Float!,non-null

Offer's price

orderLineAdditionalFields

Additional fields of the order lines

orderLineId

Optional order line's id If used, the provided id should be unique for the whole database. Otherwise an error will occur.

originUnitPrice

The original unit price of the offer associated with the order line

price
Float!,non-null

Price without shipping price (offer_price * quantity)

quantity
Int!,non-null

Offer's quantity requested

shippingDeadline

Order's shipping deadline. If specified, business closing days configuration will be ignored.

Describe from where the offer is shipped

shippingPrice
Float!,non-null

Shipping price

shippingPudoId

PickUp DropOff (PUDO) point identifier

The taxes to be applied on the shipping price

shippingTypeCode
String!,non-null

Shipping type code

The taxes to be applied on the product price

Sample
{ "adjustmentLimit": 40, "currency": "Example Custom Scalar", "deliveryDate": { "__typename": "DeliveryDateTimeIntervalInput" }, "offerId": "Example String", "offerPrice": 40, "orderLineAdditionalFields": [ { "__typename": "AdditionalFieldValueInput" } ], "orderLineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "originUnitPrice": 40, "price": 40, "quantity": 40, "shippingDeadline": "Example Custom Scalar", "shippingFrom": { "__typename": "OrderShippingFromInput" }, "shippingPrice": 40, "shippingPudoId": "Example String", "shippingTaxes": [ { "__typename": "OrderTaxAmountInput" } ], "shippingTypeCode": "Example String", "taxes": [ { "__typename": "OrderTaxAmountInput" } ] }

OrderTaxAmountInput

Represents the amount of a tax.

amount
Float!,non-null

Tax amount

code
String!,non-null

Tax code

rate

Tax rate

Sample
{ "amount": 40, "code": "Example String", "rate": 40 }

OrderShippingFromInput

Describe from where the offer is shipped

Describe the address from where the offer is shipped

Sample
{ "address": { "__typename": "OrderShippingFromAddressInput" } }

Scalars

Overview