Products

Mirakl Platform

GraphQL Reference

PatchOrderCustomerBillingAddressInput

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Inputs

Overview

ReceiveOrderInput

Represents the received order

ID!,non-null

The received order identifier

Sample

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

PatchOrdersInput

orders

[PatchOrderInput!]!,non-null

Orders to be updated, maximum number of orders per call: 100

Sample

{
  "orders": [
    {
      "__typename": "PatchOrderInput"
    }
  ]
}

PatchOrderInput

Orders to be updated, maximum number of orders per call: 100

customer

PatchOrderCustomerInput

Customer information of the order (billing address)

ID!,non-null

Order identifier

references

PatchOrderReferencesInput

Order references

Sample

{
  "customer": {
    "__typename": "PatchOrderCustomerInput"
  },
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "references": {
    "__typename": "PatchOrderReferencesInput"
  }
}

Referenced in

PatchOrdersInput.orders

PatchOrderCustomerInput

Customer information of the order (billing address)

accountingContact

PatchOrderCustomerAccountingContactInput

Data related to the accounting contact in the organization

billingAddress

PatchOrderCustomerBillingAddressInput

Customer billing address

deliveryContact

PatchOrderCustomerDeliveryContactInput

Data related to the delivery contact in the organization

organization

PatchOrderCustomerOrganizationInput

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

Sample

{
  "accountingContact": {
    "__typename": "PatchOrderCustomerAccountingContactInput"
  },
  "billingAddress": {
    "__typename": "PatchOrderCustomerBillingAddressInput"
  },
  "deliveryContact": {
    "__typename": "PatchOrderCustomerDeliveryContactInput"
  },
  "organization": {
    "__typename": "PatchOrderCustomerOrganizationInput"
  }
}

Referenced in

PatchOrderInput.customer

PatchOrderCustomerAccountingContactInput

Data related to the accounting contact in the organization

customerId

Sample

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

Referenced in

PatchOrderCustomerInput.accountingContact

PatchOrderCustomerBillingAddressInput

Customer billing address

city

String

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

Country ISO 3166-1 code of the address

firstname

String

First name of the person associated with the address

lastname

String

Last name of the person associated with the address

phone

String

Phone

phoneSecondary

String

Phone secondary

state

String

Address state

street1

String

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

PatchOrderCustomerInput.billingAddress

PatchOrderCustomerDeliveryContactInput

Data related to the delivery contact in the organization

customerId

Customer contact's civility

Sample

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

Referenced in

PatchOrderCustomerInput.deliveryContact

PatchOrderCustomerOrganizationInput

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

address

PatchOrderCustomerOrganizationAddressInput

Address of the organization

identificationNumber

String

Identification number of the organization

name

String

Name of the organization

taxIdentificationNumber

String

Tax identification number of the organization

Sample

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

Referenced in

PatchOrderCustomerInput.organization

PatchOrderCustomerOrganizationAddressInput

Address of the organization

city

String

Address city

country

CountryCode

Country ISO 3166-1 code of the address

state

String

Address state

street1

String

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

PatchOrderCustomerOrganizationInput.address

PatchOrderReferencesInput

Order references

orderReferenceForCustomer

String

Order reference for customer, only operator and front can update this field. May not be blank.

Sample

{
  "orderReferenceForCustomer": "Example String"
}

Referenced in

PatchOrderInput.references

CancelOrderLinesInput

cancelations

[CancelOrderLineInput!]!,non-null

List of representations of cancellations to be created

taxMode

String

Please note: If the taxes are not specified, the prices with mode TAX_EXCLUDED and with mode TAX_INCLUDED will return the same amounts. Possible values:

TAX_EXCLUDED: the price fields (price, unit price, shipping price and order total prices) do not include taxes (taxes come on top of the price amount).
TAX_INCLUDED: the price fields include the tax amounts. If not specified, the default order tax mode of the platform is used.

Sample

{
  "cancelations": [
    {
      "__typename": "CancelOrderLineInput"
    }
  ],
  "taxMode": "Example String"
}

Scalars

Overview