Skip to content
Products
/
Mirakl Platform
/
GraphQL Reference
/
Inputs
/
ShoppingCartOfferInput

GraphQL Overview

Download GraphQL schema
schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Inputs

Overview

OfferStateFilter

Represents an offer state

code
String!,non-null

Offer state code

Sample
{
  "code": "Example String"
}
Referenced in
OfferFilter.states

OfferProductFilter

Represents the product filter

references
[OfferProductReferenceFilter!],non-null

List of the product's identifiers with type. Limited to 100 values. One of the two is required skus or references.

skus
[String!],non-null

List of product's skus separated with comma. Limited to 100 values. One of the two is required skus or references.

Sample
{
  "references": [
    {
      "__typename": "OfferProductReferenceFilter"
    }
  ],
  "skus": [
    "Example String"
  ]
}
Referenced in
OfferFilter.product

OfferProductReferenceFilter

Represents a product reference filter

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
OfferProductFilter.references

OrderFilter

Filter to apply on orders.

customerId
ID!,non-null

Customer's identifier

id
ID

Order's identifier

commercialId
String

Order's commercial identifiers

businessId
ID

Order's business identifier

Sample
{
  "customerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "commercialId": "Example String",
  "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}

ShoppingCartInput

computeOrderTaxes
Boolean

Compute U.S. order taxes Default to false

customerCode
String

Customer identifier code. Ignored if compute_order_taxes is set to false

customerShippingAddress
ShoppingCartCustomerShippingAddressInput

Customer shipping address Required if compute_order_taxes is set to true

offers
[ShoppingCartOfferInput!]!,non-null

List of the selected offers

pricingChannelCode
String

The code of the channel the order will be placed on. The selected offers get the price and promotions defined on this specific channel.If not specified, only the default prices of the offers are taken into account.

pricingCustomerOrganizationId
String

For Customer Pricing users only. Customer identifier code the API will use to return the applicable price. Ignored if value does not exist.

promoCodes
[String!],non-null

A list of promo codes, max 100 values

shippingZoneCode
String!,non-null

Code of the selected shipping zone

Sample
{
  "computeOrderTaxes": true,
  "customerCode": "Example String",
  "customerShippingAddress": {
    "__typename": "ShoppingCartCustomerShippingAddressInput"
  },
  "offers": [
    {
      "__typename": "ShoppingCartOfferInput"
    }
  ],
  "pricingChannelCode": "Example String",
  "pricingCustomerOrganizationId": "Example String",
  "promoCodes": [
    "Example String"
  ],
  "shippingZoneCode": "Example String"
}

ShoppingCartOfferInput

offerId
String!,non-null

Offer identifier

quantity
Int!,non-null

Offer quantity

shippingTypeCode
String

Shipping type code

leadTimeToShip
Int

Lead time to ship

Sample
{
  "offerId": "Example String",
  "quantity": 40,
  "shippingTypeCode": "Example String",
  "leadTimeToShip": 40
}
Referenced in
ShoppingCartInput.offers

ShoppingCartCustomerShippingAddressInput

street1
String

Customer shipping address street 1. Required if compute_order_taxes is set to true

street2
String

Customer shipping address street 2. Ignored if compute_order_taxes is set to false

state
String

Customer shipping address state. (Two letters US State code). Required if compute_order_taxes is set to true

zipCode
String

Customer shipping address zipcode. Required if compute_order_taxes is set to true

city
String

Customer shipping address city. Required if compute_order_taxes is set to true

country
CountryCode

Customer shipping address country (ISO 3166-1, three letters code). Required if compute_order_taxes is set to true

Sample
{
  "street1": "Example String",
  "street2": "Example String",
  "state": "Example String",
  "zipCode": "Example String",
  "city": "Example String",
  "country": "Example Custom Scalar"
}
Referenced in
ShoppingCartInput.customerShippingAddress

ThreadFilter

Filter to apply on threads.

customerId
ID

Customer's identifier. If not provided, customerOrganizationId must be provided

customerOrganizationId
ID

Customer's organization identifier. If not provided, customerId must be provided

entityIds
[ID!],non-null

Entity's identifiers link to the thread. If provided, entityType must be provided

entityType
String

Entity's type link to the thread. Possible values: MMP_ORDER, MMP_OFFER, MPS_ORDER, MPS_SERVICE, SELLER_OPERATOR. If provided, entityIds must be provided.

channelCodes
[String!],non-null

Thread's channels code.

Sample
{
  "customerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "customerOrganizationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "entityIds": [
    "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
  ],
  "entityType": "Example String",
  "channelCodes": [
    "Example String"
  ]
}

Scalars

Overview