Products

Mirakl Platform

GraphQL Reference

AmountBreakdownPart

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

OrderLineCategory

Represents a product's category

code

String!,non-null

Category code of the product associated with the order line

label

String!,non-null

Category label of the product associated with the order line

Sample

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

Referenced in

OrderLineProduct.category

OrderLineOffer

Represents an offer linked to an order line

priceAdditionalInfo

String

Price's additional information of the offer

product

OrderLineProduct!,non-null

Product information

sku

String!,non-null

Associated offer sku (this is the sku of the offer defined by the shop)

stateCode

String!,non-null

State of the offer associated with the order line

Sample

{
  "priceAdditionalInfo": "Example String",
  "product": {
    "__typename": "OrderLineProduct"
  },
  "sku": "Example String",
  "stateCode": "Example String"
}

Referenced in

OrderLine.offer

OrderLineProduct

Represents a product linked to an order line

media

[ProductMedia!]!,non-null

List of all product's media associated to the order line

sku

String!,non-null

Associated offer sku (this is the sku of the offer defined by the shop)

title

String!,non-null

Title of the product associated with the order line

Cancelation

Cancelation represents the cancellation details of an order item (OrderLine).

amount

PriceAmount

Cancellation's amount

createdDate

DateTime

Cancellation'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

Cancellation's id

quantity

Float

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

reasonCode

String

Cancellation reason's code

shippingAmount

ShippingAmountAndTaxes

Cancellation's shipping amount and shipping taxes

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"
  },
  "taxes": [
    {
      "__typename": "OrderTaxAmount"
    }
  ]
}

Referenced in

OrderLine.cancelations

AmountBreakdown

Represent a breakdown of an amount

parts

[AmountBreakdownPart!]!,non-null

The parts which constitute the total amount.

Sample

{
  "parts": [
    {
      "__typename": "AmountBreakdownPart"
    }
  ]
}

Referenced in

OrderTaxAmount.breakdown

PriceAmount.breakdown

AmountBreakdownPart

Represent a part of an amount. The sum of each part's amount is equal to the total amount.

amount

Float!,non-null

Part's amount. The sum of each part's amount is equal to the total amount.

debitableFromCustomer

Boolean!,non-null

Should this amount be debited to the customer. If true, the amount is taken into account when generating the debit file. If false, the amount is not taken into account when generating the debit file.

Sample

{
  "amount": 40,
  "debitableFromCustomer": true
}

Referenced in

AmountBreakdown.parts

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

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview