Skip to content
Products
/
Mirakl Platform
/
GraphQL Reference
/
Mutations

GraphQL Overview

Download GraphQL schema
schema.docs.graphql

Queries

Overview

Mutations

Overview

batchCreateOrders

(input)
CreateOrdersResponse!,non-null

Creates a new order.

Arguments

input
CreateOrdersInput!,non-nullrequired

The details of the orders to create.

Return type

CreateOrdersResponse!
offersNotShippable
[CreateOrdersOfferNotShippable!]!,non-null

List of offers not shippable

orders
[Order!]!,non-null

List of orders

Mutation sample
mutation batchCreateOrders($input: CreateOrdersInput!) {
  batchCreateOrders(input: $input) {
    offersNotShippable {
      __typename
      # ...CreateOrdersOfferNotShippableFragment
    }
    orders {
      __typename
      # ...OrderFragment
    }
  }
}
Variables
{
  "input": {
    "channelCode": "Example String",
    "commercialId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "customer": {
      "__typename": "OrdersCustomerInput"
    },
    "customerDirectlyPaysSeller": true,
    "invoiceDetails": {
      "__typename": "OrderInvoiceInput"
    },
    "offers": [
      {
        "__typename": "OrderOfferInput"
      }
    ],
    "orderAdditionalFields": [
      {
        "__typename": "AdditionalFieldValueInput"
      }
    ],
    "orderTaxMode": "Example String",
    "paymentDuration": 40,
    "paymentInfo": {
      "__typename": "OrderPaymentInfoInput"
    },
    "paymentWorkflow": "Example String",
    "promotion": {
      "__typename": "OrderPromotionInput"
    },
    "references": {
      "__typename": "OrderReferencesInput"
    },
    "scored": true,
    "shippingZoneCode": "Example String"
  }
}
Response sample
{
  "data": {
    "offersNotShippable": [
      {
        "__typename": "CreateOrdersOfferNotShippable"
      }
    ],
    "orders": [
      {
        "__typename": "Order"
      }
    ]
  }
}

receiveOrder

(input)
ReceiveOrderResponse!,non-null

Validate the receipt of an order

Arguments

input
ReceiveOrderInput!,non-nullrequired

The details of the order to receive.

Return type

ReceiveOrderResponse!
order
Order

The received order

Mutation sample
mutation receiveOrder($input: ReceiveOrderInput!) {
  receiveOrder(input: $input) {
    order {
      __typename
      # ...OrderFragment
    }
  }
}
Variables
{
  "input": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
  }
}
Response sample
{
  "data": {
    "order": {
      "__typename": "Order"
    }
  }
}

batchPatchOrders

(input)
PatchOrdersResponse!,non-null

Update an order

Arguments

input
PatchOrdersInput

The details of the order to update.

Return type

PatchOrdersResponse!
updatedOrders
[PatchOrdersUpdatedOrder!]!,non-null

A list of updated orders and orders in error objects

Mutation sample
mutation batchPatchOrders($input: PatchOrdersInput) {
  batchPatchOrders(input: $input) {
    updatedOrders {
      __typename
      # ...PatchOrdersUpdatedOrderFragment
    }
  }
}
Variables
{
  "input": {
    "orders": [
      {
        "__typename": "PatchOrderInput"
      }
    ]
  }
}
Response sample
{
  "data": {
    "updatedOrders": [
      {
        "__typename": "PatchOrdersUpdatedOrder"
      }
    ]
  }
}

batchCancelOrderLines

(input)
CancelOrderLinesResponse!,non-null

Cancel an order line

Arguments

input
CancelOrderLinesInput!,non-nullrequired

The details of the order lines to cancel.

Return type

CancelOrderLinesResponse!
cancelledOrderLines
[CancelledOrderLine!]!,non-null
taxMode
String!,non-null
Mutation sample
mutation batchCancelOrderLines($input: CancelOrderLinesInput!) {
  batchCancelOrderLines(input: $input) {
    cancelledOrderLines {
      __typename
      # ...CancelledOrderLineFragment
    }
    taxMode 
  }
}
Variables
{
  "input": {
    "cancelations": [
      {
        "__typename": "CancelOrderLineInput"
      }
    ],
    "taxMode": "Example String"
  }
}
Response sample
{
  "data": {
    "cancelledOrderLines": [
      {
        "__typename": "CancelledOrderLine"
      }
    ],
    "taxMode": "Example String"
  }
}

createThreadOnOrder

(...args)
CreateThreadResponse

Create a new thread on a given order.

Arguments

orderId
ID!,non-nullrequired
input
CreateThreadInput!,non-nullrequired

Return type

CreateThreadResponse
thread
Thread!,non-null

The created thread.

Mutation sample
mutation createThreadOnOrder($orderId: ID!, $input: CreateThreadInput!) {
  createThreadOnOrder(orderId: $orderId, input: $input) {
    thread {
      __typename
      # ...ThreadFragment
    }
  }
}
Variables
{
  "orderId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "input": {
    "attachments": [
      {
        "__typename": "AttachmentInput"
      }
    ],
    "threadInput": {
      "__typename": "ThreadDetailsInput"
    }
  }
}
Response sample
{
  "data": {
    "thread": {
      "__typename": "Thread"
    }
  }
}

replyToThread

(...args)
ReplyToThreadResponse

Reply to a given thread.

Arguments

threadId
ID!,non-nullrequired
input
ReplyToThreadInput!,non-nullrequired

Return type

ReplyToThreadResponse
thread
Thread!,non-null

The updated thread.

Mutation sample
mutation replyToThread($threadId: ID!, $input: ReplyToThreadInput!) {
  replyToThread(threadId: $threadId, input: $input) {
    thread {
      __typename
      # ...ThreadFragment
    }
  }
}
Variables
{
  "threadId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "input": {
    "attachments": [
      {
        "__typename": "AttachmentInput"
      }
    ],
    "body": "Example String",
    "to": [
      {
        "__typename": "RecipientInput"
      }
    ],
    "topic": {
      "__typename": "TopicInput"
    }
  }
}
Response sample
{
  "data": {
    "thread": {
      "__typename": "Thread"
    }
  }
}

openIncident

(input)
OpenIncidentResponse!,non-null

Open incident for an order line

Arguments

input
OpenIncidentInput

Return type

OpenIncidentResponse!
order
Order!,non-null
Mutation sample
mutation openIncident($input: OpenIncidentInput) {
  openIncident(input: $input) {
    order {
      __typename
      # ...OrderFragment
    }
  }
}
Variables
{
  "input": {
    "orderId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "orderLineId": "Example String",
    "reasonCode": "Example String"
  }
}
Response sample
{
  "data": {
    "order": {
      "__typename": "Order"
    }
  }
}

closeIncident

(input)
CloseIncidentResponse!,non-null

Close incident for an order line

Arguments

input
CloseIncidentInput

Return type

CloseIncidentResponse!
order
Order!,non-null
Mutation sample
mutation closeIncident($input: CloseIncidentInput) {
  closeIncident(input: $input) {
    order {
      __typename
      # ...OrderFragment
    }
  }
}
Variables
{
  "input": {
    "orderId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "orderLineId": "Example String",
    "reasonCode": "Example String"
  }
}
Response sample
{
  "data": {
    "order": {
      "__typename": "Order"
    }
  }
}

evaluateOrder

(...args)
Evaluation

Evaluate an order

Arguments

orderId
ID!,non-nullrequired
input
EvaluationInput!,non-nullrequired

Return type

Evaluation
assessments
[Assessment!]!,non-null

List of assessments

comment
String

Evaluation comment

customer
ReviewCustomer!,non-null

Customer who posted the evaluation

date
DateTime!,non-null

Evaluation creation date

grade
Grade!,non-null

Evaluation grade

reply
EvaluationReply

Reply of a shop or operator on an evaluation

Mutation sample
mutation evaluateOrder($orderId: ID!, $input: EvaluationInput!) {
  evaluateOrder(orderId: $orderId, input: $input) {
    assessments {
      __typename
      # ...AssessmentFragment
    }
    comment 
    customer {
      __typename
      # ...ReviewCustomerFragment
    }
    date 
    grade 
    reply {
      __typename
      # ...EvaluationReplyFragment
    }
  }
}
Variables
{
  "orderId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "input": {
    "assessments": [
      {
        "__typename": "AssessmentInput"
      }
    ],
    "comment": "Example String",
    "grade": "Example Custom Scalar",
    "visible": true
  }
}
Response sample
{
  "data": {
    "assessments": [
      {
        "__typename": "Assessment"
      }
    ],
    "comment": "Example String",
    "customer": {
      "__typename": "ReviewCustomer"
    },
    "date": "Example Custom Scalar",
    "grade": "Example Custom Scalar",
    "reply": {
      "__typename": "EvaluationReply"
    }
  }
}

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview