Products

Mirakl Platform

GraphQL Reference

OrderCustomerShippingAddress

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

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

OrderCustomerShippingAddress

Represents a 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 alpha-3 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

{
  "additionalInfo": "Example String",
  "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

OrderCustomer.shippingAddress

DeliveryDateTimeInterval

Represents an order's delivery interval

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

Order.deliveryDate

OrderInvoice

Represents an order's invoice information

documentDetails

[OrderInvoiceDetail!]!,non-null

Invoice document information

paymentTerms

PaymentTerms

Payment terms

Sample

{
  "documentDetails": [
    {
      "__typename": "OrderInvoiceDetail"
    }
  ],
  "paymentTerms": {
    "__typename": "PaymentTerms"
  }
}

Referenced in

Order.invoiceDetails

OrderInvoiceDetail

Represents the details of an invoice document associated with an order.

format

String

Accounting document format. Possible values: PDFm cXML

Sample

{
  "format": "Example String"
}

Referenced in

OrderUpdatedInvoiceDetails.documentDetails

OrderInvoice.documentDetails

PaymentTerms

days

Int

Number of days

type

String

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

OrderUpdatedInvoiceDetails.paymentTerms

OrderInvoice.paymentTerms

OrderLine

Represents an order's item

canOpenIncident

Boolean

Indicate if an incident can be opened on the order line

cancelations

[Cancelation!]!,non-null

List of the cancellations

history

OrderLineHistory!,non-null

Order line's history

description

String!,non-null

Order line's description

ecoContributions

[EcoContribution!]!,non-null

List of eco-contribution amounts and corresponding producer identifiers, if applicable. Only available if the operator activates the circular economy information collection.

measurement

OrderLineProductMeasurement

Measurement information of the order line

offer

OrderLineOffer!,non-null

Associated offer

additionalFields

[AdditionalFieldValue!]!,non-null

List of additional fields

ID!,non-null

Order line's identifier

index

Int!,non-null

Order line's index in the order

status

OrderStatus!,non-null

Order line's status

originUnitPrice

Float

The original unit price of the offer associated with the order line

price

PriceAmount!,non-null

Order line's price without shipping price

priceUnit

Float!,non-null

Unit price for the offer associated with the order line

promotions

[AppliedPromotion!]!,non-null

List of promotions

quantity

Int!,non-null

Product's quantity for the order line

refunds

[Refund!]!,non-null

List of the refunds

shippingPrice

ShippingAmountAndTaxes!,non-null

Order line's shipping amount and shipping taxes

taxes

[OrderTaxAmount!]!,non-null

List of taxes applied on product price

totalPrice

Float!,non-null

Order line's price with shipping price.

Sample

{
  "canOpenIncident": true,
  "cancelations": [
    {
      "__typename": "Cancelation"
    }
  ],
  "history": {
    "__typename": "OrderLineHistory"
  },
  "description": "Example String",
  "ecoContributions": [
    {
      "__typename": "EcoContribution"
    }
  ],
  "measurement": {
    "__typename": "OrderLineProductMeasurement"
  },
  "offer": {
    "__typename": "OrderLineOffer"
  },
  "additionalFields": [
    {
      "__typename": "BooleanAdditionalFieldValue"
    }
  ],
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "index": 40,
  "status": {
    "__typename": "OrderStatus"
  },
  "originUnitPrice": 40,
  "price": {
    "__typename": "PriceAmount"
  },
  "priceUnit": 40,
  "promotions": [
    {
      "__typename": "AppliedPromotion"
    }
  ],
  "quantity": 40,
  "refunds": [
    {
      "__typename": "Refund"
    }
  ],
  "shippingPrice": {
    "__typename": "ShippingAmountAndTaxes"
  },
  "taxes": [
    {
      "__typename": "OrderTaxAmount"
    }
  ],
  "totalPrice": 40
}

Referenced in

Order.orderLines

ShipmentLine.orderLine

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview