Order types

Unique identifier for the Order.

Unique number identifier for the Order.

A unique number identifier representing the account that received the order.

Timestamp of when the order was updated.

Timestamp of when the order was created.

Timestamp of when the order was archived.

Timestamp of when the order was cancelled.

The email address associated with the customer.

scalar Email

The phone number associated with the customer.

scalar Phone

A human-readable identifier for the order, typically formatted as a stringified number with a # prefix (e.g., #120).

Optional notes or comments associated with the order. This field can store additional information or instructions related to the order, such as special requests from the customer or internal notes for order handling.

The current financial status of the order. This field indicates the payment state of the order and is represented by the OrderFinancialStatus enum. Possible values include:

enum OrderFinancialStatus {
	pending
	paid
	refunded
	partially_refunded
}

The current fulfillment status of the order, indicating how much of the order has been fulfilled or shipped. This field is represented by the OrderFulfillmentStatus enum, with the following possible values:

enum OrderFulfillmentStatus {
	unfulfilled
	fulfilled
	partial
}

Information about the customer's client (device and browser) used to place the order. This field is represented by the ClientDetails type, which includes the following properties:

type ClientDetails {
	ip: String!
	device: String
	user_agent: String
}

A set of custom fields associated with the order. These fields allow for the storage of additional, order-specific data beyond the predefined fields in the API. The CustomFields scalar type represents a flexible structure, which can hold custom key-value pairs or other metadata relevant to the order.

scalar CustomFields

A list of tags associated with the order. Tags are used to categorize or label orders for easier filtering and organization. Each tag is a non-null string, and the list itself cannot be empty.

The total monetary value of discounts applied to the order. This value represents the amount subtracted from the original order total due to bundle discounts, coupon codes, or other discount mechanisms. The discount is expressed as a floating-point number, typically in the order’s currency.

The total monetary value of discounts specifically applied to bundled products within the order. This value reflects the discount provided when multiple products are purchased together as part of a bundle promotion. It is expressed as a floating-point number, typically in the currency of the order.

The total monetary value of standard discounts applied to the order, typically through the use of coupon codes. This value represents the coupon code discount amount subtracted from the order total and is expressed as a floating-point number, usually in the currency of the order.

The final total cost of the order, after applying all discounts, taxes, and shipping fees. This value represents the amount the customer is required to pay and is expressed as a floating-point number in the currency of the order.

The total cost of shipping for the order. This value represents the amount charged for delivering the products to the customer, expressed as a floating-point number in the currency of the order. It includes any applicable shipping fees based on the chosen shipping method.

The subtotal cost of the order, representing the total price of all items before applying any discounts, taxes, or shipping fees. This value is expressed as a floating-point number in the currency of the order.

A list of payments associated with the order. An order can have multiple payments, such as the initial payment and additional payments for upsells or post-purchase modifications. Each payment is represented by the Payment object, detailing the amount, method, and other relevant payment information.

The total monetary amount that has been refunded for the order. This value represents the portion of the order's total that has been returned to the customer, whether through full or partial refunds, and is expressed as a floating-point number in the order's currency.

The total amount of the order that is still eligible for a refund. This value is calculated as the difference between the total payment amount and the refunded amount. It is expressed as a floating-point number in the order's currency.

The net payment amount for the order, calculated as the total payment received minus any refunded amounts. This value represents the final amount the merchant retains after processing refunds, expressed as a floating-point number in the order's currency.

The total amount of money paid by the customer for the order. This value includes any payments made for the order, including the initial payment and any additional payments, such as for upsells or shipping costs. It is expressed as a floating-point number in the currency of the order.

The original total cost of the order before any discounts, refunds, or adjustments are applied. This value represents the full amount of the order as initially calculated, including all items, taxes, and shipping fees, and is expressed as a floating-point number in the currency of the order.

The shipping address provided by the customer for the order. This address specifies where the order will be delivered and includes details such as the recipient's name, street address, city, state or region, postal code, and country.

The billing address associated with the customer’s payment method. This address is used for invoicing and payment verification purposes and typically includes details such as the customer’s name, street address, city, state or region, postal code, and country.

The details of the customer who placed the order. This field contains information such as the customer’s name, contact information (email, phone) etc.

The full name of the customer who placed the order, typically including both first and last names. This value is used for identification and communication purposes in order processing and customer service interactions.

A list of items included in the order, represented as a union of either ProductVariantSnapshot or OrderBumpSnapshot. Each item in this list can be a product variant selected by the customer or an order bump item. This structure allows flexibility in representing different types of items within a single order.

Details related to the order's checkout process. The Checkout object provides a snapshot of the final steps the customer took to complete the purchase.

A flag indicating whether the order is a test transaction. If set to true, the order is considered a test and does not represent a real transaction. This is typically used for testing and development purposes to simulate order creation without processing actual payments.

The unique identifier for the next sequential order related to this transaction. This field can be used to track or reference follow-up orders. If there is no subsequent order, this field may be null.

The unique identifier of the previous order related to this transaction. This field can be used to reference any prior order in a sequence. If this is the first order, this field will be null.

The URL link to the order's thank-you page. This page is typically displayed to the customer after the order has been successfully completed. The link provides a reference for the customer to review their order details and confirmation.

The currency in which the order is priced and processed. This value is represented by a currency code following the ISO 4217 standard (e.g., "USD" for US Dollars, "EUR" for Euros). It defines the monetary unit for all prices, payments, and refunds associated with the order.

A list of UTM (Urchin Tracking Module) parameters associated with the order, used for tracking the source of traffic or marketing campaigns that led to the purchase. Each Utm object contains the following fields:

type Utm {
	v: String!
	k: String!
	id: String!
}

Optional notes or comments to be attached to the order. This field allows users to provide additional information, special instructions, or internal comments when creating or updating an order. The content is flexible and can be used for various purposes, such as customer preferences or handling instructions.

A flag indicating whether the order should be marked as archived. When set to true, the order is moved to an archived state, typically used for organizing or filtering completed or inactive orders.

The customer’s shipping address. This field includes the full details required for order delivery, such as the recipient’s name, street address, city, state or region, postal code, and country. The address is essential for shipping and fulfillment purposes.

The billing address associated with the customer's payment method. This address is used for payment processing and verification, and should include full details such as the customer’s name, street address, city, state or region, postal code, and country.

The email address of the customer placing the order. It must be a valid email format, ensuring successful delivery of important order information.

The customer's phone number, used for contact regarding the order. It should be provided in a valid format, including the appropriate country code if applicable.

A flag indicating whether to synchronize and override the customer details with updated information. When set to true, the existing customer information on the order will be replaced with the latest details provided.

A list of IDs representing the items included in the order. Each ID can refer to a product variant or an order bump, allowing flexibility in what can be included in the order. This field is required when updating an order, and it supports both regular items and upsell (order bump) items.

A list of variant number ids associated with the products in the order. This field is used to specify which product variants the customer has selected as part of the order.

Custom fields associated with the order, allowing the storage of additional, user-defined data beyond the predefined fields. The CustomFields scalar type is flexible and can hold custom key-value pairs or other metadata relevant to the order, providing room for extra information based on business needs.

scalar CustomFields

A list of tags associated with the order. Tags are used to categorize or label orders for easier filtering, organization, or tracking. Each tag is a non-null string.

Unique identifier for the payment.

Unique number identifier for the payment.

Timestamp of when the payment was updated.

Timestamp of when the payment was created.

A snapshot of the discount applied to the payment at the time of transaction. This includes details of the promotional code, discount type etc.

A list of snapshots representing bundled pricing and discounts applied to the payment at the time of the transaction. Each snapshot captures the details of a pricing bundle, such as the applied discount, bundle value, and type of discount used. This field provides a historical record of the price bundle at the time of payment.

The total amount paid for the order, including any applied discounts, and shipping fees. This value represents the final sum charged to the customer for the transaction and is expressed as a floating-point number in the currency of the order.

The subtotal amount for the payment, representing the total cost of the items before any discounts, or shipping fees are applied. This value reflects the base price of the order and is expressed as a floating-point number in the currency of the order.

A list of refunds associated with the payment. Each refund represents a partial or full return of funds to the customer for this transaction. This field provides details on all refund actions taken for the payment.

type Refund {
	id: ID!
	_id: Int!
	amount: Float!
	reason: String
}

The total amount that has been refunded for the payment. This value represents the sum of all refunds issued for the transaction, expressed as a floating-point number in the currency of the order. It reflects the portion of the payment returned to the customer.

The total amount of the payment that is still eligible for a refund. This value is calculated as the difference between the total payment amount and the refunded amount. It is expressed as a floating-point number in the order's currency.

The total amount successfully paid by the customer for the transaction. This value represents the actual funds received, excluding any refunds, and is expressed as a floating-point number in the currency of the order.

The timestamp when the payment was successfully made.

The total monetary value of discounts applied to the payment. This includes all promotions, coupon codes, or special offers that reduced the overall amount paid by the customer. The discount is expressed as a floating-point number in the currency of the order.

The source of the payment, providing details about how the payment was processed and through which system. The Source type contains information such as the order, payment gateway, and relevant timestamps for tracking the source of the payment.

Information about the shipping details associated with the payment, including the shipping cost, any applicable discounts, and the shipping label. This field provides an overview of how the order’s shipping was handled as part of the payment process.

type Shipping {
	id: ID!
	_id: Int!
	price: Float!
	discount_value: Float!
	label: String!
}

A label describing the payment method used for the transaction. This provides a user-friendly name for the payment method, such as "Stripe," or "PayPal," helping to identify how the payment was processed.

The financial status of the payment, indicating the current state of the transaction. The status is represented by the VariantSnapshotFinancialStatus enum, with the following possible values:

enum VariantSnapshotFinancialStatus {
	pending
	paid
}

A list of items associated with the payment, represented as a union of either ProductVariantSnapshot or OrderBumpSnapshot. Each item reflects a product variant or an order bump that was part of the transaction paid for.

Unique identifier for the discount snapshot.

Unique number identifier for the discount snapshot.

The discount code applied at the time of the transaction. This code represents a specific promotional offer or coupon that was used to reduce the total payment amount. It may be a string of characters or numbers that the customer entered during checkout to receive the discount.

The exact value of the discount associated with the discount code. This value can represent either a fixed amount or a percentage, depending on the type of discount applied. It reflects the user-defined discount that reduces the total payment amount.

The actual discount amount applied to the payment, calculated based on the discount type. For example, if the discount is a percentage, this field returns the computed value after applying the percentage to the order total.

The type of discount applied, indicating whether the discount is a fixed amount or a percentage of the total. The DiscountType enum has two possible values:

enum DiscountType {
	percentage
	fixed
}

Timestamp of when the discount snapshot was updated.

Timestamp of when the discount snapshot was created.

Unique identifier for the payment source.

Unique number identifier for the payment source.

The order associated with this payment source. This field links the payment source to the corresponding Order object, providing context on which order the payment was made for.

The payment gateway used to process the transaction. This field references the PaymentGateway object, detailing the specific service or platform (e.g., Stripe, PayPal) that facilitated the payment.

Timestamp of when the payment source was updated.

Timestamp of when the payment source was created.

Unique identifier for the variant snapshot.

A string that references the actual variant number ID in the format VariantSnapshot:variant_id (e.g., VariantSnapshot:1856).

Unique number identifier for the variant snapshot.

Timestamp of when the variant snapshot was updated.

Timestamp of when the variant snapshot was created.

Timestamp of when the variant snapshot was removed.

The title or name of the product variant at the time the snapshot was taken. This field captures the product’s title as it appeared during the transaction, ensuring consistency even if the product title changes later.

The SKU (Stock Keeping Unit) of the product variant at the time the snapshot was taken. The sku is a unique identifier used for inventory management and tracking, preserving the specific SKU value during the transaction.

The image of the product variant as it appeared at the time the snapshot was taken. This field stores the reference to the product image used during the transaction, ensuring that the visual representation of the variant is preserved, even if the product image changes later.

The price of the product variant at the time the snapshot was taken. This field captures the exact price during the transaction, ensuring that the price remains consistent for historical records, even if the product price is updated later.

A list of options for the product variant at the time the snapshot was taken. Each option represents a specific configuration or customization of the variant, such as size or color. The structure is defined by the OrderVariantOption type, which includes:

type OrderVariantOption {
	id: String!
	label: String!
	value: String!
}

The tracking number associated with the shipment of the product variant at the time the snapshot was taken. This field captures the shipping tracking number if applicable, providing a reference for tracking the delivery of the variant.

The URL link for tracking the shipment of the product variant. This field provides a direct link to the carrier's tracking page, allowing real-time updates on the delivery status of the variant at the time the snapshot was taken.

The name of the shipping carrier responsible for delivering the product variant at the time the snapshot was taken. This field identifies the carrier (e.g., "FedEx," "UPS," "DHL") associated with the shipment, providing context for tracking and delivery.

The unique identifier for the payment associated with the product variant at the time the snapshot was taken. This field links the variant to the corresponding payment, allowing for tracking and reference of the transaction details.

The unique identifier for the refund associated with the product variant, if applicable. This field links the variant to a specific refund transaction, allowing for tracking and reference of any refunds issued for the variant. It may be null if no refund is associated.

The unique identifier for the product variant at the time the snapshot was taken. This field links the snapshot to the specific product variant, allowing for tracking and reference to the original variant, even if changes are made later.

The fulfillment status of the product variant at the time the snapshot was taken. This field indicates whether the variant has been fulfilled (shipped) or not. The VariantSnapshotItemFulfillmentStatus enum has the following values:

enum VariantSnapshotItemFulfillmentStatus {
	none
	fulfilled
}

The financial status of the product variant at the time the snapshot was taken. This field indicates the current payment status for the variant. The VariantSnapshotFinancialStatus enum has the following values:

enum VariantSnapshotFinancialStatus {
	pending
	paid
}

A reference to the current ProductVariant object, if it still exists. This field links the snapshot to the active product variant, allowing developers to retrieve up-to-date details about the variant, even after the snapshot was taken. If the variant has been deleted or modified, the snapshot still retains historical data, but this reference will point to the actual variant in the system, if available.

A reference to the Payment object associated with the variant snapshot. This field links the variant to the specific payment made for it, allowing developers to retrieve details about the transaction, such as payment method, total amount, and any related refunds.

Variant snapshot customer files.

type CustomerFileGroup {
	name: String
	files: [CustomerFile!]!
}

type CustomerFile {
	path: String!
	key: String!
}

Variant customer options.

type VariantSnapshotCustomOption {
	key: String!
	name: String!
	type: CustomOptionType!
	files: [VariantSnapshotCustomOptionFile!]
	value: VariantSnapshotCustomOptionValue!
}

type VariantSnapshotCustomOptionFile {
	url: String
}

scalar VariantSnapshotCustomOptionValue

Variant snapshot file.

Unique identifier for the orderbump snapshot.

Unique number identifier for the orderbump snapshot.

A string that references the actual order bump group ID in the format OrderBumpSnapshot:order_bump_id (e.g., OrderBumpSnapshot:1234).

Timestamp of when the orderbump snapshot was updated.

Timestamp of when the orderbump snapshot was created.

Timestamp of when the orderbump snapshot was removed.

The title or name of the order bump product at the time the snapshot was taken. This field captures the product's title as it appeared during the transaction, ensuring that the name is preserved, even if the product title changes later.

The SKU (Stock Keeping Unit) of the order bump product at the time the snapshot was taken. This unique identifier is used for tracking and inventory management, preserving the specific SKU used during the transaction, even if the product’s SKU changes later.

The image of the order bump product at the time the snapshot was taken. This field stores the reference to the product image used during the transaction, preserving the visual representation of the order bump product even if the image is changed later.

The price of the order bump product at the time the snapshot was taken. This field captures the exact price during the transaction, ensuring that the price is preserved for historical records, even if the product price is updated later.

The tracking number associated with the shipment of the order bump product at the time the snapshot was taken. This field provides a reference for tracking the delivery of the order bump product, if applicable.

The URL link for tracking the shipment of the order bump product. This field provides a direct link to the carrier’s tracking page.

The name of the shipping carrier responsible for delivering the order bump product at the time the snapshot was taken. This field identifies the carrier (e.g., "FedEx," "UPS," "DHL"), providing context for shipment tracking and delivery.

The unique identifier for the payment associated with the order bump snapshot. This field links the order bump product to the corresponding payment, allowing for tracking and reference of the transaction details.

The unique identifier for the refund associated with the order bump, if applicable. This field links the order bump product to a specific refund transaction, allowing for tracking and reference of any refunds issued. It may be null if no refund is associated with the order bump.

The unique identifier for the actual product associated with the order bump. This field links to the current product in the system, allowing for tracking and reference of the active product, even after the snapshot was taken.

The fulfillment status of the order bump product at the time the snapshot was taken. This field indicates whether the order bump product has been shipped or fulfilled.

enum VariantSnapshotItemFulfillmentStatus {
	none
	fulfilled
}

The financial status of the order bump product at the time the snapshot was taken. This field indicates the payment status for the order bump snapshot.

enum VariantSnapshotFinancialStatus {
	pending
	paid
}

A reference to the current Product object associated with the order bump. This field links the snapshot to the actual product in the system, allowing developers to retrieve up-to-date details about the product, even after the snapshot was taken.

A reference to the Payment object associated with the order bump snapshot. This field links the order bump product to the corresponding payment, allowing developers to track transaction details such as the payment method, total amount, and any associated refunds.

Variant snapshot file.

Unique identifier for the checkout.

Unique number identifier for the checkout.

Timestamp of when the checkout was updated.

Timestamp of when the checkout was created.

The customer information provided during the checkout process. This includes details such as the customer's name, contact information, and marketing preferences.

type CheckoutCustomer {
	first_name: String!
	last_name: String!
	full_name: String!
	email: Email!
	phone: Phone!
	accepts_marketing: Boolean!
	avatar: String!
	location: String!
}

A list of product variants included in the checkout. Each item in the list is represented by the CheckoutVariant object, which contains details about the specific variant of product selected by the customer during the checkout process.

The total cost of the checkout, including all products, shipping fees, and any applied discounts. This value represents the final amount the customer is required to pay and is expressed as a floating-point number in the currency of the checkout.

The total value of all discounts applied to the checkout. This amount reflects any coupons, or offers that reduced the overall cost of the checkout, expressed as a floating-point number in the currency of the checkout.

The subtotal amount of the checkout, representing the total cost of all items before applying discounts and shipping fees. This value is expressed as a floating-point number in the currency of the checkout.

The email address provided by the customer during the checkout process. This email is used for sending order confirmations, receipts, and any other communications related to the order.

The phone number provided by the customer during the checkout process. This number may be used for order-related communication, such as shipping updates or customer service inquiries.

The specific step or page in the checkout process where the checkout creation occurred.

The URL of the checkout page, including the pre-filled checkout form. This link can be used to revisit the checkout page with all customer information and order details already entered.

The store where the checkout was created. This field links to the Store object, providing information about the specific store associated with the checkout process.

The funnel where the checkout was created. This field links to the Funnel object, providing information about the specific funnel associated with the checkout process.

The currency in which the checkout is processed. This value is represented by a currency code (e.g., "USD" for US Dollars, "EUR" for Euros), determining the monetary unit for all prices, payments, and totals within the checkout.

A boolean flag indicating whether the checkout was successfully completed, meaning an order was created from this checkout. If true, it indicates the checkout resulted in a completed order; if false, no order was created from this checkout session.

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!
}

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!
}

A reference to the specific product variant included in the checkout. This field links the checkout variant to the corresponding ProductVariant object, allowing access to detailed information about the selected product variant

The quantity of the product variant selected in the checkout. This field specifies how many units of the variant the customer has chosen to purchase during the checkout process.

Order connection page info.

type PageInfo {
	hasNextPage: Boolean!
	hasPreviousPage: Boolean!
	startCursor: String
	endCursor: String
}

The Order connection edges.

type OrderEdge {
	node: Order
	cursor: String!
}