Products

Mirakl Platform

GraphQL Reference

ShoppingCart

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

ShopContactInformation

Represents a shop contact information

city

String!,non-null

City of the contact

civility

String

Civility of the contact (Mr, Mrs, Miss or Neutral)

country

CountryCode!,non-null

Code ISO 3166-1 alpha-3 of the contact's country

String!,non-null

fax

String

Fax number

firstname

String

First name of the contact

lastname

String!,non-null

Last name of the contact

phone

String

Phone number

phoneSecondary

String

Secondary phone number

state

String

State (address) of the contact

street1

String!,non-null

First line of the address of the contact

street2

String

Second line of the address of the contact

website

String

Website of the shop

zipCode

String

Zip code of the contact

Sample

{
  "city": "Example String",
  "civility": "Example String",
  "country": "Example Custom Scalar",
  "email": "Example String",
  "fax": "Example String",
  "firstname": "Example String",
  "lastname": "Example String",
  "phone": "Example String",
  "phoneSecondary": "Example String",
  "state": "Example String",
  "street1": "Example String",
  "street2": "Example String",
  "website": "Example String",
  "zipCode": "Example String"
}

Referenced in

Shop.contactInformation

ProducerIdentifier

Represents a producer identifier

eprCategoryCode

String

Extended Producer Responsibility (EPR) category code. Possible values: FR-AGROPACK, FR-ASL, FR-DASRIPAT, FR-DBPS, FR-DDS, FR-DEA, FR-DEEE, FR-DISPMED, FR-DIY, FR-EMBM, FR-GF, FR-JOUETS, FR-LUB, FR-MH, FR-MNU, FR-PA, FR-PAP, FR-PCHIM, FR-PMCB, FR-PNEU, FR-TABAC, FR-TLC, FR-VEHICULE, FR-VHU, DE-BATTG, DE-PACK, DE-WEEE, ES-PACK, ES-GPACK, ES-WEEE

String

Shop producer identifier

Sample

{
  "eprCategoryCode": "Example String",
  "id": "Example String"
}

Referenced in

Shop.producerIdentifiers

ShopShippingConfiguration

Represents a shop shipping configuration

additionalFields

[AdditionalFieldValue!]!,non-null

List of custom shipping fields for this shipping zone and shipping method

freeAmount

Float

Minimal amount for free shipping

typeCode

String!,non-null

The code of the shipping type

typeLabel

String!,non-null

The label of the shipping type

zoneCode

String!,non-null

The code of the shipping zone

zoneLabel

String!,non-null

The label of the shipping zone

Sample

{
  "additionalFields": [
    {
      "__typename": "BooleanAdditionalFieldValue"
    }
  ],
  "freeAmount": 40,
  "typeCode": "Example String",
  "typeLabel": "Example String",
  "zoneCode": "Example String",
  "zoneLabel": "Example String"
}

Referenced in

Shop.shippings

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

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview