Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Directives

Overview

Objects

Overview

OpenIncidentResponse

order
Order!,non-null
Sample
{ "order": { "__typename": "Order" } }

CloseIncidentResponse

order
Order!,non-null
Sample
{ "order": { "__typename": "Order" } }

CreateOrdersResponse

Represents the list of created orders and the list of offers that could not be shipped

offersNotShippable

List of offers not shippable

orders
[Order!]!,non-null

List of orders

Sample
{ "offersNotShippable": [ { "__typename": "CreateOrdersOfferNotShippable" } ], "orders": [ { "__typename": "Order" } ] }

CreateOrdersOfferNotShippable

Contains information about non shippable offers

errorCode
String!,non-null

Error code associated with the offer not shippable

offerId
String!,non-null

Offer's identifier not shippable

Sample
{ "errorCode": "Example String", "offerId": "Example String" }

ReceiveOrderResponse

order

The received order

Sample
{ "order": { "__typename": "Order" } }

PatchOrdersUpdatedOrder

List of errors encountered when updating order

id
ID!,non-null

Order identifier

Details of the modified order

Sample
{ "errors": [ { "__typename": "PatchOrderError" } ], "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "order": { "__typename": "OrderUpdated" } }

OrderUpdatedDeliveryDateTimeInterval

earliest

Earliest order delivery date

latest

Latest order delivery date

Sample
{ "earliest": "Example Custom Scalar", "latest": "Example Custom Scalar" }

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview