Skip to content
Products
/
Mirakl Platform
/
GraphQL Reference
/
Inputs
/
AssessmentInput

GraphQL Overview

Download GraphQL schema
schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Inputs

Overview

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
}

AssessmentInput

code
String!,non-null

Code of the answered assessment

response
String!,non-null

Response associated with the assessment. The response is either:

  • a grade represented by an integer among 0, 1, 2, 3, 4, 5.
  • a boolean represented by a string whom possible values are : 'true', 'false'.
Sample
{
  "code": "Example String",
  "response": "Example String"
}
Referenced in
EvaluationInput.assessments

CreateThreadInput

attachments
[AttachmentInput!],non-null

Files to attach to the thread.

threadInput
ThreadDetailsInput!,non-null

New thread details.

Sample
{
  "attachments": [
    {
      "__typename": "AttachmentInput"
    }
  ],
  "threadInput": {
    "__typename": "ThreadDetailsInput"
  }
}

ThreadDetailsInput

body
String!,non-null

Body of the first message of the thread.

to
[String!]!,non-null

Message recipients. Valid values are: OPERATOR, SHOP, CUSTOMER

topic
TopicInput!,non-null

The topic can either have a free or a fixed value depending on the topic type

Sample
{
  "body": "Example String",
  "to": [
    "Example String"
  ],
  "topic": {
    "__typename": "TopicInput"
  }
}
Referenced in
CreateThreadInput.threadInput

TopicInput

type
String!,non-null

Must be FREE_TEXT or REASON_CODE

value
String!,non-null

If type is FREE_TEXT, a text. If type is REASON_CODE, a valid reason code.

Sample
{
  "type": "Example String",
  "value": "Example String"
}
Referenced in
ThreadDetailsInput.topic
ReplyToThreadInput.topic

AttachmentInput

name
String!,non-null

The name of the file.

url
Url!,non-null

The url of the file returned by the file upload api /api/graphql/upload

Sample
{
  "name": "Example String",
  "url": "Example Custom Scalar"
}
Referenced in
CreateThreadInput.attachments
ReplyToThreadInput.attachments

ReplyToThreadInput

attachments
[AttachmentInput!],non-null

Files to attach to the thread.

body
String!,non-null

Body of the message to add to the thread.

to
[RecipientInput!]!,non-null

Message recipients.

topic
TopicInput

New topic for the thread. Leave empty to keep the current topic.

Sample
{
  "attachments": [
    {
      "__typename": "AttachmentInput"
    }
  ],
  "body": "Example String",
  "to": [
    {
      "__typename": "RecipientInput"
    }
  ],
  "topic": {
    "__typename": "TopicInput"
  }
}

Scalars

Overview