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

GraphQL Overview

Download GraphQL schema
schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Inputs

Overview

OrderReferencesInput

Order references

orderReferenceForCustomer
String

Order reference for customer. May not be blank.

Sample
{
  "orderReferenceForCustomer": "Example String"
}
Referenced in
CreateOrdersInput.references

OrderOfferInput

Represents an offer of the commercial order

adjustmentLimit
Float

If used, the provided adjustment limit should be less than the one at the platform level.

currency
Currency

The currency used by the shop (iso format) The field is required if the shop is not using the default Operator platform currency

deliveryDate
DeliveryDateTimeIntervalInput

Expected order delivery date

offerId
String!,non-null

Offer's identifier

offerPrice
Float!,non-null

Offer's price

orderLineAdditionalFields
[AdditionalFieldValueInput!],non-null

Additional fields of the order lines

orderLineId
ID

Optional order line's id If used, the provided id should be unique for the whole database. Otherwise an error will occur.

originUnitPrice
Float

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

price
Float!,non-null

Price without shipping price (offer_price * quantity)

quantity
Int!,non-null

Offer's quantity requested

shippingDeadline
DateTime

Order's shipping deadline. If specified, business closing days configuration will be ignored.

shippingFrom
OrderShippingFromInput

Describe from where the offer is shipped

shippingPrice
Float!,non-null

Shipping price

shippingPudoId
String

PickUp DropOff (PUDO) point identifier

shippingTaxes
[OrderTaxAmountInput]

The taxes to be applied on the shipping price

shippingTypeCode
String!,non-null

Shipping type code

taxes
[OrderTaxAmountInput]

The taxes to be applied on the product price

Sample
{
  "adjustmentLimit": 40,
  "currency": "Example Custom Scalar",
  "deliveryDate": {
    "__typename": "DeliveryDateTimeIntervalInput"
  },
  "offerId": "Example String",
  "offerPrice": 40,
  "orderLineAdditionalFields": [
    {
      "__typename": "AdditionalFieldValueInput"
    }
  ],
  "orderLineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "originUnitPrice": 40,
  "price": 40,
  "quantity": 40,
  "shippingDeadline": "Example Custom Scalar",
  "shippingFrom": {
    "__typename": "OrderShippingFromInput"
  },
  "shippingPrice": 40,
  "shippingPudoId": "Example String",
  "shippingTaxes": [
    {
      "__typename": "OrderTaxAmountInput"
    }
  ],
  "shippingTypeCode": "Example String",
  "taxes": [
    {
      "__typename": "OrderTaxAmountInput"
    }
  ]
}
Referenced in
CreateOrdersInput.offers

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

Scalars

Overview