Products

Mirakl Platform

GraphQL Reference

ShopStatistics

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

OrderUpdatedCustomerOrganization

Data related to the organization that created the order (B2B transactions)

address

CustomerOrganizationAddress

Address of the organization

identificationNumber

String

Identification number of the organization

name

String

Name of the organization

taxIdentificationNumber

String

Tax identification number of the organization

Sample

{
  "address": {
    "__typename": "CustomerOrganizationAddress"
  },
  "identificationNumber": "Example String",
  "name": "Example String",
  "taxIdentificationNumber": "Example String"
}

Referenced in

OrderUpdatedCustomer.organization

OrderUpdatedOrderLine

Details of the modified order line

cancelations

[OrderUpdatedCancelation!],non-null

List of cancelations

ecoContributions

[OrderUpdatesEcoContribution!],non-null

List of eco-contribution amounts and corresponding producer identifiers, if applicable

orderLineId

ID!,non-null

Order line identifier

refunds

[OrderUpdatedRefund!],non-null

List of refunds

Sample

{
  "cancelations": [
    {
      "__typename": "OrderUpdatedCancelation"
    }
  ],
  "ecoContributions": [
    {
      "__typename": "OrderUpdatesEcoContribution"
    }
  ],
  "orderLineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "refunds": [
    {
      "__typename": "OrderUpdatedRefund"
    }
  ]
}

Referenced in

OrderUpdated.orderLines

OrderUpdatedCancelation

cancelationId

Cancelation identifier

ecoContributions

[OrderUpdatesEcoContribution!],non-null

List of eco-contribution amounts and corresponding producer identifiers, if applicable

Sample

{
  "cancelationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "ecoContributions": [
    {
      "__typename": "OrderUpdatesEcoContribution"
    }
  ]
}

Referenced in

OrderUpdatedOrderLine.cancelations

OrderUpdatesEcoContribution

eprCategoryCode

String

Extended Producer Responsibility category

producerId

String

Producer identifier of the eco-contribution. Not present if the producer identifier belongs to the operator.

producerIdOwner

String

Owner of the producerId

totalAmount

Float

Total amount of the eco-contribution

unitAmount

Float

Unit amount of the eco-contribution

Sample

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

Referenced in

OrderUpdatedOrderLine.ecoContributions

OrderUpdatedCancelation.ecoContributions

OrderUpdatedRefund.ecoContributions

OrderUpdatedRefund

refundId

Refund identifier

ecoContributions

[OrderUpdatesEcoContribution!],non-null

List of eco-contribution amounts and corresponding producer identifiers, if applicable

Sample

{
  "refundId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "ecoContributions": [
    {
      "__typename": "OrderUpdatesEcoContribution"
    }
  ]
}

Referenced in

OrderUpdatedOrderLine.refunds

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

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview