Products

Mirakl Platform

GraphQL Reference

Reason

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

ShipmentLine

Represents a shipment line

offerSku

String

Offer sku

orderLine

OrderLine

Order line linked to the shipment line

packageReference

String

Package reference

quantity

Int!,non-null

Quantity

Sample

{
  "offerSku": "Example String",
  "orderLine": {
    "__typename": "OrderLine"
  },
  "packageReference": "Example String",
  "quantity": 40
}

Referenced in

Shipment.shipmentLines

ShipmentTracking

Represents a shipment tracking information

carrierCode

String

The code of a carrier. This information is mandatory for a registered carrier.

carrierName

String

The name of a carrier. This information is mandatory for an unregistered carrier.

trackingNumber

String

The carrier tracking number. This information is mandatory for a registered carrier with a URL requiring a tracking number.

trackingUrl

Url

The tracking url of a carrier. This information is unused for registered carriers (because computed automatically). This information is optional for unregistered carriers.

Sample

{
  "carrierCode": "Example String",
  "carrierName": "Example String",
  "trackingNumber": "Example String",
  "trackingUrl": "Example Custom Scalar"
}

Referenced in

Shipment.tracking

OrderDocuments

Represents all the documents available on an order

downloadUrl

Url!,non-null

Url to retrieve all order's documents

files

[OrderDocument!]!,non-null

List of all order's documents

Sample

{
  "downloadUrl": "Example Custom Scalar",
  "files": [
    {
      "__typename": "OrderDocument"
    }
  ]
}

Referenced in

Order.documents

OrderDocument

Represents an order's document

dateUploaded

DateTime

Document uploaded date

downloadUrl

Url!,non-null

Url to retrieve this particular document

fileName

String!,non-null

Document file name

fileSize

Int

Document file size

ID!,non-null

Document identifier

type

String!,non-null

Document type code

Sample

{
  "dateUploaded": "Example Custom Scalar",
  "downloadUrl": "Example Custom Scalar",
  "fileName": "Example String",
  "fileSize": 40,
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "type": "Example String"
}

Referenced in

OrderDocuments.files

PageInfo

Information about pagination in a connection.

endCursor

String

When paginating forwards, the cursor to continue.

hasNextPage

Boolean!,non-null

When paginating forwards, are there more items?

hasPreviousPage

Boolean!,non-null

When paginating backwards, are there more items?

startCursor

String

When paginating backwards, the cursor to continue.

Sample

{
  "endCursor": "Example String",
  "hasNextPage": true,
  "hasPreviousPage": true,
  "startCursor": "Example String"
}

Referenced in

OffersConnection.pageInfo

OrdersConnection.pageInfo

Connection.pageInfo

EvaluationConnection.pageInfo

ShopConnection.pageInfo

ThreadConnection.pageInfo

Reason

code

String!,non-null

Reason code

customerRight

Boolean!,non-null

Indicate if reason is enabled to the customer

operatorRight

Boolean!,non-null

Indicate if reason is enabled to the operator

shopRight

Boolean!,non-null

Indicate if reason is enabled to the shop

label

String!,non-null

Reason label

type

String!,non-null

Type of the reason

Sample

{
  "code": "Example String",
  "customerRight": true,
  "operatorRight": true,
  "shopRight": true,
  "label": "Example String",
  "type": "Example String"
}

EvaluationConnection

edges

[EvaluationEdge!]!,non-null

A list of edges.

pageInfo

PageInfo!,non-null

Information to aid in pagination.

totalCount

Long!,non-null

The total count of evaluations.

Implements interfaces

Connection

Sample

{
  "edges": [
    {
      "node": {
        "assessments": [
          {
            "__typename": "Assessment"
          }
        ],
        "comment": "Example String",
        "customer": {
          "__typename": "ReviewCustomer"
        },
        "date": "Example Custom Scalar",
        "grade": "Example Custom Scalar",
        "reply": {
          "__typename": "EvaluationReply"
        }
      }
    }
  ],
  "pageInfo": {
    "endCursor": "Example String",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "Example String"
  },
  "totalCount": "Example Custom Scalar"
}

Referenced in

Shop.evaluations

EvaluationEdge

An edge in a connection.

node

Evaluation!,non-null

The item of the edge.

Sample

{
  "node": {
    "assessments": [
      {
        "__typename": "Assessment"
      }
    ],
    "comment": "Example String",
    "customer": {
      "__typename": "ReviewCustomer"
    },
    "date": "Example Custom Scalar",
    "grade": "Example Custom Scalar",
    "reply": {
      "__typename": "EvaluationReply"
    }
  }
}

Referenced in

EvaluationConnection.edges

Evaluation

Represents an evaluation. It could be for a shop, an order...

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

EvaluationReply

Reply of a shop or operator on an evaluation

Sample

{
  "assessments": [
    {
      "__typename": "Assessment"
    }
  ],
  "comment": "Example String",
  "customer": {
    "__typename": "ReviewCustomer"
  },
  "date": "Example Custom Scalar",
  "grade": "Example Custom Scalar",
  "reply": {
    "__typename": "EvaluationReply"
  }
}

Referenced in

Order.evaluation

EvaluationEdge.node

Assessment

Represents an evaluation assessment

code

String!,non-null

Assessment code

label

String!,non-null

Assessment label

response

String!,non-null

Response associated with the assessment

Sample

{
  "code": "Example String",
  "label": "Example String",
  "response": "Example String"
}

Referenced in

Evaluation.assessments

EvaluationReply

Represents a reply to an evaluation.

comment

String!,non-null

Reply comment

date

DateTime!,non-null

Reply date

type

String

Type of user who replied. Possible values are: SHOP, OPERATOR

Sample

{
  "comment": "Example String",
  "date": "Example Custom Scalar",
  "type": "Example String"
}

Referenced in

Evaluation.reply

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview