Products

Mirakl Platform

GraphQL Reference

ThreadEdge

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

DeliveryDateTimeInformation

earliestDays

Int!,non-null

Earliest order delivery time

earliestDeliveryDate

DateTime!,non-null

Earliest order delivery date

latestDays

Int!,non-null

Latest order delivery time

latestDeliveryDate

DateTime!,non-null

Latest order delivery date

Sample

{
  "earliestDays": 40,
  "earliestDeliveryDate": "Example Custom Scalar",
  "latestDays": 40,
  "latestDeliveryDate": "Example Custom Scalar"
}

Referenced in

SelectedShippingType.deliveryTime

ShoppingCartAppliedShippingType.deliveryTime

ShoppingCartShippingType.deliveryTime

OfferDiscount

discountPrice

Float

Discount price. Not to be read if discount with ranges is specified (i.e. discount with at least one range with quantity threshold greater than one).

startDate

DateTime

Discount start date

endDate

DateTime

Discount end date

originPrice

Float

Origin price

ranges

[DiscountRange!],non-null

Discount ranges

Sample

{
  "discountPrice": 40,
  "startDate": "Example Custom Scalar",
  "endDate": "Example Custom Scalar",
  "originPrice": 40,
  "ranges": [
    {
      "__typename": "DiscountRange"
    }
  ]
}

Referenced in

ShoppingCartLine.offerDiscount

DiscountRange

price

Float!,non-null

Price of the offer if the quantity threshold is reached

quantityThreshold

Int!,non-null

Minimum quantity to order for the given price to be applied

Sample

{
  "price": 40,
  "quantityThreshold": 40
}

Referenced in

OfferDiscount.ranges

ShoppingCartOfferTaxAmount

amount

Float!,non-null

Tax amount

name

String!,non-null

Jurisdiction tax name

type

String!,non-null

Jurisdiction tax type (City, State...)

Sample

{
  "amount": 40,
  "name": "Example String",
  "type": "Example String"
}

Referenced in

ShoppingCartLine.shippingTaxes

ShoppingCartLine.taxes

ThreadConnection

The connection type for Thread.

edges

[ThreadEdge!]!,non-null

A list of edges.

pageInfo

PageInfo!,non-null

Information to aid in pagination.

Implements interfaces

Connection

Sample

{
  "edges": [
    {
      "node": {
        "authorizedParticipants": [
          {
            "__typename": "ThreadParticipant"
          }
        ],
        "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "currentParticipants": [
          {
            "__typename": "ThreadParticipant"
          }
        ],
        "customerOrganization": {
          "__typename": "ThreadCustomerOrganization"
        },
        "dateCreated": "Example Custom Scalar",
        "entities": [
          {
            "__typename": "ThreadEntity"
          }
        ],
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "messages": [
          {
            "__typename": "ThreadMessage"
          }
        ],
        "metadata": {
          "__typename": "ThreadMetadata"
        },
        "topic": {
          "__typename": "ThreadTopic"
        }
      }
    }
  ],
  "pageInfo": {
    "endCursor": "Example String",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "Example String"
  }
}

Referenced in

Order.threads

ThreadEdge

An edge in a connection.

node

Thread!,non-null

The item of the edge.

Sample

{
  "node": {
    "authorizedParticipants": [
      {
        "__typename": "ThreadParticipant"
      }
    ],
    "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "currentParticipants": [
      {
        "__typename": "ThreadParticipant"
      }
    ],
    "customerOrganization": {
      "__typename": "ThreadCustomerOrganization"
    },
    "dateCreated": "Example Custom Scalar",
    "entities": [
      {
        "__typename": "ThreadEntity"
      }
    ],
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "messages": [
      {
        "__typename": "ThreadMessage"
      }
    ],
    "metadata": {
      "__typename": "ThreadMetadata"
    },
    "topic": {
      "__typename": "ThreadTopic"
    }
  }
}

Referenced in

ThreadConnection.edges

Thread

Represents a thread.

authorizedParticipants

[ThreadParticipant!]!,non-null

Thread authorized participants. Those are the participants who are authorized to join the thread.

businessId

ID!,non-null

currentParticipants

[ThreadParticipant!]!,non-null

Thread current participants. Those are the participants who have actually participated in the thread, meaning that they are either sender or receivers of at least one message of the thread.

customerOrganization

ThreadCustomerOrganization

Data related to the customer organization (B2B transactions)

dateCreated

DateTime!,non-null

Thread creation date

entities

[ThreadEntity!],non-null

Thread entities

ID!,non-null

Thread id

messages

[ThreadMessage]!,non-null

Thread messages

metadata

ThreadMetadata

Thread metadata

topic

ThreadTopic!,non-null

Thread topic

Implements interfaces

Node

Sample

{
  "authorizedParticipants": [
    {
      "__typename": "ThreadParticipant"
    }
  ],
  "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "currentParticipants": [
    {
      "__typename": "ThreadParticipant"
    }
  ],
  "customerOrganization": {
    "__typename": "ThreadCustomerOrganization"
  },
  "dateCreated": "Example Custom Scalar",
  "entities": [
    {
      "__typename": "ThreadEntity"
    }
  ],
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "messages": [
    {
      "__typename": "ThreadMessage"
    }
  ],
  "metadata": {
    "__typename": "ThreadMetadata"
  },
  "topic": {
    "__typename": "ThreadTopic"
  }
}

Referenced in

CreateThreadResponse.thread

ReplyToThreadResponse.thread

ThreadEdge.node

ThreadParticipant

Represents a thread participant.

displayName

String!,non-null

Participant display name

Participant id. When type equals OPERATOR, no id will be returned.

type

String!,non-null

Participant type. Possible values are: CUSTOMER, OPERATOR, SHOP

Sample

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

Referenced in

Thread.authorizedParticipants

Thread.currentParticipants

ThreadCustomerOrganization

Represents a customer organization.

displayName

String!,non-null

Customer organization name

ID!,non-null

Customer organization id

Sample

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

Referenced in

Thread.customerOrganization

ThreadEntity

Represents an entity link to a thread such as an order, an offer...

ID!,non-null

Entity id

label

String!,non-null

Entity label

type

String!,non-null

Entity type. Possible values are: MMP_ORDER, MMP_OFFER, MPS_ORDER, MPS_SERVICE

Sample

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

Referenced in

Thread.entities

ThreadMessage

Represents a message in a thread.

attachments

[ThreadMessageAttachment!]!,non-null

Message attachments

body

String!,non-null

Message body

dateCreated

DateTime!,non-null

Message creation date

from

ThreadMessageSender!,non-null

Message sender

ID!,non-null

Message id

[ThreadMessageRecipient!]!,non-null

Message recipients

Sample

{
  "attachments": [
    {
      "__typename": "ThreadMessageAttachment"
    }
  ],
  "body": "Example String",
  "dateCreated": "Example Custom Scalar",
  "from": {
    "__typename": "ThreadMessageSender"
  },
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "to": [
    {
      "__typename": "ThreadMessageRecipient"
    }
  ]
}

Referenced in

Thread.messages

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview