Products

Mirakl Platform

GraphQL Reference

Assessment

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

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

ReviewCustomer

Represents a customer who posted an evaluation

firstname

String!,non-null

First name of the customer

ID!,non-null

Identifier of the customer

lastname

String!,non-null

Last name of the customer

Sample

{
  "firstname": "Example String",
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "lastname": "Example String"
}

Referenced in

Evaluation.customer

ShopConnection

The connection type for Shop.

edges

[ShopEdge!]!,non-null

A list of edges.

pageInfo

PageInfo!,non-null

Information to aid in pagination.

Implements interfaces

Connection

Sample

{
  "edges": [
    {
      "node": {
        "additionalFields": [
          {
            "__typename": "BooleanAdditionalFieldValue"
          }
        ],
        "approvalDelay": 40,
        "approvalRate": 40,
        "banner": "Example String",
        "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "closedFrom": "Example Custom Scalar",
        "closedTo": "Example Custom Scalar",
        "contactInformation": {
          "__typename": "ShopContactInformation"
        },
        "dateCreated": "Example Custom Scalar",
        "description": "Example String",
        "evaluations": {
          "__typename": "EvaluationConnection"
        },
        "freeShipping": true,
        "grade": 40,
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "isProfessional": true,
        "logo": "Example String",
        "name": "Example String",
        "offersCount": 40,
        "orderMessagesResponseDelay": 40,
        "ordersCount": 40,
        "producerIdentifiers": [
          {
            "__typename": "ProducerIdentifier"
          }
        ],
        "recyclingPolicy": "Example String",
        "returnPolicy": {
          "__typename": "ReturnPolicy"
        },
        "shippings": [
          {
            "__typename": "ShopShippingConfiguration"
          }
        ]
      }
    }
  ],
  "pageInfo": {
    "endCursor": "Example String",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "Example String"
  }
}

ShopEdge

An edge in a connection.

node

Shop!,non-null

The item of the edge.

Sample

{
  "node": {
    "additionalFields": [
      {
        "__typename": "BooleanAdditionalFieldValue"
      }
    ],
    "approvalDelay": 40,
    "approvalRate": 40,
    "banner": "Example String",
    "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "closedFrom": "Example Custom Scalar",
    "closedTo": "Example Custom Scalar",
    "contactInformation": {
      "__typename": "ShopContactInformation"
    },
    "dateCreated": "Example Custom Scalar",
    "description": "Example String",
    "evaluations": {
      "__typename": "EvaluationConnection"
    },
    "freeShipping": true,
    "grade": 40,
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "isProfessional": true,
    "logo": "Example String",
    "name": "Example String",
    "offersCount": 40,
    "orderMessagesResponseDelay": 40,
    "ordersCount": 40,
    "producerIdentifiers": [
      {
        "__typename": "ProducerIdentifier"
      }
    ],
    "recyclingPolicy": "Example String",
    "returnPolicy": {
      "__typename": "ReturnPolicy"
    },
    "shippings": [
      {
        "__typename": "ShopShippingConfiguration"
      }
    ]
  }
}

Referenced in

ShopConnection.edges

Shop

Represents a shop.

additionalFields

[AdditionalFieldValue!]!,non-null

List of additional fields

approvalDelay

Int

Average time for a shop to accept or refuse an order (in seconds)

approvalRate

Float

Rate of accepted orders

banner

String

Url of the shop's banner image

businessId

ID!,non-null

Shop internal id

closedFrom

DateTime

The start date of the closing of the shop

closedTo

DateTime

The end date of the closing of the shop

contactInformation

ShopContactInformation

Contact information

dateCreated

DateTime!,non-null

Creation date of the shop

description

String

The description of the shop.

evaluations

EvaluationConnection!,non-null

Shop's evaluations.

firstafterlastbefore

freeShipping

Boolean!,non-null

Whether or not this shop offers free shipping to customers

grade

Float

Global grade of the shop

ID!,non-null

The identifier of the shop

isProfessional

Boolean!,non-null

Whether or not the shop is professional

logo

String

Url of the shop's logo image

name

String!,non-null

The name of the shop

offersCount

Int!,non-null

Total count of active offers of the shop

orderMessagesResponseDelay

Int

Average time for a shop to answer to an order message (in seconds)

ordersCount

Int!,non-null

Total count of debited orders (or if Pay on Delivery, accepted) of the shop

producerIdentifiers

[ProducerIdentifier!]!,non-null

List of shop’s producer identifiers per Extended Producer Responsibility (EPR) categories. Only available if the operator setting Activate data collection related to circular economy regulations is enabled.

recyclingPolicy

String

Recycling policy - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.

returnPolicy

ReturnPolicy

Terms of restitution.

shippings

[ShopShippingConfiguration!]!,non-null

All the pair shipping zone / shipping type accepted by the shop

Implements interfaces

Node

Sample

{
  "additionalFields": [
    {
      "__typename": "BooleanAdditionalFieldValue"
    }
  ],
  "approvalDelay": 40,
  "approvalRate": 40,
  "banner": "Example String",
  "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "closedFrom": "Example Custom Scalar",
  "closedTo": "Example Custom Scalar",
  "contactInformation": {
    "__typename": "ShopContactInformation"
  },
  "dateCreated": "Example Custom Scalar",
  "description": "Example String",
  "evaluations": {
    "__typename": "EvaluationConnection"
  },
  "freeShipping": true,
  "grade": 40,
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "isProfessional": true,
  "logo": "Example String",
  "name": "Example String",
  "offersCount": 40,
  "orderMessagesResponseDelay": 40,
  "ordersCount": 40,
  "producerIdentifiers": [
    {
      "__typename": "ProducerIdentifier"
    }
  ],
  "recyclingPolicy": "Example String",
  "returnPolicy": {
    "__typename": "ReturnPolicy"
  },
  "shippings": [
    {
      "__typename": "ShopShippingConfiguration"
    }
  ]
}

Referenced in

Offer.shop

Order.shop

ShopEdge.node

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview