Products

Mirakl Platform

GraphQL Reference

CancelOrderLineInput

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Inputs

Overview

PatchOrderCustomerDeliveryContactInput

Data related to the delivery contact in the organization

customerId

Customer contact's civility

Sample

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

Referenced in

PatchOrderCustomerInput.deliveryContact

PatchOrderCustomerOrganizationInput

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

address

PatchOrderCustomerOrganizationAddressInput

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": "PatchOrderCustomerOrganizationAddressInput"
  },
  "identificationNumber": "Example String",
  "name": "Example String",
  "taxIdentificationNumber": "Example String"
}

Referenced in

PatchOrderCustomerInput.organization

PatchOrderCustomerOrganizationAddressInput

Address of the organization

city

String

Address city

country

CountryCode

Country ISO 3166-1 code of the address

state

String

Address state

street1

String

First information line of the address

street2

String

Second information line of the address

zipCode

String

Address zip code, mandatory with some exceptions

Sample

{
  "city": "Example String",
  "country": "Example Custom Scalar",
  "state": "Example String",
  "street1": "Example String",
  "street2": "Example String",
  "zipCode": "Example String"
}

Referenced in

PatchOrderCustomerOrganizationInput.address

PatchOrderReferencesInput

Order references

orderReferenceForCustomer

String

Order reference for customer, only operator and front can update this field. May not be blank.

Sample

{
  "orderReferenceForCustomer": "Example String"
}

Referenced in

PatchOrderInput.references

CancelOrderLinesInput

cancelations

[CancelOrderLineInput!]!,non-null

List of representations of cancellations to be created

taxMode

String

Please note: If the taxes are not specified, the prices with mode TAX_EXCLUDED and with mode TAX_INCLUDED will return the same amounts. Possible values:

TAX_EXCLUDED: the price fields (price, unit price, shipping price and order total prices) do not include taxes (taxes come on top of the price amount).
TAX_INCLUDED: the price fields include the tax amounts. If not specified, the default order tax mode of the platform is used.

Sample

{
  "cancelations": [
    {
      "__typename": "CancelOrderLineInput"
    }
  ],
  "taxMode": "Example String"
}

CancelOrderLineInput

amount

CancelledAmountInput

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)

fees

[CancellationFeeInput!],non-null

The fees to be canceled

orderLineId

ID!,non-null

Order line's identifier that must be canceled

quantity

Int!,non-null

The quantity of goods to cancel

reasonCode

String!,non-null

Cancellation's reason code

shippingAmount

CancelledShippingAmountInput

The shipping charges with taxes to be canceled

Sample

{
  "amount": {
    "__typename": "CancelledAmountInput"
  },
  "currency": "Example Custom Scalar",
  "fees": [
    {
      "__typename": "CancellationFeeInput"
    }
  ],
  "orderLineId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "quantity": 40,
  "reasonCode": "Example String",
  "shippingAmount": {
    "__typename": "CancelledShippingAmountInput"
  }
}

Referenced in

CancelOrderLinesInput.cancelations

CancellationFeeInput

amount

Float

Order Fee amount

code

String

Order Fee code

Sample

{
  "amount": 40,
  "code": "Example String"
}

Referenced in

CancelOrderLineInput.fees

CancelledAmountInput

amount

Float

The offer part amount to be canceled

taxes

[TaxAmountInput!],non-null

The taxes to be canceled on the product price (this field is required if the order has taxes)

Sample

{
  "amount": 40,
  "taxes": [
    {
      "__typename": "TaxAmountInput"
    }
  ]
}

Referenced in

CancelOrderLineInput.amount

CancelledShippingAmountInput

amount

Float

The shipping charges part amount to be canceled

taxes

[TaxAmountInput!],non-null

The taxes to be canceled on the shipping price (this field is required if the order has shipping taxes)

Sample

{
  "amount": 40,
  "taxes": [
    {
      "__typename": "TaxAmountInput"
    }
  ]
}

Referenced in

CancelOrderLineInput.shippingAmount

TaxAmountInput

amount

Float

Tax amount

code

String

Tax code

Sample

{
  "amount": 40,
  "code": "Example String"
}

Referenced in

CancelledAmountInput.taxes

CancelledShippingAmountInput.taxes

EvaluationInput

assessments

[AssessmentInput!]!,non-null

List of the evaluation criteria expected by the operator.

comment

String

A brief comment associated with the evaluation to explain the mark

grade

Grade!,non-null

The global mark of the evaluation which is an integer among 0, 1, 2, 3, 4, 5.

visible

Boolean

The visibility of the evaluation (visible by default)

Sample

{
  "assessments": [
    {
      "__typename": "AssessmentInput"
    }
  ],
  "comment": "Example String",
  "grade": "Example Custom Scalar",
  "visible": true
}

Scalars

Overview