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

GraphQL Overview

Download GraphQL schema
schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

ShopStatistics

excluded
Boolean

Order exclusion from seller statistics. Indicate if true or false

reason
String

Reason of order exclusion from shop statistics. Ignored if EXCLUDED is FALSE. Max length: 100 characters.

Sample
{
  "excluded": true,
  "reason": "Example String"
}
Referenced in
OrderUpdated.shopStatistics

PatchOrderError

code
String!,non-null

Error code

field
String!,non-null

Name of the field on the input object. Can be composed, e.g.: address.zip_code

message
String!,non-null

Error message

Sample
{
  "code": "Example String",
  "field": "Example String",
  "message": "Example String"
}
Referenced in
PatchOrdersUpdatedOrder.errors

PatchOrdersResponse

updatedOrders
[PatchOrdersUpdatedOrder!]!,non-null

A list of updated orders and orders in error objects

Sample
{
  "updatedOrders": [
    {
      "__typename": "PatchOrdersUpdatedOrder"
    }
  ]
}

CancelOrderLinesResponse

cancelledOrderLines
[CancelledOrderLine!]!,non-null
taxMode
String!,non-null
Sample
{
  "cancelledOrderLines": [
    {
      "__typename": "CancelledOrderLine"
    }
  ],
  "taxMode": "Example String"
}

CancelledOrderLine

amount
CancelledPriceAmountAndTaxes

The offer part amount to be canceled with taxes

currency
Currency

The currency (iso format) used by the shop (the field is required if the shop is not using the default Operator platform currency)

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.

fees
[FeeCancelled!]!,non-null

List of fees canceled on the order line

id
ID!,non-null

The identifier of the created cancellation

orderLineId
ID!,non-null

Order line's identifier on which the cancellation has been created

purchaseInformation
CancelationPurchaseInformation

Cancelation’s purchase information

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

Sample
{
  "amount": {
    "__typename": "CancelledPriceAmountAndTaxes"
  },
  "currency": "Example Custom Scalar",
  "ecoContributions": [
    {
      "__typename": "EcoContribution"
    }
  ],
  "fees": [
    {
      "__typename": "FeeCancelled"
    }
  ],
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "orderLineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "purchaseInformation": {
    "__typename": "CancelationPurchaseInformation"
  },
  "quantity": 40,
  "reasonCode": "Example String",
  "shippingAmount": {
    "__typename": "ShippingAmountAndTaxes"
  }
}
Referenced in
CancelOrderLinesResponse.cancelledOrderLines

FeeCancelled

amount
Float

Order Fee amount

code
String

Order Fee code

Sample
{
  "amount": 40,
  "code": "Example String"
}
Referenced in
CancelledOrderLine.fees

CancelationPurchaseInformation

commissionOnPrice
Float!,non-null

Cancelation’s purchase commission fee

commissionOnShipping
Float!,non-null

Cancelation’s purchase commission fee on shipping

price
Float!,non-null

Cancelation’s purchase price excluding shipping charges

shippingPrice
Float!,non-null

Cancelation’s purchase shipping charges

Sample
{
  "commissionOnPrice": 40,
  "commissionOnShipping": 40,
  "price": 40,
  "shippingPrice": 40
}
Referenced in
CancelledOrderLine.purchaseInformation

CancelledPriceAmountAndTaxes

amount
PriceAmount

The amount of the price

taxes
[CancelledTaxes!]!,non-null

The taxes to be applied on the price

Sample
{
  "amount": {
    "__typename": "PriceAmount"
  },
  "taxes": [
    {
      "__typename": "CancelledTaxes"
    }
  ]
}
Referenced in
CancelledOrderLine.amount

CancelledTaxes

amount
PriceAmount!,non-null

Tax amount

code
String!,non-null

Tax code

purchaseTax
CancelledPurchaseTax

Purchase tax information

rate
Float

Tax rate

Sample
{
  "amount": {
    "__typename": "PriceAmount"
  },
  "code": "Example String",
  "purchaseTax": {
    "__typename": "CancelledPurchaseTax"
  },
  "rate": 40
}
Referenced in
CancelledPriceAmountAndTaxes.taxes

CancelledPurchaseTax

amount
Float!,non-null

Purchase tax amount

rate
Float

Purchase tax rate

Sample
{
  "amount": 40,
  "rate": 40
}
Referenced in
CancelledTaxes.purchaseTax

CreateThreadResponse

thread
Thread!,non-null

The created thread.

Sample
{
  "thread": {
    "__typename": "Thread"
  }
}

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview