Order types
This list contains all query and input types for the order endpoints.
Order
Fields
- Name
id- Type
- ID!
- Description
Unique identifier for the Order.
- Name
_id- Type
- Int!
- Description
Unique number identifier for the Order.
- Name
account_id- Type
- ID!
- Description
Unique number identifier for the Order.
- Name
updated_at- Label
TimeStamp!- Description
Timestamp of when the order was updated.
- Name
created_at- Label
TimeStamp!- Description
Timestamp of when the order was created.
- Name
archived_at- Label
TimeStamp- Description
Timestamp of when the order was archived.
- Name
cancelled_at- Label
TimeStamp- Description
Timestamp of when the order was cancelled.
- Name
email- Type
- Email!
- Description
Customer email address.
scalar Email
- Name
phone- Type
- Phone!
- Description
Customer phone number.
scalar Phone
- Name
name- Type
- String!
- Description
Customer name.
- Name
notes- Type
- String
- Description
Order notes.
- Name
financial_status- Type
- OrderFinancialStatus!
- Description
Order financial status.
enum OrderFinancialStatus { pending paid refunded partially_refunded }
- Name
fulfillment_status- Type
- OrderFulfillmentStatus!
- Description
Order fulfillment status.
enum OrderFulfillmentStatus { unfulfilled fulfilled partial }
- Name
client_details- Type
- ClientDetails!
- Description
Customer client details.
type ClientDetails { ip: String device: String user_agent: String }
- Name
custom- Type
- CustomFields!
- Description
Order custom fields.
scalar CustomFields
- Name
tags- Type
- [String!]!
- Description
Order tags.
- Name
discount_value- Type
- Float!
- Description
Order discount value.
- Name
bundle_discount_value- Type
- Float!
- Description
Order bundle discount value.
- Name
normal_discount_value- Type
- Float!
- Description
Order normal discount value.
- Name
total- Type
- Float!
- Description
Order total cost.
- Name
shipping- Type
- Float!
- Description
Order shipping cost.
- Name
subtotal- Type
- Float!
- Description
Order subtotal.
- Name
payments- Label
[Payment!]!- Description
Order payments.
- Name
refunded_amount- Type
- Float!
- Description
Order refunded amount.
- Name
refundable- Type
- Float!
- Description
Order refundable amount.
- Name
net_payment- Type
- Float!
- Description
Order net payment amount.
- Name
paid_by_customer- Type
- Float!
- Description
Order amount paid by customer.
- Name
original_total- Type
- Float!
- Description
Order original total cost.
- Name
shipping_address- Label
Address- Description
Customer shipping address.
- Name
billing_address- Label
Address- Description
Customer billing address.
- Name
customer- Label
Customer!- Description
Customer details.
- Name
customer_full_name- Type
- String
- Description
Customer full name.
- Name
items- Label
[ProductVariantSnapshotOrOrderBumpSnapshot!]!- Description
Order items union type.
- Name
checkout- Label
Checkout- Description
Order checkout details.
- Name
test- Type
- Boolean!
- Description
Order test option.
- Name
nextOrderID- Type
- ID
- Description
The next order id.
- Name
prevOrderID- Type
- ID
- Description
Previous order id.
- Name
link- Type
- String
- Description
Order link.
- Name
currency- Type
- String!
- Description
Order currency.
- Name
utm- Type
- [Utm!]
- Description
Order utm.
type Utm { v: String! k: String! id: String! }
Request
query ordersQuery($first: Int, $after: String, $query: String!){
orders(query: "order_by:id order_dir:desc", after: "WzVE4OTA5LDEe/4OTA5XQ==", first: 10){
edges{
node{
id
_id
name
total
fulfillment_status
financial_status
customer {
id
full_name
}
...
}
}
}
}
InputOrder
Fields
- Name
notes- Type
- String
- Description
Order notes.
- Name
archived- Type
- Boolean
- Description
The archived option.
- Name
shipping_address- Label
InputAddress- Description
Customer shipping address.
- Name
billing_address- Label
InputAddress- Description
Customer billing address.
- Name
email- Type
- String
- Description
Customer email address.
- Name
phone- Type
- String
- Description
Customer phone number.
- Name
sync_customer_details- Type
- Boolean
- Description
Order sync customer detail boolean.
- Name
items- Type
- [ID!]
- Description
Order items.
- Name
variants- Type
- [Int!]
- Description
Order variants.
- Name
custom- Type
- CustomFields
- Description
Order custom fields.
scalar CustomFields
- Name
tags- Type
- [String!]
- Description
Order tags.
Request
mutation updateOrderMutation($node: InputOrder!, $id: Int!){
updateOrder(node: $node, id: $id){
# Order type fields
}
}
Payment
Fields
- Name
id- Type
- ID!
- Description
Unique identifier for the payment.
- Name
_id- Type
- Int!
- Description
Unique number identifier for the payment.
- Name
updated_at- Label
TimeStamp!- Description
Timestamp of when the payment was updated.
- Name
created_at- Label
TimeStamp!- Description
Timestamp of when the payment was created.
- Name
discount_snapshot- Label
DiscountSnapshot- Description
Payment discount snapshot.
- Name
price_bundle_snapshot- Label
[PriceBundleSnapshot!]!- Description
Payment price bundle snapshot.
- Name
total- Type
- Float!
- Description
Payment total.
- Name
sub_total- Type
- Float!
- Description
Payment subtotal.
- Name
refunds- Type
- [Refund]
- Description
Payment refunds.
type Refund { id: ID! _id: Int! amount: Float! reason: String }
- Name
refunded- Type
- Float!
- Description
Payment refunded amount.
- Name
refundable- Type
- Float!
- Description
Payment refundable amount.
- Name
paid- Type
- Float!
- Description
Payment paid amount.
- Name
paid_at- Label
TimeStamp- Description
Timestamp of when the payment was paid.
- Name
discount_value- Type
- Float!
- Description
Payment discount value.
- Name
source- Label
Source!- Description
Payment source.
- Name
shipping- Type
- Shipping
- Description
Payment shipping information.
type Shipping { id: ID! _id: Int! price: Float! discount_value: Float! label: String! }
- Name
paymentMethodLabel- Type
- String!
- Description
Payment method label.
- Name
financial_status- Type
- VariantSnapshotFinancialStatus
- Description
Payment financial status.
enum VariantSnapshotFinancialStatus { pending paid }
- Name
items- Label
[ProductVariantSnapshotOrOrderBumpSnapshot!]!- Description
Order items union type.
ProductVariantSnapshotOrOrderBumpSnapshot
- Label
VariantSnapshot- Description
- Label
OrderBumpSnapshot- Description
ProductVariantSnapshotOrOrderBumpSnapshot type can be either
or
union ProductVariantSnapshotOrOrderBumpSnapshot = VariantSnapshot | OrderBumpSnapshot
DiscountSnapshot
Fields
- Name
id- Type
- ID!
- Description
Unique identifier for the discount snapshot.
- Name
_id- Type
- Int!
- Description
Unique number identifier for the discount snapshot.
- Name
code- Type
- String
- Description
Discount snapshot code.
- Name
value- Type
- Float
- Description
Discount snapshot value.
- Name
discount_result- Type
- Float
- Description
Discount snapshot result.
- Name
type- Type
- DiscountType
- Description
Discount snapshot type.
enum DiscountType { percentage fixed }
- Name
updated_at- Label
TimeStamp!- Description
Timestamp of when the discount snapshot was updated.
- Name
created_at- Label
TimeStamp!- Description
Timestamp of when the discount snapshot was created.
Source
Fields
- Name
id- Type
- ID!
- Description
Unique identifier for the payment source.
- Name
_id- Type
- Int!
- Description
Unique number identifier for the payment source.
- Name
order- Label
Order!- Description
Payment source order.
- Name
payment_gateway- Label
PaymentGateway!- Description
Payment gateway.
- Name
updated_at- Label
TimeStamp!- Description
Timestamp of when the payment source was updated.
- Name
created_at- Label
TimeStamp!- Description
Timestamp of when the payment source was created.
VariantSnapshot
Fields
- Name
id- Type
- ID!
- Description
Unique identifier for the variant snapshot.
- Name
groupID- Type
- String!
- Description
Variant snapshot group id.
- Name
_id- Type
- Int!
- Description
Unique number identifier for the variant snapshot.
- Name
updated_at- Label
TimeStamp!- Description
Timestamp of when the variant snapshot was updated.
- Name
created_at- Label
TimeStamp!- Description
Timestamp of when the variant snapshot was created.
- Name
removed_at- Type
- TimeStamp
- Description
Timestamp of when the variant snapshot was removed.
- Name
title- Type
- String!
- Description
Variant snapshot title.
- Name
sku- Type
- String!
- Description
Variant snapshot sku.
- Name
image- Label
Image- Description
Variant snapshot image.
- Name
price- Type
- Float!
- Description
Variant snapshot price.
- Name
options- Type
- [OrderVariantOption!]!
- Description
Orderbump snapshot options.
type OrderVariantOption { id: String! label: String! value: String! }
- Name
tracking_number- Type
- String
- Description
Variant snapshot tracking number.
- Name
tracking_link- Type
- String
- Description
Variant snapshot tracking link.
- Name
carrier- Type
- String
- Description
Variant snapshot carrier.
- Name
payment_id- Type
- ID!
- Description
Variant snapshot payment id.
- Name
refund_id- Type
- ID
- Description
Variant snapshot refund id.
- Name
variant_id- Type
- ID
- Description
Variant snapshot variant id.
- Name
fulfillment_status- Type
- VariantSnapshotItemFulfillmentStatus!
- Description
Variant snapshot fulfillment status.
enum VariantSnapshotItemFulfillmentStatus { none fulfilled }
- Name
financial_status- Type
- VariantSnapshotFinancialStatus!
- Description
Variant snapshot financial status.
enum VariantSnapshotFinancialStatus { pending paid }
- Name
variant- Label
ProductVariant- Description
Variant snapshot product variant.
- Name
payment- Label
Payment!- Description
Variant snapshot payment.
- Name
customer_files- Type
- [CustomerFileGroup!]!
- Description
Variant snapshot customer files.
type CustomerFileGroup { name: String files: [CustomerFile!]! } type CustomerFile { path: String! key: String! }
- Name
custom_options- Type
- [VariantSnapshotCustomOption!]!
- Description
Variant customer options.
type VariantSnapshotCustomOption { key: String! name: String! type: CustomOptionType! files: [VariantSnapshotCustomOptionFile!] value: VariantSnapshotCustomOptionValue! } type VariantSnapshotCustomOptionFile { url: String } scalar VariantSnapshotCustomOptionValue
- Name
file- Label
File- Description
Variant snapshot file.
OrderBumpSnapshot
Fields
- Name
id- Type
- ID!
- Description
Unique identifier for the orderbump snapshot.
- Name
_id- Type
- Int!
- Description
Unique number identifier for the orderbump snapshot.
- Name
groupID- Type
- String!
- Description
Orderbump snapshot group id.
- Name
updated_at- Label
TimeStamp!- Description
Timestamp of when the orderbump snapshot was updated.
- Name
created_at- Label
TimeStamp!- Description
Timestamp of when the orderbump snapshot was created.
- Name
removed_at- Type
- TimeStamp
- Description
Timestamp of when the orderbump snapshot was removed.
- Name
title- Type
- String!
- Description
Orderbump snapshot title.
- Name
sku- Type
- String!
- Description
Orderbump snapshot sku.
- Name
image- Label
Image- Description
Orderbump snapshot image.
- Name
price- Type
- Float!
- Description
Orderbump snapshot price.
- Name
tracking_number- Type
- String
- Description
Orderbump snapshot tracking number.
- Name
tracking_link- Type
- String
- Description
Orderbump snapshot tracking link.
- Name
carrier- Type
- String
- Description
Orderbump snapshot carrier.
- Name
payment_id- Type
- ID!
- Description
Orderbump snapshot payment id.
- Name
refund_id- Type
- ID
- Description
Orderbump snapshot refund id.
- Name
product_id- Type
- ID!
- Description
Orderbump snapshot product id.
- Name
fulfillment_status- Type
- VariantSnapshotItemFulfillmentStatus
- Description
Orderbump snapshot fulfillment status.
enum VariantSnapshotItemFulfillmentStatus { none fulfilled }
- Name
financial_status- Type
- VariantSnapshotFinancialStatus!
- Description
Orderbump snapshot financial status.
enum VariantSnapshotFinancialStatus { pending paid }
- Name
product- Label
Product- Description
Orderbump snapshot product.
- Name
payment- Label
Payment!- Description
Orderbump snapshot payment.
- Name
file- Label
File- Description
Variant snapshot file.
Checkout
Fields
- Name
id- Type
- ID!
- Description
Unique identifier for the checkout.
- Name
_id- Type
- Int!
- Description
Unique number identifier for the checkout.
- Name
updated_at- Label
TimeStamp!- Description
Timestamp of when the checkout was updated.
- Name
created_at- Label
TimeStamp!- Description
Timestamp of when the checkout was created.
- Name
customer- Type
- CheckoutCustomer!
- Description
Checkout customer.
type CheckoutCustomer { first_name: String! last_name: String! full_name: String! email: Email! phone: Phone! accepts_marketing: Boolean! avatar: String! location: String! }
- Name
variants- Label
[CheckoutVariant!]!- Description
Checkout variants.
- Name
total- Type
- Float!
- Description
Checkout total.
- Name
discount_value- Type
- Float!
- Description
Checkout discount value.
- Name
subtotal- Type
- Float
- Description
Checkout subtotal.
- Name
email- Type
- String
- Description
Checkout email.
- Name
phone- Type
- String
- Description
Checkout phone.
- Name
step- Label
Step- Description
Checkout step.
- Name
link- Type
- String
- Description
Checkout link.
- Name
store- Label
Store- Description
Checkout store.
- Name
funnel- Label
Funnel- Description
Checkout funnel.
- Name
currency- Type
- String!
- Description
Checkout currency.
- Name
recovered- Type
- Boolean
- Description
Checkout recovered option.
- Name
shipping_address- Type
- CheckoutAddress
- Description
Checkout shipping address.
type CheckoutAddress { first_name: String! last_name: String! full_name: String! email: Email! phone: Phone! accepts_marketing: Boolean! avatar: String! location: String! }
- Name
billing_address- Type
- CheckoutAddress
- Description
Checkout billing address.
type CheckoutAddress { first_name: String! last_name: String! full_name: String! email: Email! phone: Phone! accepts_marketing: Boolean! avatar: String! location: String! }
CheckoutVariant
Fields
- Name
variant- Label
ProductVariant- Description
Checkout product variant.
- Name
quantity- Type
- Int!
- Description
Checkout variant quantity.
OrderConnection
Fields
- Name
pageInfo- Type
- PageInfo!
- Description
Order connection page info.
type PageInfo { hasNextPage: Boolean! hasPreviousPage: Boolean! startCursor: String endCursor: String }
- Name
edges- Type
- [OrderEdge]
- Description
The Order connection edges.
type OrderEdge { node: Order cursor: String! }