Products

Mirakl Platform

GraphQL Reference

ShoppingCartPromotionCampaign

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

SelectedShippingType

code

String!,non-null

Shipping type code

cutOffTime

String

Shipping type Cutoff time

deliveryTime

DeliveryDateTimeInformation

Expected order delivery time

label

String!,non-null

Shipping type label

shippingAdditionalFields

[AdditionalFieldValue!],non-null

Custom Shipping associated to the zone and the type

shippingDeadline

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

Sample

{
  "code": "Example String",
  "cutOffTime": "Example String",
  "deliveryTime": {
    "__typename": "DeliveryDateTimeInformation"
  },
  "label": "Example String",
  "shippingAdditionalFields": [
    {
      "__typename": "BooleanAdditionalFieldValue"
    }
  ],
  "shippingDeadline": "Example Custom Scalar"
}

Referenced in

ShoppingCartOrder.selectedShippingType

ShoppingCartAppliedShippingType

code

String!,non-null

cutOffTime

String

deliveryTime

DeliveryDateTimeInformation

label

String!,non-null

shippingAdditionalFields

[AdditionalFieldValue!],non-null

totalShippingPrice

Float!,non-null

Sample

{
  "code": "Example String",
  "cutOffTime": "Example String",
  "deliveryTime": {
    "__typename": "DeliveryDateTimeInformation"
  },
  "label": "Example String",
  "shippingAdditionalFields": [
    {
      "__typename": "BooleanAdditionalFieldValue"
    }
  ],
  "totalShippingPrice": 40
}

Referenced in

ShoppingCartOrder.shippingTypes

ShoppingCartLine

allowedShippingTypes

[ShoppingCartShippingType!]!,non-null

The allowed shipping types for this offer

fulfillment

OfferFulfillment!,non-null

Fulfillment information of the offer

lineOnlyShippingPrice

Float!,non-null

Shipping price of the order line if the order is composed only of the offer (shipping price * 1 + additional shipping price * (quantity - 1))

lineOnlyTotalPrice

Float!,non-null

Total price of the order line if the order is composed only of the offer (price + shipping price of the order line)

lineOriginalQuantity

Int!,non-null

Quantity of offers requested in the line

linePrice

Float!,non-null

Price of the order line (unit price of the offer * quantity) - promotions

lineQuantity

Int!,non-null

Quantity of offers returned for the line

lineShippingPrice

Int!,non-null

Shipping price of the order line

lineTotalPrice

Int!,non-null

Total price of the order line (line_price + line_shipping_price)

offerDiscount

OfferDiscount

Discount of the offer

promotions

[AppliedPromotion!]!,non-null

List of promotions

unitPrice

Float!,non-null

Unit price of the offer

shippingPriceAdditionalUnit

Float!,non-null

Additional shipping price of the offer

shippingPriceUnit

Float!,non-null

Shipping price of the offer

shippingTaxes

[ShoppingCartOfferTaxAmount!]!,non-null

Taxes to be applied on the shipping price

taxes

[ShoppingCartOfferTaxAmount!]!,non-null

Taxes to be applied on the product price

offer

Offer

Details offer information

Sample

{
  "allowedShippingTypes": [
    {
      "__typename": "ShoppingCartShippingType"
    }
  ],
  "fulfillment": {
    "__typename": "OfferFulfillment"
  },
  "lineOnlyShippingPrice": 40,
  "lineOnlyTotalPrice": 40,
  "lineOriginalQuantity": 40,
  "linePrice": 40,
  "lineQuantity": 40,
  "lineShippingPrice": 40,
  "lineTotalPrice": 40,
  "offerDiscount": {
    "__typename": "OfferDiscount"
  },
  "promotions": [
    {
      "__typename": "AppliedPromotion"
    }
  ],
  "unitPrice": 40,
  "shippingPriceAdditionalUnit": 40,
  "shippingPriceUnit": 40,
  "shippingTaxes": [
    {
      "__typename": "ShoppingCartOfferTaxAmount"
    }
  ],
  "taxes": [
    {
      "__typename": "ShoppingCartOfferTaxAmount"
    }
  ],
  "offer": {
    "__typename": "Offer"
  }
}

Referenced in

ShoppingCartOrder.offers

ShoppingCartPromotion

appliedPromotions

[ShoppingCartAppliedPromotion!]!,non-null

The promotions applied on this order

totalDeducedAmount

Float!,non-null

The total amount deduced on this order thanks to the promotions

Sample

{
  "appliedPromotions": [
    {
      "__typename": "ShoppingCartAppliedPromotion"
    }
  ],
  "totalDeducedAmount": 40
}

Referenced in

ShoppingCartOrder.promotions

ShoppingCartAppliedPromotion

apportioned

Boolean!,non-null

Whether the promotion's deduced amount has been divided among multiple order lines

campaign

ShoppingCartPromotionCampaign

Promotion campaign information, when applicable.

configuration

ShoppingCartPromotionConfiguration!,non-null

Configuration used to calculate the applied promotion

deducedAmount

Float!,non-null

Promotion's amount for this line.

String!,non-null

Promotion's id, defined by the shop

offeredQuantity

Int

The quantity of free items offered by the promotion for this line. Only applicable when promotion is of type FREE_ITEMS, null otherwise.

promoCode

String

Promo code associated to the promotion

Sample

{
  "apportioned": true,
  "campaign": {
    "__typename": "ShoppingCartPromotionCampaign"
  },
  "configuration": {
    "__typename": "ShoppingCartPromotionConfiguration"
  },
  "deducedAmount": 40,
  "id": "Example String",
  "offeredQuantity": 40,
  "promoCode": "Example String"
}

Referenced in

ShoppingCartPromotion.appliedPromotions

ShoppingCartPromotionCampaign

identifier

String!,non-null

Sample

{
  "identifier": "Example String"
}

Referenced in

ShoppingCartAppliedPromotion.campaign

ShoppingCartPromotionConfiguration

amountOff

Float

The amount off of the promotion. Only applicable when promotion is of type AMOUNT_OFF, null otherwise.

freeItemsQuantity

Int

The free item target quantity of the promotion. Only applicable when promotion is of type FREE_ITEMS, null otherwise.

internalDescription

String!,non-null

Promotion's Internal description, set by the shop at creation

percentageOff

Float

The percentage off of the promotion. Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise.

reducedUnitPrice

Float

The reduced unit price of this promotion. Only applicable when the promotion is of type REDUCED_UNIT_PRICE, null otherwise.

type

String!,non-null

Promotion's type, whether it is applied to this item (ITEM), or every items in the basket for this shop (BASKET) One of All, AMOUNT_OFF, FREE_ITEMS, PERCENTAGE_OFF, REDUCED_UNIT_PRICE

Sample

{
  "amountOff": 40,
  "freeItemsQuantity": 40,
  "internalDescription": "Example String",
  "percentageOff": 40,
  "reducedUnitPrice": 40,
  "type": "Example String"
}

Referenced in

ShoppingCartAppliedPromotion.configuration

ShoppingCartShippingType

code

String!,non-null

Shipping type code

cutOffTime

String

Shipping type Cutoff time

deliveryTime

DeliveryDateTimeInformation

Expected order delivery time

label

String!,non-null

Shipping type label

shippingAdditionalFields

[AdditionalFieldValue!],non-null

Custom Shipping associated to the zone and the type

shippingDeadline

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

Sample

{
  "code": "Example String",
  "cutOffTime": "Example String",
  "deliveryTime": {
    "__typename": "DeliveryDateTimeInformation"
  },
  "label": "Example String",
  "shippingAdditionalFields": [
    {
      "__typename": "BooleanAdditionalFieldValue"
    }
  ],
  "shippingDeadline": "Example Custom Scalar"
}

Referenced in

ShoppingCartLine.allowedShippingTypes

DeliveryDateTimeInformation

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

SelectedShippingType.deliveryTime

ShoppingCartAppliedShippingType.deliveryTime

ShoppingCartShippingType.deliveryTime

OfferDiscount

discountPrice

Float

Discount price. Not to be read if discount with ranges is specified (i.e. discount with at least one range with quantity threshold greater than one).

startDate

DateTime

Discount start date

endDate

DateTime

Discount end date

originPrice

Float

Origin price

ranges

[DiscountRange!],non-null

Discount ranges

Sample

{
  "discountPrice": 40,
  "startDate": "Example Custom Scalar",
  "endDate": "Example Custom Scalar",
  "originPrice": 40,
  "ranges": [
    {
      "__typename": "DiscountRange"
    }
  ]
}

Referenced in

ShoppingCartLine.offerDiscount

DiscountRange

price

Float!,non-null

Price of the offer if the quantity threshold is reached

quantityThreshold

Int!,non-null

Minimum quantity to order for the given price to be applied

Sample

{
  "price": 40,
  "quantityThreshold": 40
}

Referenced in

OfferDiscount.ranges

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview