Products

Mirakl Platform

GraphQL Reference

AppliedPromotion

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

EcoContribution

Represents the eco-contribution details for a producer identifiers

eprCategoryCode

String!,non-null

producerId

String!,non-null

producerIdOwner

String!,non-null

totalAmount

Float

unitAmount

Float

Sample

{
  "eprCategoryCode": "Example String",
  "producerId": "Example String",
  "producerIdOwner": "Example String",
  "totalAmount": 40,
  "unitAmount": 40
}

Referenced in

CancelledOrderLine.ecoContributions

OrderLine.ecoContributions

Cancelation.ecoContributions

Refund.ecoContributions

OrderTaxAmount

Represents the amount of a tax.

amount

Float!,non-null

Tax amount

breakdown

AmountBreakdown

The breakdown of the tax amount, only available when advanced features are enabled

code

String!,non-null

Tax code

rate

Float

Tax rate

Sample

{
  "amount": 40,
  "breakdown": {
    "__typename": "AmountBreakdown"
  },
  "code": "Example String",
  "rate": 40
}

Referenced in

OrderLine.taxes

Cancelation.taxes

Refund.taxes

ShippingAmountAndTaxes.taxes

OrderLineProductMeasurement

Represents measurement information of an order item (OrderLine)

actualMeasurement

Float

Actual measurement on the order line

measurementUnit

String

Measurement unit of the order line. Possible values: GRAM, KILOGRAM, TON, POUND, OUNCE, MILLILITER, CENTILITER, CUBIC_METER, LITER, GALLON, FLUID_OUNCE, PINT, BARREL, CENTIMETER, METER, INCH, FEET, SQUARE_CENTIMETER, SQUARE_METER, SQUARE_INCH, SQUARE_FOOT

orderedMeasurement

Float

Total measurement ordered on the order line

Sample

{
  "actualMeasurement": 40,
  "measurementUnit": "Example String",
  "orderedMeasurement": 40
}

Referenced in

OrderLine.measurement

ProductMedia

Represents a product's media

mediaUrl

String!,non-null

Media URL

format

String!,non-null

Media format (.jpg, .png ...)

type

String!,non-null

Type of the product media (small, large...)

Sample

{
  "mediaUrl": "Example String",
  "format": "Example String",
  "type": "Example String"
}

Referenced in

OrderLineProduct.media

OrderComputedPromotions

Represents an order's promotions

appliedPromotions

[AppliedPromotion!]!,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": "AppliedPromotion"
    }
  ],
  "totalDeducedAmount": 40
}

Referenced in

Order.promotions

AppliedPromotion

Represents a promotion applied to an element

apportioned

Boolean!,non-null

Whether the promotion's deduced amount has been divided among multiple order lines

configuration

AppliedPromotionConfiguration!,non-null

Configuration used to calculate the applied promotion

deducedAmount

Float!,non-null

Promotion's amount.

ID!,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,
  "configuration": {
    "__typename": "AppliedPromotionConfiguration"
  },
  "deducedAmount": 40,
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "offeredQuantity": 40,
  "promoCode": "Example String"
}

Referenced in

OrderLine.promotions

OrderComputedPromotions.appliedPromotions

ShoppingCartLine.promotions

AppliedPromotionConfiguration

Represents a promotion's configuration

amountOff

Float

The amount off of the promotion. Only applicable when promotion is of type AMOUNT_OFF, null otherwise.

freeItemsQuantity

Int

The free item target quantity of the promotion. Only applicable when promotion is of type FREE_ITEMS, null otherwise.

percentageOff

Float

The percentage off of the promotion. Only applicable when promotion is of type PERCENTAGE_OFF, null otherwise.

reducedUnitPrice

Float

The reduced unit price of this promotion. Only applicable when the promotion is of type REDUCED_UNIT_PRICE, null otherwise.

type

String!,non-null

Promotion's type, whether it is applied to this item (ITEM), or every items in the basket for this shop (BASKET). Possible values are: ALL, AMOUNT_OFF, FREE_ITEMS, PERCENTAGE_OFF, REDUCED_UNIT_PRICE

Sample

{
  "amountOff": 40,
  "freeItemsQuantity": 40,
  "percentageOff": 40,
  "reducedUnitPrice": 40,
  "type": "Example String"
}

Referenced in

AppliedPromotion.configuration

IbanOrderPaymentDestination

Represents a payment destination for an IBAN

iban

String!,non-null

Bank account IBAN

paymentReference

String

The payment reference for bank transfer

Sample

{
  "iban": "Example String",
  "paymentReference": "Example String"
}

Referenced in

OrderPaymentDestination

OrderReference

orderReferenceForCustomer

String

Order reference for customer

Sample

{
  "orderReferenceForCustomer": "Example String"
}

Referenced in

OrderUpdated.references

Order.references

PriceAmount

Represents a price and the breakdown of this price

value

Float!,non-null

Amount

breakdown

AmountBreakdown

The breakdown of the amount

Sample

{
  "value": 40,
  "breakdown": {
    "__typename": "AmountBreakdown"
  }
}

Referenced in

CancelledPriceAmountAndTaxes.amount

CancelledTaxes.amount

OrderLine.price

Cancelation.amount

Refund.amount

ShippingAmountAndTaxes.amount

Refund

Represents a refund made for an order line.

amount

PriceAmount

Refund's amount

createdDate

DateTime

Refund's creation date

ecoContributions

[EcoContribution!]!,non-null

List of eco-contribution amounts and corresponding producer identifiers, if applicable Only available if the operator activates the circular economy information collection.

ID!,non-null

Refund's id

quantity

Float

The quantity of products canceled (This quantity is informative only)

reasonCode

String

Reason's code of the refund

shippingAmount

ShippingAmountAndTaxes

Refund's shipping amount and shipping taxes

state

String!,non-null

Refund's state

taxes

[OrderTaxAmount!]!,non-null

The taxes on the price

Sample

{
  "amount": {
    "__typename": "PriceAmount"
  },
  "createdDate": "Example Custom Scalar",
  "ecoContributions": [
    {
      "__typename": "EcoContribution"
    }
  ],
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "quantity": 40,
  "reasonCode": "Example String",
  "shippingAmount": {
    "__typename": "ShippingAmountAndTaxes"
  },
  "state": "Example String",
  "taxes": [
    {
      "__typename": "OrderTaxAmount"
    }
  ]
}

Referenced in

OrderLine.refunds

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview