Products

Mirakl Platform

GraphQL Reference

OrderCustomerDeliveryContact

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

OrderCustomer

Represents a customer who placed an order

accountingContact

OrderCustomerAccountingContact

Data related to the accounting contact in the organization. Null before shipping (or acceptance, depending on platform setting).

billingAddress

OrderCustomerBillingAddress!,non-null

Customer's billing address. Null before shipping (or acceptance, depending on platform setting).

civility

String

Customer's civility

ID!,non-null

Customer's identifier

deliveryContact

OrderCustomerDeliveryContact

Data related to the delivery contact in the organization. Null before shipping (or acceptance, depending on platform setting).

String!,non-null

Customer's email

firstname

String!,non-null

Customer's first name

lastname

String!,non-null

Customer's last name

locale

Locale

Customer's locale

organization

CustomerOrganization

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

shippingAddress

OrderCustomerShippingAddress!,non-null

Customer's Shipping address. Null before shipping (or acceptance, depending on platform setting).

Sample

{
  "accountingContact": {
    "__typename": "OrderCustomerAccountingContact"
  },
  "billingAddress": {
    "__typename": "OrderCustomerBillingAddress"
  },
  "civility": "Example String",
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "deliveryContact": {
    "__typename": "OrderCustomerDeliveryContact"
  },
  "email": "Example String",
  "firstname": "Example String",
  "lastname": "Example String",
  "locale": "Example Custom Scalar",
  "organization": {
    "__typename": "CustomerOrganization"
  },
  "shippingAddress": {
    "__typename": "OrderCustomerShippingAddress"
  }
}

Referenced in

Order.customer

OrderStatus

Represents an order or order line status

state

String!,non-null

State

reason

OrderStatusReason

State reason

Sample

{
  "state": "Example String",
  "reason": {
    "__typename": "OrderStatusReason"
  }
}

Referenced in

Order.status

OrderLine.status

OrderStatusReason

Represents the status reason

code

String

Reason's code of the state

label

String

Reason's label of the state

Sample

{
  "code": "Example String",
  "label": "Example String"
}

Referenced in

OrderStatus.reason

OrderCustomerAccountingContact

Represents a customer's accounting contact

civility

String

Customer contact's civility

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",
  "email": "Example String",
  "firstname": "Example String",
  "lastname": "Example String",
  "locale": "Example Custom Scalar"
}

Referenced in

OrderCustomer.accountingContact

OrderCustomerBillingAddress

Represents a 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 name of the person associated with the address

lastname

String!,non-null

Last name of the person associated with the address

phone

String

Phone number

phoneSecondary

String

Secondary phone number

state

String

Address state

street1

String!,non-null

First information line of the address street

street2

String

Second information line of the address street

zipCode

String

Address zip code

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

OrderUpdatedCustomer.billingAddress

OrderCustomer.billingAddress

OrderCustomerDeliveryContact

Represents a customer's delivery contact

civility

String

Customer contact's civility

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",
  "email": "Example String",
  "firstname": "Example String",
  "lastname": "Example String",
  "locale": "Example Custom Scalar"
}

Referenced in

OrderCustomer.deliveryContact

CustomerOrganization

Represents a customer's organization details

address

CustomerOrganizationAddress

Address of the organization. Required for new organizations. Null before shipping (or acceptance, depending on platform setting).

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. Null before shipping (or acceptance, depending on platform setting).

name

String

Name of the organization.

ID!,non-null

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

taxIdentificationNumber

String

Tax identification number of the organization. Null before shipping (or acceptance, depending on platform setting).

Sample

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

Referenced in

OrderCustomer.organization

CustomerOrganizationAddress

Represents a customer's organization address

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 street

street2

String

Second information line of the address street

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

OrderUpdatedCustomerOrganization.address

CustomerOrganization.address

OrderShipping

Represents an order's shipping information

deadline

DateTime

Order's shipping deadline

price

Float!,non-null

Order's shipping price (sum of order line's shipping price)

pudoId

String

PickUp DropOff (PUDO) point identifier

type

OrderShippingType!,non-null

Order shipping type

zone

OrderShippingZone!,non-null

Order shipping zone

Sample

{
  "deadline": "Example Custom Scalar",
  "price": 40,
  "pudoId": "Example String",
  "type": {
    "__typename": "OrderShippingType"
  },
  "zone": {
    "__typename": "OrderShippingZone"
  }
}

Referenced in

Order.shipping

OrderShippingZone

Represents an order's shipping zone

code

String!,non-null

Code of shipping's zone

label

String!,non-null

Label of shipping's zone

Sample

{
  "code": "Example String",
  "label": "Example String"
}

Referenced in

OrderShipping.zone

OrderShippingType

Represents an order's shipping type

code

String!,non-null

Code of shipping's type

label

String!,non-null

Label of shipping's type

Sample

{
  "code": "Example String",
  "label": "Example String"
}

Referenced in

OrderShipping.type

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview