Products

Mirakl Platform

GraphQL Reference

OrderUpdatesEcoContribution

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

OrderUpdatedCustomer

Customer information of the order (billing address, organization information)

accountingContact

OrderUpdatedCustomerContact

Data related to the accounting contact in the organization

billingAddress

OrderCustomerBillingAddress

Customer billing address

deliveryContact

OrderUpdatedCustomerContact

Data related to the delivery contact in the organization

organization

OrderUpdatedCustomerOrganization

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

Sample

{
  "accountingContact": {
    "__typename": "OrderUpdatedCustomerContact"
  },
  "billingAddress": {
    "__typename": "OrderCustomerBillingAddress"
  },
  "deliveryContact": {
    "__typename": "OrderUpdatedCustomerContact"
  },
  "organization": {
    "__typename": "OrderUpdatedCustomerOrganization"
  }
}

Referenced in

OrderUpdated.customer

OrderUpdatedCustomerContact

Data related to the contact in the organization

customerId

Customer contact's identifier

Sample

{
  "customerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}

Referenced in

OrderUpdatedCustomer.accountingContact

OrderUpdatedCustomer.deliveryContact

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

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview