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

GraphQL Overview

Download GraphQL schema
schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

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

category
ProductCategory!,non-null

The category of the product

taxCode
String

Product tax code

Sample
{
  "sku": "Example String",
  "references": [
    {
      "__typename": "OfferProductReference"
    }
  ],
  "category": {
    "__typename": "ProductCategory"
  },
  "taxCode": "Example String"
}
Referenced in
Offer.product

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

DiscountPrice

Represents a discount price

price
Float!,non-null

Discount price for a quantity of one, i.e. the discount price for a quantity of one regardless of the discount activation. Set to null if no discount is defined or if no discount price for a quantity of one is defined.

start
DateTime

Start date of the discount, or null if the discount does not have a start date

end
DateTime

End date of the discount, or null if the discount does not have an end date

Sample
{
  "price": 40,
  "start": "Example Custom Scalar",
  "end": "Example Custom Scalar"
}
Referenced in
Price.discount
VolumePrice.discount

VolumePrice

Represents a price for a quantity threshold

quantity
Int!,non-null

Quantity threshold of this price range

price
Float!,non-null

Unit price for this quantity threshold

discount
DiscountPrice

Unit discount price for this quantity threshold

Sample
{
  "quantity": 40,
  "price": 40,
  "discount": {
    "__typename": "DiscountPrice"
  }
}
Referenced in
Price.volumePrice

Channel

Represents a sale channel

code
String!,non-null

The channel code

Sample
{
  "code": "Example String"
}
Referenced in
PriceContext.channels

OfferState

Represents an offer condition

code
String!,non-null

Offer condition

Sample
{
  "code": "Example String"
}
Referenced in
Offer.state

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview