Products

Mirakl Platform

GraphQL Reference

GraphQL Overview

Download GraphQL schema

schema.docs.graphql

Queries

Overview

node
(id)
Node

Fetches an object given its ID

Arguments

ID!,non-nullrequired

ID of the object

Return type

Node

ID!,non-null

Query sample

query node($id: ID!) {
  node(id: $id) {
    id 
  }
}

Variables

{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}

Response sample

{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
  }
}

orders
(...args)
OrdersConnection

List orders for a given customer

Arguments

input

OrderFilter!,non-nullrequired

first

Int

Returns the first n elements from the list.

after

String

Returns the elements in the list that come after the specified cursor

last

Int

Returns the last n elements from the list.

before

String

Returns the elements in the list that come before the specified cursor

Return type

OrdersConnection

pageInfo

PageInfo!,non-null

Information to aid in pagination.

edges

[OrderEdge!]!,non-null

A list of edges.

Query sample

query orders(
  $input: OrderFilter!
  $first: Int
  $after: String
  $last: Int
  $before: String
) {
  orders(
    input: $input
    first: $first
    after: $after
    last: $last
    before: $before
  ) {
    pageInfo {
      endCursor 
      hasNextPage 
      hasPreviousPage 
      startCursor 
    }
    edges {
      node {
        additionalFields {
          __typename
          # ...BooleanAdditionalFieldValueFragment
        }
        businessId 
        canCancel 
        canEvaluate 
        commercialId 
        createdDate 
        currency 
        customer {
          __typename
          # ...OrderCustomerFragment
        }
        customerDebitedDate 
        customerDirectlyPaysSeller 
        deliveryDate {
          __typename
          # ...DeliveryDateTimeIntervalFragment
        }
        documents {
          __typename
          # ...OrderDocumentsFragment
        }
        evaluation {
          __typename
          # ...EvaluationFragment
        }
        fullyRefunded 
        hasIncident 
        hasInvoice 
        invoiceDetails {
          __typename
          # ...OrderInvoiceFragment
        }
        id 
        lastUpdateDate 
        orderLines {
          __typename
          # ...OrderLineFragment
        }
        orderTaxMode 
        paymentDestination {
          __typename
          # ...IbanOrderPaymentDestinationFragment
        }
        paymentDuration 
        paymentType 
        paymentWorkflow 
        price 
        promotions {
          __typename
          # ...OrderComputedPromotionsFragment
        }
        references {
          __typename
          # ...OrderReferenceFragment
        }
        shipping {
          __typename
          # ...OrderShippingFragment
        }
        shipments {
          __typename
          # ...ShipmentFragment
        }
        shop {
          __typename
          # ...ShopFragment
        }
        status {
          __typename
          # ...OrderStatusFragment
        }
        totalPrice 
        threads(
          # Arguments Here
        ) {
          __typename
          # ...ThreadConnectionFragment
        }
      }
    }
  }
}

Variables

{
  "input": {
    "customerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "commercialId": "Example String",
    "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
  },
  "first": 40,
  "after": "Example String",
  "last": 40,
  "before": "Example String"
}

Response sample

{
  "data": {
    "pageInfo": {
      "endCursor": "Example String",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "Example String"
    },
    "edges": [
      {
        "node": {
          "additionalFields": [
            {
              "__typename": "BooleanAdditionalFieldValue"
            }
          ],
          "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "canCancel": true,
          "canEvaluate": true,
          "commercialId": "Example String",
          "createdDate": "Example Custom Scalar",
          "currency": "Example Custom Scalar",
          "customer": {
            "__typename": "OrderCustomer"
          },
          "customerDebitedDate": "Example Custom Scalar",
          "customerDirectlyPaysSeller": true,
          "deliveryDate": {
            "__typename": "DeliveryDateTimeInterval"
          },
          "documents": {
            "__typename": "OrderDocuments"
          },
          "evaluation": {
            "__typename": "Evaluation"
          },
          "fullyRefunded": true,
          "hasIncident": true,
          "hasInvoice": true,
          "invoiceDetails": {
            "__typename": "OrderInvoice"
          },
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "lastUpdateDate": "Example Custom Scalar",
          "orderLines": [
            {
              "__typename": "OrderLine"
            }
          ],
          "orderTaxMode": "Example String",
          "paymentDestination": {
            "__typename": "IbanOrderPaymentDestination"
          },
          "paymentDuration": 40,
          "paymentType": "Example String",
          "paymentWorkflow": "Example String",
          "price": 40,
          "promotions": {
            "__typename": "OrderComputedPromotions"
          },
          "references": {
            "__typename": "OrderReference"
          },
          "shipping": {
            "__typename": "OrderShipping"
          },
          "shipments": [
            {
              "__typename": "Shipment"
            }
          ],
          "shop": {
            "__typename": "Shop"
          },
          "status": {
            "__typename": "OrderStatus"
          },
          "totalPrice": 40,
          "threads": {
            "__typename": "ThreadConnection"
          }
        }
      }
    ]
  }
}

shops
(...args)
ShopConnection!,non-null

List shops

Arguments

ids

[ID!],non-null

Shop's identifiers to retrieve

first

Int

Returns the first n elements from the list.

after

String

Returns the elements in the list that come after the specified cursor

last

Int

Returns the last n elements from the list.

before

String

Returns the elements in the list that come before the specified cursor

Return type

ShopConnection!

edges

[ShopEdge!]!,non-null

A list of edges.

pageInfo

PageInfo!,non-null

Information to aid in pagination.

Query sample

query shops(
  $ids: [ID!]
  $first: Int
  $after: String
  $last: Int
  $before: String
) {
  shops(
    ids: $ids
    first: $first
    after: $after
    last: $last
    before: $before
  ) {
    edges {
      node {
        additionalFields {
          __typename
          # ...BooleanAdditionalFieldValueFragment
        }
        approvalDelay 
        approvalRate 
        banner 
        businessId 
        closedFrom 
        closedTo 
        contactInformation {
          __typename
          # ...ShopContactInformationFragment
        }
        dateCreated 
        description 
        evaluations(
          # Arguments Here
        ) {
          __typename
          # ...EvaluationConnectionFragment
        }
        freeShipping 
        grade 
        id 
        isProfessional 
        logo 
        name 
        offersCount 
        orderMessagesResponseDelay 
        ordersCount 
        producerIdentifiers {
          __typename
          # ...ProducerIdentifierFragment
        }
        recyclingPolicy 
        returnPolicy {
          __typename
          # ...ReturnPolicyFragment
        }
        shippings {
          __typename
          # ...ShopShippingConfigurationFragment
        }
      }
    }
    pageInfo {
      endCursor 
      hasNextPage 
      hasPreviousPage 
      startCursor 
    }
  }
}

Variables

{
  "ids": [
    "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
  ],
  "first": 40,
  "after": "Example String",
  "last": 40,
  "before": "Example String"
}

Response sample

{
  "data": {
    "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"
    }
  }
}

threads
(...args)
ThreadConnection!,non-null

List threads for a given customer

Arguments

input

ThreadFilter!,non-nullrequired

first

Int

Returns the first n elements from the list.

after

String

Returns the elements in the list that come after the specified cursor

last

Int

Returns the last n elements from the list.

before

String

Returns the elements in the list that come before the specified cursor

Return type

ThreadConnection!

edges

[ThreadEdge!]!,non-null

A list of edges.

pageInfo

PageInfo!,non-null

Information to aid in pagination.

Query sample

query threads(
  $input: ThreadFilter!
  $first: Int
  $after: String
  $last: Int
  $before: String
) {
  threads(
    input: $input
    first: $first
    after: $after
    last: $last
    before: $before
  ) {
    edges {
      node {
        authorizedParticipants {
          __typename
          # ...ThreadParticipantFragment
        }
        businessId 
        currentParticipants {
          __typename
          # ...ThreadParticipantFragment
        }
        customerOrganization {
          __typename
          # ...ThreadCustomerOrganizationFragment
        }
        dateCreated 
        entities {
          __typename
          # ...ThreadEntityFragment
        }
        id 
        messages {
          __typename
          # ...ThreadMessageFragment
        }
        metadata {
          __typename
          # ...ThreadMetadataFragment
        }
        topic {
          __typename
          # ...ThreadTopicFragment
        }
      }
    }
    pageInfo {
      endCursor 
      hasNextPage 
      hasPreviousPage 
      startCursor 
    }
  }
}

Variables

{
  "input": {
    "customerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "customerOrganizationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "entityIds": [
      "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
    ],
    "entityType": "Example String",
    "channelCodes": [
      "Example String"
    ]
  },
  "first": 40,
  "after": "Example String",
  "last": 40,
  "before": "Example String"
}

Response sample

{
  "data": {
    "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"
    }
  }
}

shoppingCart
(input)
ShoppingCart!,non-null

List shipping charges of each offer, grouped by orders

Arguments

input

ShoppingCartInput!,non-nullrequired

Return type

ShoppingCart!

errors

[ShoppingCartError!]!,non-null

List of the errors encountered when computing the shipping fees

orders

[ShoppingCartOrder!]!,non-null

List of shipping fees information per order

Query sample

query shoppingCart($input: ShoppingCartInput!) {
  shoppingCart(input: $input) {
    errors {
      __typename
      # ...ShoppingCartErrorFragment
    }
    orders {
      __typename
      # ...ShoppingCartOrderFragment
    }
  }
}

Variables

{
  "input": {
    "computeOrderTaxes": true,
    "customerCode": "Example String",
    "customerShippingAddress": {
      "__typename": "ShoppingCartCustomerShippingAddressInput"
    },
    "offers": [
      {
        "__typename": "ShoppingCartOfferInput"
      }
    ],
    "pricingChannelCode": "Example String",
    "pricingCustomerOrganizationId": "Example String",
    "promoCodes": [
      "Example String"
    ],
    "shippingZoneCode": "Example String"
  }
}

Response sample

{
  "data": {
    "errors": [
      {
        "__typename": "ShoppingCartError"
      }
    ],
    "orders": [
      {
        "__typename": "ShoppingCartOrder"
      }
    ]
  }
}

reasons
[Reason!],non-null

Return type

[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

Query sample

query reasons {
  reasons {
    code 
    customerRight 
    operatorRight 
    shopRight 
    label 
    type 
  }
}

Response sample

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

offers
(...args)
OffersConnection!,non-null

Arguments

input

OfferFilter!,non-nullrequired

first

Int

Returns the first n elements from the list.

after

String

Returns the elements in the list that come after the specified cursor

last

Int

Returns the last n elements from the list.

before

String

Returns the elements in the list that come before the specified cursor

Return type

OffersConnection!

edges

[OfferEdge]

A list of edges

pageInfo

PageInfo!,non-null

Information to aid in pagination

Query sample

query offers(
  $input: OfferFilter!
  $first: Int
  $after: String
  $last: Int
  $before: String
) {
  offers(
    input: $input
    first: $first
    after: $after
    last: $last
    before: $before
  ) {
    edges {
      node {
        id 
        businessId 
        active 
        allowQuoteRequests 
        availability {
          __typename
          # ...DateTimeRangeFragment
        }
        additionalFields {
          __typename
          # ...BooleanAdditionalFieldValueFragment
        }
        currency 
        description 
        ecoContributions {
          __typename
          # ...OfferEcoContributionFragment
        }
        fulfillment {
          __typename
          # ...OfferFulfillmentFragment
        }
        inactivityReasons {
          __typename
          # ...OfferInactivityReasonFragment
        }
        professional 
        leadTimeToShip 
        orderQuantity {
          __typename
          # ...OfferOrderQuantityFragment
        }
        minShipping {
          __typename
          # ...OfferMinShippingInformationFragment
        }
        shipping {
          __typename
          # ...OfferShippingInformationFragment
        }
        platformModel 
        nbEvaluations 
        packageQuantity 
        product {
          __typename
          # ...ProductFragment
        }
        shop {
          __typename
          # ...ShopFragment
        }
        prices {
          __typename
          # ...PriceFragment
        }
        totalPrice 
        state {
          __typename
          # ...OfferStateFragment
        }
        quantity 
        logisticClass {
          __typename
          # ...OfferLogisticClassFragment
        }
      }
    }
    pageInfo {
      endCursor 
      hasNextPage 
      hasPreviousPage 
      startCursor 
    }
  }
}

Variables

{
  "input": {
    "product": {
      "__typename": "OfferProductFilter"
    },
    "premium": true,
    "active": true,
    "states": [
      {
        "__typename": "OfferStateFilter"
      }
    ],
    "channels": [
      {
        "__typename": "OfferChannelFilter"
      }
    ],
    "price": {
      "__typename": "OfferPriceFilter"
    }
  },
  "first": 40,
  "after": "Example String",
  "last": 40,
  "before": "Example String"
}

Response sample

{
  "data": {
    "edges": [
      {
        "node": {
          "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "businessId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
          "active": true,
          "allowQuoteRequests": true,
          "availability": {
            "__typename": "DateTimeRange"
          },
          "additionalFields": [
            {
              "__typename": "BooleanAdditionalFieldValue"
            }
          ],
          "currency": "Example Custom Scalar",
          "description": "Example String",
          "ecoContributions": [
            {
              "__typename": "OfferEcoContribution"
            }
          ],
          "fulfillment": {
            "__typename": "OfferFulfillment"
          },
          "inactivityReasons": [
            {
              "__typename": "OfferInactivityReason"
            }
          ],
          "professional": true,
          "leadTimeToShip": 40,
          "orderQuantity": {
            "__typename": "OfferOrderQuantity"
          },
          "minShipping": {
            "__typename": "OfferMinShippingInformation"
          },
          "shipping": {
            "__typename": "OfferShippingInformation"
          },
          "platformModel": "Example String",
          "nbEvaluations": 40,
          "packageQuantity": 40,
          "product": {
            "__typename": "Product"
          },
          "shop": {
            "__typename": "Shop"
          },
          "prices": [
            {
              "__typename": "Price"
            }
          ],
          "totalPrice": 40,
          "state": {
            "__typename": "OfferState"
          },
          "quantity": 40,
          "logisticClass": {
            "__typename": "OfferLogisticClass"
          }
        }
      }
    ],
    "pageInfo": {
      "endCursor": "Example String",
      "hasNextPage": true,
      "hasPreviousPage": true,
      "startCursor": "Example String"
    }
  }
}

Mutations

Overview

Directives

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview

GraphQL Overview

Queries

node(id)Node

node

Arguments

Return type

orders(...args)OrdersConnection

orders

Arguments

Return type

shops(...args)ShopConnection!,non-null

shops

Arguments

Return type

threads(...args)ThreadConnection!,non-null

threads

Arguments

Return type

shoppingCart(input)ShoppingCart!,non-null

shoppingCart

Arguments

Return type

reasons[Reason!],non-null

reasons

Return type

offers(...args)OffersConnection!,non-null

offers

Arguments

Return type

Mutations

Directives

Objects

Interfaces

Unions

Inputs

Scalars

node
(id)
Node

orders
(...args)
OrdersConnection

shops
(...args)
ShopConnection!,non-null

threads
(...args)
ThreadConnection!,non-null

shoppingCart
(input)
ShoppingCart!,non-null

reasons
[Reason!],non-null

offers
(...args)
OffersConnection!,non-null