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 product.
- Name
_id- Type
- Int!
- Description
Unique number identifier for the product.
- Name
created_at- Type
- TimeStamp!
- Description
Timestamp of when the order was created.
- Name
archived_at- Type
- TimeStamp
- Description
Timestamp of when the order was archived.
- Name
cancelled_at- Type
- TimeStamp!
- Description
Timestamp of when the order was cancelled.
- Name
email- Type
- Email!
- Description
The customer email address.
scalar Email
- Name
phone- Type
- Phone!
- Description
The customer phone number.
scalar Phone
- Name
name- Type
- String!
- Description
The customer name.
- Name
notes- Type
- String
- Description
The order notes.
- Name
financial_status- Type
- OrderFinancialStatus
- Description
The order financial status.
enum OrderFinancialStatus { pending paid refunded partially_refunded }
- Name
fulfillment_status- Type
- OrderFulfillmentStatus
- Description
The order fulfillment status.
enum OrderFulfillmentStatus { unfulfilled fulfilled partial }
- Name
client_details- Type
- ClientDetails!
- Description
The customer device information.
type ClientDetails { ip: String device: String user_agent: String }
- Name
custom- Type
- CustomFields!
- Description
The order custom fields.
scalar CustomFields
- Name
tags- Type
- [String!]!
- Description
The order tags.
- Name
discount_value- Type
- Float!
- Description
The order discount value.
- Name
bundle_discount_value- Type
- Float!
- Description
The order bundle discount value.
- Name
normal_discount_value- Type
- Float!
- Description
The order normal discount value.
- Name
total- Type
- Float!
- Description
The order total cost.
- Name
shipping- Type
- Float!
- Description
The order shipping cost.
- Name
subtotal- Type
- Float!
- Description
The order subtotal.
- Name
payments- Label
[Payment!]!- Description
The order payments.
- Name
refunded_amount- Type
- Float!
- Description
The order refunded amount.
- Name
refundable- Type
- Float!
- Description
The order refundable amount.
- Name
net_payment- Type
- Float!
- Description
The order net payment amount.
- Name
paid_by_customer- Type
- Float!
- Description
The order amount paid by customer.
- Name
original_total- Type
- Float!
- Description
The order original total cost.
- Name
shipping_address- Label
Address- Description
The customer shipping address.
- Name
billing_address- Label
Address- Description
The customer billing address.
- Name
customer- Label
Customer!- Description
The customer details.
- Name
customer_full_name- Type
- String
- Description
The customer full name.
- Name
items- Type
- [ProductVariantSnapshotOrOrderBumpSnapshot!]!
- Description
The order items union type.
The ProductVariantSnapshotOrOrderBumpSnapshot type can be either
- Label
VariantSnapshot- Description
or
- Label
OrderBumpSnapshot- Description
- Name
checkout- Label
Checkout- Description
The order checkout details.
- Name
test- Type
- Boolean!
- Description
The order test option.
- Name
nextOrderID- Type
- Int
- Description
The next order id.
- Name
prevOrderID- Type
- Int
- Description
The previous order id.
- Name
link- Type
- String
- Description
The order link.
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
The order notes.
- Name
archived- Type
- Boolean
- Description
The archived option.
- Name
shipping_address- Label
Address- Description
The customer shipping address.
- Name
billing_address- Label
Address- Description
The customer billing address.
- Name
email- Type
- String
- Description
The customer email address.
- Name
phone- Type
- String
- Description
The customer phone number.
- Name
sync_customer_details- Type
- String
- Description
The order sync customer detail.
- Name
items- Type
- [LineItemIdentityInput!]
- Description
The order items.
input LineItemIdentityInput { type: LineItemIdentityType! id: Int! }
- Name
variants- Type
- [Int!]
- Description
The order variants.
- Name
custom- Type
- CustomFields
- Description
The order custom fields.
scalar CustomFields
- Name
tags- Type
- [String!]!
- Description
The 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- Type
- TimeStamp!
- Description
Timestamp of when the payment was updated.
- Name
created_at- Type
- TimeStamp!
- Description
Timestamp of when the payment was created.
- Name
discount_snapshot- Label
DiscountSnapshot- Description
The payment discount snapshot.
- Name
price_bundle_snapshot- Label
[PriceBundleSnapshot!]!- Description
The payment price bundle snapshot.
- Name
total- Type
- Float!
- Description
The payment total.
- Name
sub_total- Type
- Float!
- Description
The payment subtotal.
- Name
refunds- Type
- [Refund]
- Description
The payment refunds.
type Refund { id: ID! _id: Int! amount: Float reason: String }
- Name
refunded- Type
- Float!
- Description
The payment refunded amount.
- Name
refundable- Type
- Float!
- Description
The payment refundable amount.
- Name
paid- Type
- Float!
- Description
The payment paid amount.
- Name
paid_at- Type
- TimeStamp
- Description
Timestamp of when the payment was paid.
- Name
discount_value- Type
- Float!
- Description
The payment discount value.
- Name
source- Label
Source!- Description
The payment source.
- Name
shipping- Type
- Shipping!
- Description
The payment shipping information.
type Shipping { """The ID of an object""" id: ID! _id: Int! price: Float! label: String! }
- Name
paymentMethodLabel- Type
- String!
- Description
The payment method label.
- Name
financial_status- Type
- VariantSnapshotFinancialStatus
- Description
The payment financial status.
enum VariantSnapshotFinancialStatus { pending paid }
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
updated_at- Type
- TimeStamp!
- Description
Timestamp of when the discount snapshot was updated.
- Name
created_at- Type
- TimeStamp!
- Description
Timestamp of when the discount snapshot was created.
- Name
code- Type
- String
- Description
The discount snapshot code
- Name
value- Type
- Float
- Description
The discount snapshot value.
- Name
discount_result- Type
- Float
- Description
The discount snapshot result.
- Name
type- Type
- DiscountType
- Description
The discount snapshot type.
enum DiscountType { percentage fixed }
PriceBundleSnapshot
Fields
- Name
id- Type
- ID!
- Description
Unique identifier for the priceBundle snapshot.
- Name
value- Type
- Float!
- Description
The priceBundle snapshot value.
- Name
discount_result- Type
- Float
- Description
The priceBundle snapshot result.
- Name
label- Type
- String!
- Description
The priceBundle snapshot code
- Name
type- Type
- AllDiscountType
- Description
The priceBundle snapshot type.
enum AllDiscountType { percentage fixed item }
- Name
updated_at- Type
- TimeStamp!
- Description
Timestamp of when the priceBundle snapshot was updated.
- Name
created_at- Type
- TimeStamp!
- Description
Timestamp of when the priceBundle 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
The payment source order.
- Name
payment_gateway- Label
PaymentGateway!- Description
The payment gateway.
- Name
updated_at- Type
- TimeStamp!
- Description
Timestamp of when the payment source was updated.
- Name
created_at- Type
- TimeStamp!
- Description
Timestamp of when the payment source was created.
VariantSnapshot
Fields
- Name
id- Type
- ID!
- Description
Unique identifier for the variant snapshot.
- Name
_id- Type
- Int!
- Description
Unique number identifier for the variant snapshot.
- Name
updated_at- Type
- TimeStamp!
- Description
Timestamp of when the variant snapshot was updated.
- Name
created_at- Type
- 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
groupID- Type
- String!
- Description
The variant snapshot group id.
- Name
title- Type
- String!
- Description
The variant snapshot title.
- Name
sku- Type
- String!
- Description
The variant snapshot sku.
- Name
image- Label
Image- Description
The variant snapshot image.
- Name
price- Type
- Float!
- Description
The variant snapshot price.
- Name
tracking_number- Type
- String
- Description
The variant snapshot tracking number.
- Name
tracking_link- Type
- String
- Description
The variant snapshot tracking link.
- Name
carrier- Type
- String
- Description
The variant snapshot carrier.
- Name
payment_id- Type
- Int!
- Description
The variant snapshot payment id.
- Name
refund_id- Type
- Int
- Description
The variant snapshot refund id.
- Name
variant_id- Type
- Int
- Description
The variant snapshot variant id.
- Name
fullfillment_status (typo here)- Type
- VariantSnapshotItemFulfillmentStatus
- Description
The variant snapshot fulfillment status.
enum VariantSnapshotItemFulfillmentStatus { none fulfilled }
- Name
financial_status- Type
- VariantSnapshotFinancialStatus
- Description
The variant snapshot fulfillment status.
enum VariantSnapshotFinancialStatus { pending paid }
- Name
variant- Label
ProductVariant- Description
The variant snapshot product variant.
- Name
payment- Label
Payment!- Description
The variant snapshot payment.
- Name
customer_files- Type
- [CustomerFileGroup!]!
- Description
The variant snapshot customer files.
type CustomerFileGroup { name: String files: [CustomerFile!]! } type CustomerFile { path: String! key: String! }
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
updated_at- Type
- TimeStamp!
- Description
Timestamp of when the orderbump snapshot was updated.
- Name
created_at- Type
- 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
groupID- Type
- String!
- Description
The orderbump snapshot group id.
- Name
title- Type
- String!
- Description
The orderbump snapshot title.
- Name
sku- Type
- String!
- Description
The orderbump snapshot sku.
- Name
image- Label
Image- Description
The orderbump snapshot image.
- Name
price- Type
- Float!
- Description
The orderbump snapshot price.
- Name
tracking_number- Type
- String
- Description
The orderbump snapshot tracking number.
- Name
tracking_link- Type
- String
- Description
The orderbump snapshot tracking link.
- Name
carrier- Type
- String
- Description
The orderbump snapshot carrier.
- Name
payment_id- Type
- Int!
- Description
The orderbump snapshot payment id.
- Name
refund_id- Type
- Int
- Description
The orderbump snapshot refund id.
- Name
order_id- Type
- Int!
- Description
The orderbump snapshot order id.
- Name
product_id- Type
- Int
- Description
The orderbump snapshot product id.
- Name
fulfillment_status- Type
- VariantSnapshotItemFulfillmentStatus
- Description
The orderbump snapshot fulfillment status.
enum VariantSnapshotItemFulfillmentStatus { none fulfilled }
- Name
financial_status- Type
- VariantSnapshotFinancialStatus
- Description
The orderbump snapshot fulfillment status.
enum VariantSnapshotFinancialStatus { pending paid }
- Name
product- Label
Product- Description
The orderbump snapshot product.
- Name
payment- Label
Payment!- Description
The orderbump snapshot payment.
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- Type
- TimeStamp!
- Description
Timestamp of when the checkout was updated.
- Name
created_at- Type
- TimeStamp!
- Description
Timestamp of when the checkout was created.
- Name
customer- Type
- CheckoutCustomer!
- Description
The 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- Type
- [CheckoutVariant!]!
- Description
The checkout variants.
type CheckoutVariant { variant: ProductVariant quantity: Int! }
- Name
total- Type
- Float!
- Description
The checkout total.
- Name
discount_value- Type
- Float!
- Description
The checkout total.
- Name
subtotal- Type
- Float
- Description
The checkout total.
- Name
email- Type
- String
- Description
The checkout total.
- Name
phone- Type
- String
- Description
The checkout total.
- Name
step- Label
Step- Description
The checkout step.
- Name
link- Type
- String
- Description
The checkout link.
- Name
emails_sent- Type
- Int
- Description
The checkout emails sent.
- Name
recovered- Type
- Boolean
- Description
The checkout recovered option.
- Name
shipping_address- Type
- CheckoutAddress
- Description
The checkout shipping address.
type CheckoutAddress { line1: String line2: String city: String area: String country: String first_name: String last_name: String zip: String state: String email: String phone: String }
- Name
billing_address- Type
- CheckoutAddress
- Description
The checkout billing address.
type CheckoutAddress { line1: String line2: String city: String area: String country: String first_name: String last_name: String zip: String state: String email: String phone: String }
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! }