Products

Mirakl Platform

GraphQL Reference

ShoppingCartOrderShop

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

ReturnPolicy

Represents a shop return policy.

autoAccept

Boolean

Automatically accept return requests when done during the return window

availableRejectionReasons

[String!],non-null

Available rejection reasons

availableReturnMethods

[String!],non-null

Available return methods

availableReturnReasons

[String!],non-null

Available return reasons

enabled

Boolean

Whether return feature is supported for the shop

handler

String

Determine who is responsible to handle returns

returnAddress

ReturnAddress

Return address

policy

String

Return policy

window

Int

Return window in days

Sample

{
  "autoAccept": true,
  "availableRejectionReasons": [
    "Example String"
  ],
  "availableReturnMethods": [
    "Example String"
  ],
  "availableReturnReasons": [
    "Example String"
  ],
  "enabled": true,
  "handler": "Example String",
  "returnAddress": {
    "__typename": "ReturnAddress"
  },
  "policy": "Example String",
  "window": 40
}

Referenced in

Shop.returnPolicy

ReturnAddress

Represents an address to used for returns

city

String!,non-null

City

country

CountryCode!,non-null

Country ISO code

state

String

State

street1

String!,non-null

First line of the return address

street2

String

Second line of the return address

zipCode

String!,non-null

Zip code

Sample

{
  "city": "Example String",
  "country": "Example Custom Scalar",
  "state": "Example String",
  "street1": "Example String",
  "street2": "Example String",
  "zipCode": "Example String"
}

Referenced in

ReturnPolicy.returnAddress

ShoppingCart

errors

[ShoppingCartError!]!,non-null

List of the errors encountered when computing the shipping fees

orders

[ShoppingCartOrder!]!,non-null

List of shipping fees information per order

Sample

{
  "errors": [
    {
      "__typename": "ShoppingCartError"
    }
  ],
  "orders": [
    {
      "__typename": "ShoppingCartOrder"
    }
  ]
}

ShoppingCartError

code

String!,non-null

Code of the error that made shipping computation not possible

offerId

ID!,non-null

The id of the offer involved in the error

shippingTypeCode

String

The selected shipping type code involved in the error

Sample

{
  "code": "Example String",
  "offerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "shippingTypeCode": "Example String"
}

Referenced in

ShoppingCart.errors

ShoppingCartOrder

channelCode

String

Channel code supplied when calling the API, or null if no channel code was supplied

currency

Currency!,non-null

Shop currency

leadTimeToShip

Int!,non-null

Order lead time to ship

offers

[ShoppingCartLine!]!,non-null

List of the offers that compose the order

promotions

ShoppingCartPromotion

A summary of the promotions applied to the order

selectedShippingType

SelectedShippingType!,non-null

Shipping type selected for the shop and used to calculate the shipping price for each offers

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

shippingTypes

[ShoppingCartAppliedShippingType!]!,non-null

List of shipping types compatible with all the offers composing the order

shop

ShoppingCartOrderShop

Information about the shop

Sample

{
  "channelCode": "Example String",
  "currency": "Example Custom Scalar",
  "leadTimeToShip": 40,
  "offers": [
    {
      "__typename": "ShoppingCartLine"
    }
  ],
  "promotions": {
    "__typename": "ShoppingCartPromotion"
  },
  "selectedShippingType": {
    "__typename": "SelectedShippingType"
  },
  "shippingDeadline": "Example Custom Scalar",
  "shippingTypes": [
    {
      "__typename": "ShoppingCartAppliedShippingType"
    }
  ],
  "shop": {
    "__typename": "ShoppingCartOrderShop"
  }
}

Referenced in

ShoppingCart.orders

ShoppingCartOrderShop

ID!,non-null

Shop identifier

businessId

ID!,non-null

Shop business id

name

String!,non-null

Shop name

shopModel

String!,non-null

Shop model

Sample

{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "name": "Example String",
  "shopModel": "Example String"
}

Referenced in

ShoppingCartOrder.shop

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

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview