Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Inputs

Overview

CustomerOrganizationInput

Data related to the organization that created the order (B2B transactions). Mandatory if corresponding platform setting requires it. Can update organization data if an organization already exists with the “organization_id” provided and other fields are filled in. Otherwise creates a new organization.

Address of the organization. Required for new organizations.

identificationNumber

Number used to identify the customer organization as an established business in a country. E.g: SIRET number in France, NIF in Spain. Required for new organizations.

name

Name of the organization. Required for new organizations.

organizationId
ID!,non-null

Customer's organization id (from the operator's system)

taxIdentificationNumber

Tax identification number of the organization.

Sample
{ "address": { "__typename": "CustomerOrganizationAddressInput" }, "identificationNumber": "Example String", "name": "Example String", "organizationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "taxIdentificationNumber": "Example String" }

CustomerOrganizationAddressInput

Address of the organization. Required for new organizations.

city
String!,non-null

Address City

country
CountryCode!,non-null

Country ISO 3166-1 code of the address

state

Address state

street1
String!,non-null

First information line of the address

street2

Second information line of the address

zipCode

Address zip code, mandatory with some exceptions

Sample
{ "city": "Example String", "country": "Example Custom Scalar", "state": "Example String", "street1": "Example String", "street2": "Example String", "zipCode": "Example String" }

OrderCustomerShippingAddressInput

Customer's shipping address

additionalInfo

Additional information for the shipping address

city
String!,non-null

Address City

civility

Civility of the person associated with the address

company

Company of the person associated with the address

company2

Second company information of the person associated with the address

country
CountryCode!,non-null

Country ISO 3166-1 code of the address

firstname

First name of the person associated with the address

internal_additional_info

Internal additional information for the shipping address

lastname
String!,non-null

Last name of the person associated with the address

phone

Phone of the person associated with the address

phoneSecondary

Secondary phone of the person associated with the address

state

Address state

street1
String!,non-null

First information line of the address

street2

Second information line of the address

zipCode
String!,non-null

Address zip code, mandatory with some exceptions

Sample
{ "additionalInfo": "Example String", "city": "Example String", "civility": "Example String", "company": "Example String", "company2": "Example String", "country": "Example Custom Scalar", "firstname": "Example String", "internal_additional_info": "Example String", "lastname": "Example String", "phone": "Example String", "phoneSecondary": "Example String", "state": "Example String", "street1": "Example String", "street2": "Example String", "zipCode": "Example String" }

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

Scalars

Overview