Skip to content
Products
/
Mirakl Platform
/
GraphQL Reference
/
Inputs
/
PatchOrdersInput

GraphQL Overview

Download GraphQL schema
schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Inputs

Overview

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

OrderShippingFromInput

Describe from where the offer is shipped

address
OrderShippingFromAddressInput

Describe the address from where the offer is shipped

Sample
{
  "address": {
    "__typename": "OrderShippingFromAddressInput"
  }
}
Referenced in
OrderOfferInput.shippingFrom

OrderShippingFromAddressInput

Describe the address from where the offer is shipped

city
String

Address City

country
CountryCode!,non-null

Address Country ISO 3166-1 alpha-3 code (3 letters country code)

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

Sample
{
  "city": "Example String",
  "country": "Example Custom Scalar",
  "state": "Example String",
  "street1": "Example String",
  "street2": "Example String",
  "zipCode": "Example String"
}
Referenced in
OrderShippingFromInput.address

DeliveryDateTimeIntervalInput

Expected order delivery date

earliest
DateTime!,non-null

Earliest order delivery date

latest
DateTime!,non-null

Latest order delivery date

Sample
{
  "earliest": "Example Custom Scalar",
  "latest": "Example Custom Scalar"
}
Referenced in
OrderOfferInput.deliveryDate

ReceiveOrderInput

Represents the received order

id
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
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
ID
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
ID

Customer contact's civility

Sample
{
  "customerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Referenced in
PatchOrderCustomerInput.deliveryContact

Scalars

Overview