Products

Mirakl Platform

GraphQL Reference

OrderInvoiceInput

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Inputs

Overview

OrderCustomerBillingAddressInput

Customer's billing address

city

String!,non-null

Address City

civility

String

Civility of the person associated with the address

company

String

Company of the person associated with the address

company2

String

Second company information of the person associated with the address

country

CountryCode!,non-null

Country ISO 3166-1 code of the address

firstname

String

First information line of the address

lastname

String!,non-null

Last name of the person associated with the address

phone

String

Phone of the person associated with the address

phoneSecondary

String

Secondary phone of the person associated with the address

state

String

Address state

street1

String!,non-null

First information line of the address

street2

String

Second information line of the address

zipCode

String!,non-null

Address zip code, mandatory with some exceptions

Sample

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

Referenced in

OrdersCustomerInput.billingAddress

OrderCustomerDeliveryContactInput

Data related to the delivery contact in the organization. Can be provided for platforms supporting B2B models.

civility

String

Customer contact's civility

customerId

ID!,non-null

Customer contact's identifier

String!,non-null

Customer contact's email

firstname

String!,non-null

Customer contact's firstname

lastname

String!,non-null

Customer contact's lastname

locale

Locale

Customer contact's locale

Sample

{
  "civility": "Example String",
  "customerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "email": "Example String",
  "firstname": "Example String",
  "lastname": "Example String",
  "locale": "Example Custom Scalar"
}

Referenced in

OrdersCustomerInput.deliveryContact

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

CustomerOrganizationAddressInput

Address of the organization. Required for new organizations.

identificationNumber

String

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

String

Name of the organization. Required for new organizations.

organizationId

ID!,non-null

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

taxIdentificationNumber

String

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

Referenced in

OrdersCustomerInput.organization

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

String

Address state

street1

String!,non-null

First information line of the address

street2

String

Second information line of the address

zipCode

String

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

Referenced in

CustomerOrganizationInput.address

OrderCustomerShippingAddressInput

Customer's shipping address

additionalInfo

String

Additional information for the shipping address

city

String!,non-null

Address City

civility

String

Civility of the person associated with the address

company

String

Company of the person associated with the address

company2

String

Second company information of the person associated with the address

country

CountryCode!,non-null

Country ISO 3166-1 code of the address

firstname

String

First name of the person associated with the address

internal_additional_info

String

Internal additional information for the shipping address

lastname

String!,non-null

Last name of the person associated with the address

phone

String

Phone of the person associated with the address

phoneSecondary

String

Secondary phone of the person associated with the address

state

String

Address state

street1

String!,non-null

First information line of the address

street2

String

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

Referenced in

OrdersCustomerInput.shippingAddress

OrderInvoiceInput

Invoice information linked to the order

documentDetails

[OrderInvoiceDetailInput!]!,non-null

Invoice document information

paymentTerms

PaymentTermsInput

Payment terms

Sample

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

Referenced in

CreateOrdersInput.invoiceDetails

OrderInvoiceDetailInput

Invoice document information

format

String

Accounting document format One of: PDF, cXML

Sample

{
  "format": "Example String"
}

Referenced in

OrderInvoiceInput.documentDetails

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

Referenced in

OrderInvoiceInput.paymentTerms

OrderPaymentInfoInput

Payment information

imprintNumber

String

Payment's imprint number

paymentDestination

OrderPaymentDestinationInput

Payment destination in case of bank transfer

paymentType

String

Payment type

Sample

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

Referenced in

CreateOrdersInput.paymentInfo

OrderPaymentDestinationInput

Payment destination in case of bank transfer

ibanPaymentDestination

IbanOrderPaymentDestinationInput

Sample

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

Referenced in

OrderPaymentInfoInput.paymentDestination

IbanOrderPaymentDestinationInput

iban

String!,non-null

Bank account IBAN

paymentReference

String

The payment reference for bank transfer

Sample

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

Referenced in

OrderPaymentDestinationInput.ibanPaymentDestination

Scalars

Overview