Products

Mirakl Platform

GraphQL Reference

OrderPaymentDestinationInput

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Inputs

Overview

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

OrderPromotionInput

Promotion

promoCodes

[String!],non-null

Sample

{
  "promoCodes": [
    "Example String"
  ]
}

Referenced in

CreateOrdersInput.promotion

OrderReferencesInput

Order references

orderReferenceForCustomer

String

Order reference for customer. May not be blank.

Sample

{
  "orderReferenceForCustomer": "Example String"
}

Referenced in

CreateOrdersInput.references

OrderOfferInput

Represents an offer of the commercial order

adjustmentLimit

Float

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

currency

Currency

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

deliveryDate

DeliveryDateTimeIntervalInput

Expected order delivery date

offerId

String!,non-null

Offer's identifier

offerPrice

Float!,non-null

Offer's price

orderLineAdditionalFields

[AdditionalFieldValueInput!],non-null

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

Float

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

DateTime

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

shippingFrom

OrderShippingFromInput

Describe from where the offer is shipped

shippingPrice

Float!,non-null

Shipping price

shippingPudoId

String

PickUp DropOff (PUDO) point identifier

shippingTaxes

[OrderTaxAmountInput]

The taxes to be applied on the shipping price

shippingTypeCode

String!,non-null

Shipping type code

taxes

[OrderTaxAmountInput]

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

Referenced in

CreateOrdersInput.offers

OrderTaxAmountInput

Represents the amount of a tax.

amount

Float!,non-null

Tax amount

code

String!,non-null

Tax code

rate

Float

Tax rate

Sample

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

Referenced in

OrderOfferInput.shippingTaxes

OrderOfferInput.taxes

Scalars

Overview