Skip to content
Products
/
Mirakl Platform
/
GraphQL Reference
/
Objects
/
OrderStatus

GraphQL Overview

Download GraphQL schema
schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

OfferLogisticClass

Represents an offer logistic class

code
String!,non-null

Logistic class code

label
String!,non-null

Logistic class label

Sample
{
  "code": "Example String",
  "label": "Example String"
}
Referenced in
Offer.logisticClass

OrdersConnection

The connection type for Order.

pageInfo
PageInfo!,non-null

Information to aid in pagination.

edges
[OrderEdge!]!,non-null

A list of edges.

Implements interfaces

Connection
Sample
{
  "pageInfo": {
    "endCursor": "Example String",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "Example String"
  },
  "edges": [
    {
      "node": {
        "additionalFields": [
          {
            "__typename": "BooleanAdditionalFieldValue"
          }
        ],
        "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "canCancel": true,
        "canEvaluate": true,
        "commercialId": "Example String",
        "createdDate": "Example Custom Scalar",
        "currency": "Example Custom Scalar",
        "customer": {
          "__typename": "OrderCustomer"
        },
        "customerDebitedDate": "Example Custom Scalar",
        "customerDirectlyPaysSeller": true,
        "deliveryDate": {
          "__typename": "DeliveryDateTimeInterval"
        },
        "documents": {
          "__typename": "OrderDocuments"
        },
        "evaluation": {
          "__typename": "Evaluation"
        },
        "fullyRefunded": true,
        "hasIncident": true,
        "hasInvoice": true,
        "invoiceDetails": {
          "__typename": "OrderInvoice"
        },
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "lastUpdateDate": "Example Custom Scalar",
        "orderLines": [
          {
            "__typename": "OrderLine"
          }
        ],
        "orderTaxMode": "Example String",
        "paymentDestination": {
          "__typename": "IbanOrderPaymentDestination"
        },
        "paymentDuration": 40,
        "paymentType": "Example String",
        "paymentWorkflow": "Example String",
        "price": 40,
        "promotions": {
          "__typename": "OrderComputedPromotions"
        },
        "references": {
          "__typename": "OrderReference"
        },
        "shipping": {
          "__typename": "OrderShipping"
        },
        "shipments": [
          {
            "__typename": "Shipment"
          }
        ],
        "shop": {
          "__typename": "Shop"
        },
        "status": {
          "__typename": "OrderStatus"
        },
        "totalPrice": 40,
        "threads": {
          "__typename": "ThreadConnection"
        }
      }
    }
  ]
}

OrderEdge

An edge in a connection.

node
Order!,non-null

The item of the edge.

Sample
{
  "node": {
    "additionalFields": [
      {
        "__typename": "BooleanAdditionalFieldValue"
      }
    ],
    "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "canCancel": true,
    "canEvaluate": true,
    "commercialId": "Example String",
    "createdDate": "Example Custom Scalar",
    "currency": "Example Custom Scalar",
    "customer": {
      "__typename": "OrderCustomer"
    },
    "customerDebitedDate": "Example Custom Scalar",
    "customerDirectlyPaysSeller": true,
    "deliveryDate": {
      "__typename": "DeliveryDateTimeInterval"
    },
    "documents": {
      "__typename": "OrderDocuments"
    },
    "evaluation": {
      "__typename": "Evaluation"
    },
    "fullyRefunded": true,
    "hasIncident": true,
    "hasInvoice": true,
    "invoiceDetails": {
      "__typename": "OrderInvoice"
    },
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "lastUpdateDate": "Example Custom Scalar",
    "orderLines": [
      {
        "__typename": "OrderLine"
      }
    ],
    "orderTaxMode": "Example String",
    "paymentDestination": {
      "__typename": "IbanOrderPaymentDestination"
    },
    "paymentDuration": 40,
    "paymentType": "Example String",
    "paymentWorkflow": "Example String",
    "price": 40,
    "promotions": {
      "__typename": "OrderComputedPromotions"
    },
    "references": {
      "__typename": "OrderReference"
    },
    "shipping": {
      "__typename": "OrderShipping"
    },
    "shipments": [
      {
        "__typename": "Shipment"
      }
    ],
    "shop": {
      "__typename": "Shop"
    },
    "status": {
      "__typename": "OrderStatus"
    },
    "totalPrice": 40,
    "threads": {
      "__typename": "ThreadConnection"
    }
  }
}
Referenced in
OrdersConnection.edges

Order

Represents an order placed by a customer

additionalFields
[AdditionalFieldValue!]!,non-null

Order's additional fields

businessId
ID!,non-null

Order's internal identifier

canCancel
Boolean!,non-null

Indicate if the order can be cancelled

canEvaluate
Boolean!,non-null

Indicates if the order can be evaluated by the customer

commercialId
String!,non-null

Commercial order's identifier

createdDate
DateTime!,non-null

Order's creation date

currency
Currency!,non-null

Shop's currency (iso format)

customer
OrderCustomer!,non-null

Information of the customer who ordered

customerDebitedDate
DateTime

The payment's date of the order by the customer

customerDirectlyPaysSeller
Boolean

True if order is paid directly to seller. False otherwise.

deliveryDate
DeliveryDateTimeInterval

Expected order delivery date

documents
OrderDocuments

All the documents available on the order

evaluation
Evaluation

Order's evaluation

fullyRefunded
Boolean!,non-null

Refunds have been requested and their cumulated amounts correspond to the sum of all remaining active order lines.

hasIncident
Boolean!,non-null

Indicate if order has incident on at least one order line

hasInvoice
Boolean!,non-null

Is an invoice available for this order.

invoiceDetails
OrderInvoice

Invoice information linked to the order

id
ID!,non-null

Order's identifier

lastUpdateDate
DateTime

Order's last updated date

orderLines
[OrderLine!]!,non-null

Order lines

orderTaxMode
String!,non-null

Please note: In case there is no tax, the prices will show the same amount in TAX_EXCLUDED and TAX_INCLUDED mode. The tax mode is only useful if taxes are specified in the order. Possible values: - TAX_EXCLUDED: the price fields (price, unit price, shipping price, cancellation amount, refund amount and order total prices) are expressed without tax (taxes should be added to these prices in order to get the full amount including taxes). - TAX_INCLUDED: the price fields include the tax amount.

paymentDestination
OrderPaymentDestination

Payment destination in case of bank transfer

paymentDuration
Int

The payment's duration (i.e. the delay after which the order is supposed to be paid), in days. Only applicable for PAY_ON_DUE_DATE orders, null otherwise. Note that this field has currently no impact on the order workflow, it is provided for information purposes.

paymentType
String

The payment's type used by the customer to pay this order

paymentWorkflow
String

The payment workflow followed by the order. Possible values are: PAY_ON_ACCEPTANCE, PAY_ON_DELIVERY, PAY_ON_DUE_DATE, PAY_ON_SHIPMENT, NO_CUSTOMER_PAYMENT_CONFIRMATION

price
Float!,non-null

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

promotions
OrderComputedPromotions

Promotions' summary applied to the order

references
OrderReference

Order references

shipping
OrderShipping

Order's shipping information

shipments
[Shipment!]!,non-null

Order's shipments information

shop
Shop

Shop associated to the order

status
OrderStatus!,non-null

Order's status

totalPrice
Float!,non-null

Total order's price (sum of the order's price and the order's shipping price).

threads
ThreadConnection!,non-null

Order's threads

firstafterlastbefore

Implements interfaces

Node
Sample
{
  "additionalFields": [
    {
      "__typename": "BooleanAdditionalFieldValue"
    }
  ],
  "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "canCancel": true,
  "canEvaluate": true,
  "commercialId": "Example String",
  "createdDate": "Example Custom Scalar",
  "currency": "Example Custom Scalar",
  "customer": {
    "__typename": "OrderCustomer"
  },
  "customerDebitedDate": "Example Custom Scalar",
  "customerDirectlyPaysSeller": true,
  "deliveryDate": {
    "__typename": "DeliveryDateTimeInterval"
  },
  "documents": {
    "__typename": "OrderDocuments"
  },
  "evaluation": {
    "__typename": "Evaluation"
  },
  "fullyRefunded": true,
  "hasIncident": true,
  "hasInvoice": true,
  "invoiceDetails": {
    "__typename": "OrderInvoice"
  },
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "lastUpdateDate": "Example Custom Scalar",
  "orderLines": [
    {
      "__typename": "OrderLine"
    }
  ],
  "orderTaxMode": "Example String",
  "paymentDestination": {
    "__typename": "IbanOrderPaymentDestination"
  },
  "paymentDuration": 40,
  "paymentType": "Example String",
  "paymentWorkflow": "Example String",
  "price": 40,
  "promotions": {
    "__typename": "OrderComputedPromotions"
  },
  "references": {
    "__typename": "OrderReference"
  },
  "shipping": {
    "__typename": "OrderShipping"
  },
  "shipments": [
    {
      "__typename": "Shipment"
    }
  ],
  "shop": {
    "__typename": "Shop"
  },
  "status": {
    "__typename": "OrderStatus"
  },
  "totalPrice": 40,
  "threads": {
    "__typename": "ThreadConnection"
  }
}
Referenced in
OpenIncidentResponse.order
CloseIncidentResponse.order
CreateOrdersResponse.orders
ReceiveOrderResponse.order
OrderEdge.node

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
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).

email
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

email
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

email
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
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

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview