Products

Mirakl Platform

GraphQL Reference

OfferDeliveryTime

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

OfferInactivityReason

Represents an inactivity reason

code

String!,non-null

Inactivity reason code

Sample

{
  "code": "Example String"
}

Referenced in

Offer.inactivityReasons

OfferOrderQuantity

Represents the constraint related to quantity of the offer per order

min

Int

The minimum quantity of the offer per order

max

Int

The maximum quantity of the offer per order

Sample

{
  "min": 40,
  "max": 40
}

Referenced in

Offer.orderQuantity

OfferMinShippingInformation

Represents the min shipping information for this offer

price

Float!,non-null

Unit price of the minimum shipping rate

priceAdditional

Float!,non-null

Additional unit price associated to the minimum shipping rate

type

String!,non-null

Code of the shipping type associated to the minimum shipping rate

zone

String!,non-null

Code of the shipping zone associated to the minimum shipping rate

Sample

{
  "price": 40,
  "priceAdditional": 40,
  "type": "Example String",
  "zone": "Example String"
}

Referenced in

Offer.minShipping

OfferShippingInformation

Represents shipping information for this offer

deadline

DateTime!,non-null

Estimated shipping date, that includes business closing days and cut-off configured on the platform. Add the earliest and latest delivery times to calculate the estimated delivery date to customers.

types

[OfferShippingType!]!,non-null

List of shipping types compatible with the given offer

Sample

{
  "deadline": "Example Custom Scalar",
  "types": [
    {
      "__typename": "OfferShippingType"
    }
  ]
}

Referenced in

Offer.shipping

OfferShippingType

Represents a shipping type

code

String!,non-null

Shipping type code

cutOffNextDate

DateTime

Next cutoff date

cutOffTime

String

Shipping type Cutoff time

deliveryTime

OfferDeliveryTime

Expected delivery time

label

String!,non-null

Shipping type label

deadline

DateTime

Estimated shipping date, that includes business closing days and cut-off configured on the platform. Add the earliest and latest delivery times to calculate the estimated delivery date to customers.

priceUnit

Float!,non-null

Shipping price of the offer

zoneCode

String!,non-null

Shipping zone code

zoneLabel

String!,non-null

Shipping zone label

standardCode

String

Shipping type standard code

Sample

{
  "code": "Example String",
  "cutOffNextDate": "Example Custom Scalar",
  "cutOffTime": "Example String",
  "deliveryTime": {
    "__typename": "OfferDeliveryTime"
  },
  "label": "Example String",
  "deadline": "Example Custom Scalar",
  "priceUnit": 40,
  "zoneCode": "Example String",
  "zoneLabel": "Example String",
  "standardCode": "Example String"
}

Referenced in

OfferShippingInformation.types

OfferDeliveryTime

Represents an expected delivery time

earliestDays

Int!,non-null

Earliest order delivery time

earliestDeliveryDate

DateTime!,non-null

Earliest order delivery date

latestDays

Int!,non-null

Latest order delivery time

latestDeliveryDate

DateTime!,non-null

Latest order delivery date

Sample

{
  "earliestDays": 40,
  "earliestDeliveryDate": "Example Custom Scalar",
  "latestDays": 40,
  "latestDeliveryDate": "Example Custom Scalar"
}

Referenced in

OfferShippingType.deliveryTime

Product

Represents the product related to the offer

sku

String!,non-null

SKU of the product

references

[OfferProductReference!]!,non-null

List of product's references

ProductCategory

Represents a product's category

code

String!,non-null

Code of the product category

Sample

{
  "code": "Example String"
}

Referenced in

Product.category

OfferProductReference

Represents a product reference

type

String!,non-null

Type of the reference

reference

String!,non-null

Value of the reference

Sample

{
  "type": "Example String",
  "reference": "Example String"
}

Referenced in

Product.references

Price

Represents a price

context

PriceContext

The context is not returned for default prices

price

Float!,non-null

Price of the offer. If a discount is defined and is currently active (within the validity interval), it represents the unit discount price. In other cases, it represents the unit_origin_price.

discount

DiscountPrice

Discount of the offer

volumePrice

[VolumePrice!]!,non-null

Volume prices for each quantity threshold. Returns at least the price for a quantity threshold of one.

Sample

{
  "context": {
    "__typename": "PriceContext"
  },
  "price": 40,
  "discount": {
    "__typename": "DiscountPrice"
  },
  "volumePrice": [
    {
      "__typename": "VolumePrice"
    }
  ]
}

Referenced in

Offer.prices

PriceContext

Represents the criteria on which a specific price applies

start

DateTime

The start date of a specific price

end

DateTime

The end date of a specific price

channels

[Channel!],non-null

The channels on which a specific price applies

customerOrganizationIds

[String!],non-null

The customer organization ids on which a specific price applies

customerGroupIds

[String!],non-null

The customer group ids on which a specific price applies

Sample

{
  "start": "Example Custom Scalar",
  "end": "Example Custom Scalar",
  "channels": [
    {
      "__typename": "Channel"
    }
  ],
  "customerOrganizationIds": [
    "Example String"
  ],
  "customerGroupIds": [
    "Example String"
  ]
}

Referenced in

Price.context

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview