Products

Mirakl Platform

GraphQL Reference

OfferFulfillment

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

OffersConnection

The connection type for Offer

edges

[OfferEdge]

A list of edges

pageInfo

PageInfo!,non-null

Information to aid in pagination

Implements interfaces

Connection

Sample

{
  "edges": [
    {
      "node": {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "active": true,
        "allowQuoteRequests": true,
        "availability": {
          "__typename": "DateTimeRange"
        },
        "additionalFields": [
          {
            "__typename": "BooleanAdditionalFieldValue"
          }
        ],
        "currency": "Example Custom Scalar",
        "description": "Example String",
        "ecoContributions": [
          {
            "__typename": "OfferEcoContribution"
          }
        ],
        "fulfillment": {
          "__typename": "OfferFulfillment"
        },
        "inactivityReasons": [
          {
            "__typename": "OfferInactivityReason"
          }
        ],
        "professional": true,
        "leadTimeToShip": 40,
        "orderQuantity": {
          "__typename": "OfferOrderQuantity"
        },
        "minShipping": {
          "__typename": "OfferMinShippingInformation"
        },
        "shipping": {
          "__typename": "OfferShippingInformation"
        },
        "platformModel": "Example String",
        "nbEvaluations": 40,
        "packageQuantity": 40,
        "product": {
          "__typename": "Product"
        },
        "shop": {
          "__typename": "Shop"
        },
        "prices": [
          {
            "__typename": "Price"
          }
        ],
        "totalPrice": 40,
        "state": {
          "__typename": "OfferState"
        },
        "quantity": 40,
        "logisticClass": {
          "__typename": "OfferLogisticClass"
        }
      }
    }
  ],
  "pageInfo": {
    "endCursor": "Example String",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "Example String"
  }
}

OfferEdge

An edge in a connection

node

Offer!,non-null

The item of the edge

Sample

{
  "node": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "active": true,
    "allowQuoteRequests": true,
    "availability": {
      "__typename": "DateTimeRange"
    },
    "additionalFields": [
      {
        "__typename": "BooleanAdditionalFieldValue"
      }
    ],
    "currency": "Example Custom Scalar",
    "description": "Example String",
    "ecoContributions": [
      {
        "__typename": "OfferEcoContribution"
      }
    ],
    "fulfillment": {
      "__typename": "OfferFulfillment"
    },
    "inactivityReasons": [
      {
        "__typename": "OfferInactivityReason"
      }
    ],
    "professional": true,
    "leadTimeToShip": 40,
    "orderQuantity": {
      "__typename": "OfferOrderQuantity"
    },
    "minShipping": {
      "__typename": "OfferMinShippingInformation"
    },
    "shipping": {
      "__typename": "OfferShippingInformation"
    },
    "platformModel": "Example String",
    "nbEvaluations": 40,
    "packageQuantity": 40,
    "product": {
      "__typename": "Product"
    },
    "shop": {
      "__typename": "Shop"
    },
    "prices": [
      {
        "__typename": "Price"
      }
    ],
    "totalPrice": 40,
    "state": {
      "__typename": "OfferState"
    },
    "quantity": 40,
    "logisticClass": {
      "__typename": "OfferLogisticClass"
    }
  }
}

Referenced in

OffersConnection.edges

Offer

Represents an offer made by a seller for a product

ID!,non-null

The unique identifier of the offer

businessId

ID!,non-null

The business identifier of the offer

active

Boolean!,non-null

Is the offer active

allowQuoteRequests

Boolean

Whether the offer is eligible for quotation

availability

DateTimeRange

Availability dates

additionalFields

[AdditionalFieldValue!]!,non-null

List of additional fields

currency

Currency!,non-null

The currency of the shop (iso format)

description

String

Offer description

ecoContributions

[OfferEcoContribution!]!,non-null

Eco-contributions of the offer. Only available if the operator setting "Activate data collection related to circular economy regulations" has been enabled.

fulfillment

OfferFulfillment!,non-null

Fulfillment information

inactivityReasons

[OfferInactivityReason!]!,non-null

Reasons for offers inactivity, mandatory if an offer is inactive

professional

Boolean!,non-null

Whether or not the shop is professional

leadTimeToShip

Int!,non-null

Offer's lead time to ship value. If this value has been set to 0, value is returned as 1 (unless platform's default lead time to ship value is also 0). If no lead time to ship was specified for the offer, platform's default value is returned.

orderQuantity

OfferOrderQuantity

Specify min/max quantity of product items per order

minShipping

OfferMinShippingInformation!,non-null

Min shipping information

shipping

OfferShippingInformation

Shipping information for the offer

platformModel

String

Shop platform model, current possible values: * MARKETPLACE * DROPSHIP * ONE_CREDITOR

nbEvaluations

Int!,non-null

Number of customers evaluations

packageQuantity

Int

Indivisible quantity of the same product

product

Product!,non-null

Product information associated to this offer

shop

Shop!,non-null

Information on the shop which proposes the offer

prices

[Price]!,non-null

All prices for the offer

totalPrice

Float!,non-null

Total price of the offer (price + minimum shipping rate)

state

OfferState!,non-null

Offer condition

quantity

Int!,non-null

Available quantity of the offer

logisticClass

OfferLogisticClass!,non-null

The logistic class associated to the offer

Implements interfaces

Node

Sample

{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "active": true,
  "allowQuoteRequests": true,
  "availability": {
    "__typename": "DateTimeRange"
  },
  "additionalFields": [
    {
      "__typename": "BooleanAdditionalFieldValue"
    }
  ],
  "currency": "Example Custom Scalar",
  "description": "Example String",
  "ecoContributions": [
    {
      "__typename": "OfferEcoContribution"
    }
  ],
  "fulfillment": {
    "__typename": "OfferFulfillment"
  },
  "inactivityReasons": [
    {
      "__typename": "OfferInactivityReason"
    }
  ],
  "professional": true,
  "leadTimeToShip": 40,
  "orderQuantity": {
    "__typename": "OfferOrderQuantity"
  },
  "minShipping": {
    "__typename": "OfferMinShippingInformation"
  },
  "shipping": {
    "__typename": "OfferShippingInformation"
  },
  "platformModel": "Example String",
  "nbEvaluations": 40,
  "packageQuantity": 40,
  "product": {
    "__typename": "Product"
  },
  "shop": {
    "__typename": "Shop"
  },
  "prices": [
    {
      "__typename": "Price"
    }
  ],
  "totalPrice": 40,
  "state": {
    "__typename": "OfferState"
  },
  "quantity": 40,
  "logisticClass": {
    "__typename": "OfferLogisticClass"
  }
}

Referenced in

OfferEdge.node

ShoppingCartLine.offer

DateTimeRange

Represents a datetime range

start

DateTime

The start date

end

DateTime

The end date

Sample

{
  "start": "Example Custom Scalar",
  "end": "Example Custom Scalar"
}

Referenced in

Offer.availability

OfferEcoContribution

Represents an eco contribution for the offer

eprCategoryCode

String!,non-null

Extended Producer Responsibility (EPR) category code

producerId

String

Producer identifier of the eco-contribution

amount

Float

Amount of the eco-contribution

Sample

{
  "eprCategoryCode": "Example String",
  "producerId": "Example String",
  "amount": 40
}

Referenced in

Offer.ecoContributions

OfferFulfillment

Represents the offer fulfillment information

center

OfferFulfillmentCenter!,non-null

Fulfillment center code

Sample

{
  "center": {
    "__typename": "OfferFulfillmentCenter"
  }
}

Referenced in

Offer.fulfillment

ShoppingCartLine.fulfillment

OfferFulfillmentCenter

Represents the offer fulfillment center

code

String!,non-null

Center code

Sample

{
  "code": "Example String"
}

Referenced in

OfferFulfillment.center

OfferInactivityReason

Represents an inactivity reason

code

String!,non-null

Inactivity reason code

Sample

{
  "code": "Example String"
}

Referenced in

Offer.inactivityReasons

OfferOrderQuantity

Represents the constraint related to quantity of the offer per order

min

Int

The minimum quantity of the offer per order

max

Int

The maximum quantity of the offer per order

Sample

{
  "min": 40,
  "max": 40
}

Referenced in

Offer.orderQuantity

OfferMinShippingInformation

Represents the min shipping information for this offer

price

Float!,non-null

Unit price of the minimum shipping rate

priceAdditional

Float!,non-null

Additional unit price associated to the minimum shipping rate

type

String!,non-null

Code of the shipping type associated to the minimum shipping rate

zone

String!,non-null

Code of the shipping zone associated to the minimum shipping rate

Sample

{
  "price": 40,
  "priceAdditional": 40,
  "type": "Example String",
  "zone": "Example String"
}

Referenced in

Offer.minShipping

OfferShippingInformation

Represents shipping information for this offer

deadline

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.

types

[OfferShippingType!]!,non-null

List of shipping types compatible with the given offer

Sample

{
  "deadline": "Example Custom Scalar",
  "types": [
    {
      "__typename": "OfferShippingType"
    }
  ]
}

Referenced in

Offer.shipping

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview