Products

Mirakl Platform

GraphQL Reference

VolumePrice

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

ProductCategory

Represents a product's category

code

String!,non-null

Code of the product category

Sample

{
  "code": "Example String"
}

Referenced in

Product.category

OfferProductReference

Represents a product reference

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

Product.references

Price

Represents a price

context

PriceContext

The context is not returned for default prices

price

Float!,non-null

Price of the offer. If a discount is defined and is currently active (within the validity interval), it represents the unit discount price. In other cases, it represents the unit_origin_price.

discount

DiscountPrice

Discount of the offer

volumePrice

[VolumePrice!]!,non-null

Volume prices for each quantity threshold. Returns at least the price for a quantity threshold of one.

Sample

{
  "context": {
    "__typename": "PriceContext"
  },
  "price": 40,
  "discount": {
    "__typename": "DiscountPrice"
  },
  "volumePrice": [
    {
      "__typename": "VolumePrice"
    }
  ]
}

Referenced in

Offer.prices

PriceContext

Represents the criteria on which a specific price applies

start

DateTime

The start date of a specific price

end

DateTime

The end date of a specific price

channels

[Channel!],non-null

The channels on which a specific price applies

customerOrganizationIds

[String!],non-null

The customer organization ids on which a specific price applies

customerGroupIds

[String!],non-null

The customer group ids on which a specific price applies

Sample

{
  "start": "Example Custom Scalar",
  "end": "Example Custom Scalar",
  "channels": [
    {
      "__typename": "Channel"
    }
  ],
  "customerOrganizationIds": [
    "Example String"
  ],
  "customerGroupIds": [
    "Example String"
  ]
}

Referenced in

Price.context

DiscountPrice

Represents a discount price

price

Float!,non-null

Discount price for a quantity of one, i.e. the discount price for a quantity of one regardless of the discount activation. Set to null if no discount is defined or if no discount price for a quantity of one is defined.

start

DateTime

Start date of the discount, or null if the discount does not have a start date

end

DateTime

End date of the discount, or null if the discount does not have an end date

Sample

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

Referenced in

Price.discount

VolumePrice.discount

VolumePrice

Represents a price for a quantity threshold

quantity

Int!,non-null

Quantity threshold of this price range

price

Float!,non-null

Unit price for this quantity threshold

discount

DiscountPrice

Unit discount price for this quantity threshold

Sample

{
  "quantity": 40,
  "price": 40,
  "discount": {
    "__typename": "DiscountPrice"
  }
}

Referenced in

Price.volumePrice

Channel

Represents a sale channel

code

String!,non-null

The channel code

Sample

{
  "code": "Example String"
}

Referenced in

PriceContext.channels

OfferState

Represents an offer condition

code

String!,non-null

Offer condition

Sample

{
  "code": "Example String"
}

Referenced in

Offer.state

OfferLogisticClass

Represents an offer logistic class

code

String!,non-null

Logistic class code

label

String!,non-null

Logistic class label

Sample

{
  "code": "Example String",
  "label": "Example String"
}

Referenced in

Offer.logisticClass

OrdersConnection

The connection type for Order.

pageInfo

PageInfo!,non-null

Information to aid in pagination.

edges

[OrderEdge!]!,non-null

A list of edges.

Implements interfaces

Connection

Sample

{
  "pageInfo": {
    "endCursor": "Example String",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "Example String"
  },
  "edges": [
    {
      "node": {
        "additionalFields": [
          {
            "__typename": "BooleanAdditionalFieldValue"
          }
        ],
        "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "canCancel": true,
        "canEvaluate": true,
        "commercialId": "Example String",
        "createdDate": "Example Custom Scalar",
        "currency": "Example Custom Scalar",
        "customer": {
          "__typename": "OrderCustomer"
        },
        "customerDebitedDate": "Example Custom Scalar",
        "customerDirectlyPaysSeller": true,
        "deliveryDate": {
          "__typename": "DeliveryDateTimeInterval"
        },
        "documents": {
          "__typename": "OrderDocuments"
        },
        "evaluation": {
          "__typename": "Evaluation"
        },
        "fullyRefunded": true,
        "hasIncident": true,
        "hasInvoice": true,
        "invoiceDetails": {
          "__typename": "OrderInvoice"
        },
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "lastUpdateDate": "Example Custom Scalar",
        "orderLines": [
          {
            "__typename": "OrderLine"
          }
        ],
        "orderTaxMode": "Example String",
        "paymentDestination": {
          "__typename": "IbanOrderPaymentDestination"
        },
        "paymentDuration": 40,
        "paymentType": "Example String",
        "paymentWorkflow": "Example String",
        "price": 40,
        "promotions": {
          "__typename": "OrderComputedPromotions"
        },
        "references": {
          "__typename": "OrderReference"
        },
        "shipping": {
          "__typename": "OrderShipping"
        },
        "shipments": [
          {
            "__typename": "Shipment"
          }
        ],
        "shop": {
          "__typename": "Shop"
        },
        "status": {
          "__typename": "OrderStatus"
        },
        "totalPrice": 40,
        "threads": {
          "__typename": "ThreadConnection"
        }
      }
    }
  ]
}

OrderEdge

An edge in a connection.

node

Order!,non-null

The item of the edge.

Sample

{
  "node": {
    "additionalFields": [
      {
        "__typename": "BooleanAdditionalFieldValue"
      }
    ],
    "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "canCancel": true,
    "canEvaluate": true,
    "commercialId": "Example String",
    "createdDate": "Example Custom Scalar",
    "currency": "Example Custom Scalar",
    "customer": {
      "__typename": "OrderCustomer"
    },
    "customerDebitedDate": "Example Custom Scalar",
    "customerDirectlyPaysSeller": true,
    "deliveryDate": {
      "__typename": "DeliveryDateTimeInterval"
    },
    "documents": {
      "__typename": "OrderDocuments"
    },
    "evaluation": {
      "__typename": "Evaluation"
    },
    "fullyRefunded": true,
    "hasIncident": true,
    "hasInvoice": true,
    "invoiceDetails": {
      "__typename": "OrderInvoice"
    },
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "lastUpdateDate": "Example Custom Scalar",
    "orderLines": [
      {
        "__typename": "OrderLine"
      }
    ],
    "orderTaxMode": "Example String",
    "paymentDestination": {
      "__typename": "IbanOrderPaymentDestination"
    },
    "paymentDuration": 40,
    "paymentType": "Example String",
    "paymentWorkflow": "Example String",
    "price": 40,
    "promotions": {
      "__typename": "OrderComputedPromotions"
    },
    "references": {
      "__typename": "OrderReference"
    },
    "shipping": {
      "__typename": "OrderShipping"
    },
    "shipments": [
      {
        "__typename": "Shipment"
      }
    ],
    "shop": {
      "__typename": "Shop"
    },
    "status": {
      "__typename": "OrderStatus"
    },
    "totalPrice": 40,
    "threads": {
      "__typename": "ThreadConnection"
    }
  }
}

Referenced in

OrdersConnection.edges

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview