Skip to content
Products
/
Mirakl Platform
/
GraphQL Reference
/
Objects
/
Cancelation

GraphQL Overview

Download GraphQL schema
schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

OrderLine

Represents an order's item

canOpenIncident
Boolean

Indicate if an incident can be opened on the order line

cancelations
[Cancelation!]!,non-null

List of the cancellations

history
OrderLineHistory!,non-null

Order line's history

description
String!,non-null

Order line's description

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.

measurement
OrderLineProductMeasurement

Measurement information of the order line

offer
OrderLineOffer!,non-null

Associated offer

additionalFields
[AdditionalFieldValue!]!,non-null

List of additional fields

id
ID!,non-null

Order line's identifier

index
Int!,non-null

Order line's index in the order

status
OrderStatus!,non-null

Order line's status

originUnitPrice
Float

The original unit price of the offer associated with the order line

price
PriceAmount!,non-null

Order line's price without shipping price

priceUnit
Float!,non-null

Unit price for the offer associated with the order line

promotions
[AppliedPromotion!]!,non-null

List of promotions

quantity
Int!,non-null

Product's quantity for the order line

refunds
[Refund!]!,non-null

List of the refunds

shippingPrice
ShippingAmountAndTaxes!,non-null

Order line's shipping amount and shipping taxes

taxes
[OrderTaxAmount!]!,non-null

List of taxes applied on product price

totalPrice
Float!,non-null

Order line's price with shipping price.

Sample
{
  "canOpenIncident": true,
  "cancelations": [
    {
      "__typename": "Cancelation"
    }
  ],
  "history": {
    "__typename": "OrderLineHistory"
  },
  "description": "Example String",
  "ecoContributions": [
    {
      "__typename": "EcoContribution"
    }
  ],
  "measurement": {
    "__typename": "OrderLineProductMeasurement"
  },
  "offer": {
    "__typename": "OrderLineOffer"
  },
  "additionalFields": [
    {
      "__typename": "BooleanAdditionalFieldValue"
    }
  ],
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "index": 40,
  "status": {
    "__typename": "OrderStatus"
  },
  "originUnitPrice": 40,
  "price": {
    "__typename": "PriceAmount"
  },
  "priceUnit": 40,
  "promotions": [
    {
      "__typename": "AppliedPromotion"
    }
  ],
  "quantity": 40,
  "refunds": [
    {
      "__typename": "Refund"
    }
  ],
  "shippingPrice": {
    "__typename": "ShippingAmountAndTaxes"
  },
  "taxes": [
    {
      "__typename": "OrderTaxAmount"
    }
  ],
  "totalPrice": 40
}
Referenced in
Order.orderLines
ShipmentLine.orderLine

OrderLineHistory

Represents an order line's history

createdDate
DateTime!,non-null

Order line's creation date

debitedDate
DateTime

Order line's debited date

receivedDate
DateTime

Product's date of receipt

shippedDate
DateTime

Order line's shipped date

Sample
{
  "createdDate": "Example Custom Scalar",
  "debitedDate": "Example Custom Scalar",
  "receivedDate": "Example Custom Scalar",
  "shippedDate": "Example Custom Scalar"
}
Referenced in
OrderLine.history

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

category
OrderLineCategory!,non-null

Product's category information

Sample
{
  "media": [
    {
      "__typename": "ProductMedia"
    }
  ],
  "sku": "Example String",
  "title": "Example String",
  "category": {
    "__typename": "OrderLineCategory"
  }
}
Referenced in
OrderLineOffer.product

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

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview