Orders

Queries

orderAttribution

A single OrderAttribution by ID

Arguments

• id (ID!) — The unique identifier of the OrderAttribution

Returns: OrderAttribution — A conversion linked to an Order & one or more Messages

orderAttributionsByIds

A list of OrderAttributions by IDs

Arguments

• ids ([ID!]!) — The IDs of the OrderAttributions

Returns: [OrderAttribution]! — A conversion linked to an Order & one or more Messages

searchOrderAttributions

Searches OrderAttributions

Arguments

• after (String) — A cursor to search after (only include first & after or last & before)
• before (String) — A cursor to search before (only include first & after or last & before)
• filters ([SearchFilterInput!]) — A set of filters to apply
• first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
• last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
• sortBy (SortOrderAttributionsBy) — The sort key
• sortDir (SortDirection) — The sort direction

Returns: OrderAttributionConnection! — A connection to a list of items.

Objects

IntegratedOrder

An order from an Integration

Fields

• assisted_by ([UserProfile]!) — The users that assisted with the IntegratedOrder — 🚧 Deprecated: Use data instead
• channel (String) — The order channel of the IntegratedOrder — 🚧 Deprecated: Use data instead
• created_at (DateTime!) — The date the IntegratedOrder was created
• customer (Customer) — The customer that placed the IntegratedOrder
• data (IntegratedOrderFields) — The associated data of the IntegratedOrder
• deleted_at (DateTime) — The date the IntegratedOrder was deleted
• discount_codes ([String!]!) — The discount codes of the IntegratedOrder — 🚧 Deprecated: Use data instead
• external_created_at (DateTime!) — The date the IntegratedOrder was created externally — 🚧 Deprecated: Use processed_at instead
• external_id (ID!) — The unique external identifier of the IntegratedOrder
• external_status (String) — The external status of the IntegratedOrder — 🚧 Deprecated: Use data instead
• fulfillments ([IntegratedOrderFulfillment!]!) — The fulfillments associated with the IntegratedOrder — 🚧 Deprecated: Use data instead
• id (ID) — The unique identifier of the IntegratedOrder
• integrated_customer (IntegratedCustomer) — The IntegratedCustomer that placed the IntegratedOrder
• integrated_location (IntegratedLocation!) — The location associated to the IntegratedOrder
• integrated_order_items (IntegratedOrderItemConnection!) — The items associated with the IntegratedOrder
• integrated_order_refunds (IntegratedOrderRefundConnection!) — The items associated with the IntegratedOrder
• integrated_refunds ([IntegratedOrderRefund!]!) — The refunds associated with the IntegratedOrder — 🚧 Deprecated: Use integrated_order_refunds instead
• integration (Integration!) — The integration associated with the IntegratedOrder
• legacy_id (ID!) — The unique legacy identifier of the IntegratedOrder
• note (String) — The note of the IntegratedOrder — 🚧 Deprecated: Use data instead
• number (String) — The order number of the IntegratedOrder — 🚧 Deprecated: Use data instead
• order_attribution (OrderAttribution) — The attribution of the IntegratedOrder
• processed_at (DateTime!) — The date the IntegratedOrder was processed
• processed_by (UserProfile) — The user that processed the IntegratedOrder — 🚧 Deprecated: Use data instead
• status (IntegratedOrderStatus!) — The status of the IntegratedOrder — 🚧 Deprecated: Use data instead
• subtotal_amount (Money!) — The subtotal amount of the IntegratedOrder — 🚧 Deprecated: Use data instead
• tags ([String!]!) — The tags of the IntegratedOrder — 🚧 Deprecated: Use data instead
• total_amount (Money!) — The total amount of the IntegratedOrder — 🚧 Deprecated: Use data instead
• total_discount_amount (Money!) — The total discount amount of the IntegratedOrder — 🚧 Deprecated: Use data instead
• total_shipping_amount (Money!) — The total shipping amount of the IntegratedOrder — 🚧 Deprecated: Use data instead
• total_tax_amount (Money!) — The total tax amount of the IntegratedOrder — 🚧 Deprecated: Use data instead
• updated_at (DateTime!) — The date the IntegratedOrder was updated

IntegratedOrderFields

The fields from an IntegratedOrder from an Integration

Fields

• assisted_by ([UserProfile]!) — The users that assisted with the IntegratedOrder
• channel (String) — The order channel of the IntegratedOrder
• discount_codes ([String!]!) — The discount codes of the IntegratedOrder
• external_status (String) — The external status of the IntegratedOrder
• fulfillments ([IntegratedOrderFulfillment!]!) — The fulfillments associated with the IntegratedOrder
• note (String) — The note of the IntegratedOrder
• number (String) — The order number of the IntegratedOrder
• processed_by (UserProfile) — The user that processed the IntegratedOrder
• status (IntegratedOrderStatus!) — The status of the IntegratedOrder
• subtotal_amount (Money!) — The subtotal amount of the IntegratedOrder
• tags ([String!]!) — The tags of the IntegratedOrder
• total_amount (Money!) — The total amount of the IntegratedOrder
• total_discount_amount (Money!) — The total discount amount of the IntegratedOrder
• total_shipping_amount (Money!) — The total shipping amount of the IntegratedOrder
• total_tax_amount (Money!) — The total tax amount of the IntegratedOrder

IntegratedOrderFulfillment

A fulfillment of an IntegratedOrder

Fields

• line_item_ids ([ID!]!) — The line item ids of the IntegratedOrderFulfillment
• shipment_status (IntegratedOrderFulfillmentShipmentStatus!) — The shipment status of the IntegratedOrderFulfillment
• status (IntegratedOrderFulfillmentStatus!) — The status of the IntegratedOrderFulfillment
• tracking_company (String) — The tracking company of the IntegratedOrderFulfillment
• tracking_numbers ([String!]!) — The tracking numbers of the IntegratedOrderFulfillment
• tracking_urls ([URL!]!) — The tracking numbers of the IntegratedOrderFulfillment

IntegratedOrderItem

An order item from an Integration

Fields

• created_at (DateTime!) — The date the IntegrationOrderItem was created
• data (IntegratedOrderItemFields) — The associated data of the IntegrationOrderItem
• legacy_id (ID!) — The unique identifier of the IntegrationOrderItem
• line_item_id (String) — The line item id of the IntegrationOrderItem — 🚧 Deprecated: Use data instead
• product (Product) — The associated product of the IntegrationOrderItem
• product_variant (ProductVariant) — The associated product of the IntegrationOrderItem
• quantity (Int!) — The quantity of the IntegrationOrderItem — 🚧 Deprecated: Use data instead
• sku (String) — The sku of the IntegrationOrderItem — 🚧 Deprecated: Use data instead
• title (String) — The title of the IntegrationOrderItem — 🚧 Deprecated: Use data instead
• updated_at (DateTime!) — The date the IntegrationOrderItem was updated
• vendor (String) — The vendor of the IntegrationOrderItem — 🚧 Deprecated: Use data instead

IntegratedOrderItemConnection

A connection to a list of items.

Fields

• edges ([IntegratedOrderItemEdge]) — A list of edges.
• pageInfo (PageInfo!) — Information to aid in pagination.

IntegratedOrderItemEdge

An edge in a connection.

Fields

• cursor (String!) — A cursor for use in pagination
• node (IntegratedOrderItem) — The item at the end of the edge

IntegratedOrderItemFields

The fields from an IntegratedItem from an Integration

Fields

• line_item_id (ID) — The line item id of the IntegrationOrderItem
• line_item_product_id (ID) — The product id of the IntegrationOrderItem
• line_item_product_variant_id (ID) — The product variant id of the IntegrationOrderItem
• options ([IntegratedOrderItemOption!]!) — The options of the IntegratedOrderItem
• quantity (Int!) — The quantity of the IntegrationOrderItem
• sku (String) — The sku of the IntegrationOrderItem
• title (String) — The title of the IntegrationOrderItem
• vendor (String) — The vendor of the IntegrationOrderItem

IntegratedOrderItemOption

Fields

• key (ID!) — The key of the IntegratedOrderItemOption
• values ([String!]!) — The values of the IntegratedOrderItemOption

IntegratedOrderRefund

An order refund from an Integration

Fields

• created_at (DateTime!) — The date the IntegrationOrderRefund was created
• data (IntegratedOrderRefundFields) — The associated data of the IntegrationOrderRefund
• legacy_id (ID!) — The unique identifier of the IntegrationOrderRefund
• line_item_ids ([ID!]!) — The line item ids of the IntegrationOrderRefund — 🚧 Deprecated: Use data instead
• refund_amount (Money!) — The total discount amount of the IntegrationOrder — 🚧 Deprecated: Use data instead
• updated_at (DateTime!) — The date the IntegrationOrderRefund was updated

IntegratedOrderRefundConnection

A connection to a list of items.

Fields

• edges ([IntegratedOrderRefundEdge]) — A list of edges.
• pageInfo (PageInfo!) — Information to aid in pagination.

IntegratedOrderRefundEdge

An edge in a connection.

Fields

• cursor (String!) — A cursor for use in pagination
• node (IntegratedOrderRefund) — The item at the end of the edge

IntegratedOrderRefundFields

The fields from an IntegratedRefund from an Integration

Fields

• line_item_ids ([ID!]!) — The line item ids of the IntegrationOrderRefund
• refund_amount (Money!) — The total discount amount of the IntegrationOrderRefund

OrderAttribution

A conversion linked to an Order & one or more Messages

Fields

• attributable_amount_absolute (Money!) — The total purchase amount attributed to the OrderAttribution
• converted_at (DateTime!) — The date of the Order
• created_at (DateTime!) — The date the OrderAttribution was created
• currency (Currency!) — The currency of the OrderAttribution
• deleted_at (DateTime) — The date the OrderAttribution was deleted
• discount_codes ([String!]!) — The discount codes associated to the Order — 🚧 Deprecated: Use the integrated_order instead
• discounts_absolute (Money!) — The total discount value of the Order — 🚧 Deprecated: Use the integrated_order instead
• external_id (ID!) — The external unique identifier of the Order — 🚧 Deprecated: Use the integrated_order instead
• id (ID!) — The unique identifier of the OrderAttribution
• integrated_order (IntegratedOrder) — The IntegratedOrder of the OrderAttribution
• manually_excluded_at (DateTime) — The date the OrderAttribution was manually excluded
• message_attributions ([MessageAttribution!]!) — The MessageAttributions attributed to the OrderAttribution
• order_number (String) — The order number of the OrderAttribution — 🚧 Deprecated: Use the integrated_order instead
• order_source (String) — The order source of the OrderAttribution — 🚧 Deprecated: Use the integrated_order instead
• shipping_absolute (Money!) — The total shipping value of the Order — 🚧 Deprecated: Use the integrated_order instead
• status (OrderAttributionStatus!) — The order status of the OrderAttribution
• subtotal_absolute (Money!) — The subtotal value of the Order — 🚧 Deprecated: Use the integrated_order instead
• tags ([String!]!) — The tags associated to the Order — 🚧 Deprecated: Use the integrated_order instead
• tax_absolute (Money!) — The total tax value of the Order — 🚧 Deprecated: Use the integrated_order instead
• total_absolute (Money!) — The total value of the Order — 🚧 Deprecated: Use the integrated_order instead
• total_refund_absolute (Money!) — The total refund value of the Order — 🚧 Deprecated: Use the integrated_order instead
• updated_at (DateTime!) — The date the OrderAttribution was last updated

OrderAttributionConnection

A connection to a list of items.

Fields

• edges ([OrderAttributionEdge]) — A list of edges.
• pageInfo (PageInfo!) — Information to aid in pagination.

OrderAttributionEdge

An edge in a connection.

Fields

• cursor (String!) — A cursor for use in pagination
• node (OrderAttribution) — The item at the end of the edge

Input Objects

ExternalOrderChannelInput

An ExternalOrderChannel to be added/updated

Fields

• id (ID!) — The id of the ExternalOrderChannel
• label (String) — The label of the ExternalOrderChannel
• type (ExternalOrderChannelType!) — The type of the ExternalOrderChannel

ExternalOrderFulfillmentInput

Fields

• order_item_ids ([ID!]) — The unique identifiers of the ExternalOrderItems of the ExternalOrderFulfillment
• shipment_status (ExternalOrderFulfillmentShipmentStatus!) — The shipment status of the ExternalOrderFulfillment
• status (ExternalOrderFulfillmentStatus!) — The status of the ExternalOrderFulfillment
• tracking_company (String!) — The tracking company of the ExternalOrderFulfillment
• tracking_numbers ([String!]!) — The tracking numbers of the ExternalOrderFulfillment
• tracking_urls ([URL!]!) — The tracking URLs of the ExternalOrderFulfillment

ExternalOrderInput

An ExternalOrder to be added/updated

Fields

• assisted_by_user_ids ([ID!]) — The unique identifiers of the ExternalUsers assisting the ExternalOrder
• cancelled_at (DateTime) — The date the ExternalOrder was cancelled
• channel (ExternalOrderChannelInput!) — The channel of the ExternalOrder
• created_at (DateTime) — The date the ExternalOrder was created
• currency (Currency!) — The currency of the ExternalOrder
• customer_id (ID) — The unique identifier of the ExternalCustomer associated with the ExternalOrder
• deleted_at (DateTime) — The date the ExternalOrder was deleted
• discount_codes ([String!]) — The discount codes to associate to the ExternalOrder
• fulfillments_lines ([ExternalOrderFulfillmentInput!]) — The ExternalOrderFulfillments associated to the ExternalOrder
• id (ID!) — The unique identifier of the ExternalOrder
• location_id (ID!) — The unique identifier of the ExternalLocation associated with the ExternalOrder
• number (String!) — The order number of the ExternalOrder
• processed_at (DateTime!) — The date the ExternalOrder was processed
• processed_by_user_id (ID) — The unique identifier of the ExternalUser that processed the ExternalOrder
• subtotal_amount (MoneyInput!) — The subtotal amount of the ExternalOrder
• tags ([String!]) — Tags to associate to the ExternalOrder
• total_amount (MoneyInput!) — The total amount of the ExternalOrder
• total_discount_amount (MoneyInput!) — The total discount amount of the ExternalOrder
• total_shipping_amount (MoneyInput!) — The total shipping amount of the ExternalOrder
• total_tax_amount (MoneyInput!) — The total tax amount of the ExternalOrder
• updated_at (DateTime) — The date the ExternalOrder was last updated

ExternalOrderItemInput

An ExternalOrderItem to be added/updated

Fields

• created_at (DateTime) — The date the ExternalOrderItem was created
• deleted_at (DateTime) — The date the ExternalOrderItem was deleted
• id (ID!) — The unique identifier of the ExternalOrderItem
• order_id (ID!) — The unique identifier of the ExternalOrder associated with the ExternalOrderItem
• product_gid (ID) — The globally unique identifier of the ExternalProduct associated with the ExternalOrderItem. Use this field if you want to pass an ID from a different integration.
• product_id (ID) — The unique identifier of the ExternalProduct associated with the ExternalOrderItem. Use this field if you want to pass an ID from the same integration.
• product_variant_gid (ID) — The globally unique identifier of the ExternalProductVariant associated with the ExternalOrderItem. Use this field if you want to pass an ID from a different integration.
• product_variant_id (ID) — The unique identifier of the ExternalProductVariant associated with the ExternalOrderItem. Use this field if you want to pass an ID from the same integration.
• quantity (PositiveInt!) — The quantity of the ExternalOrderItem
• sku (String) — The SKU of the ExternalOrderItem
• subtotal_amount (MoneyInput!) — The subtotal amount of the ExternalOrderItem
• title (String) — The title of the ExternalOrderItem
• total_discount_amount (MoneyInput!) — The total discount amount of the ExternalOrderItem
• total_tax_amount (MoneyInput!) — The total tax amount of the ExternalOrderItem
• updated_at (DateTime) — The date the ExternalOrderItem was last updated
• vendor (String) — The vendor of the ExternalOrderItem

ExternalRefundInput

An ExternalRefund to be added/updated

Fields

• created_at (DateTime) — The date the ExternalRefund was created
• deleted_at (DateTime) — The date the ExternalRefund was deleted
• id (ID!) — The unique identifier of the ExternalRefund
• original_order_id (ID!) — The unique identifier of the original ExternalOrder associated with the ExternalRefund
• original_order_item_id (ID) — The unique identifier of the original ExternalRefund associated with the ExternalRefund
• processed_at (DateTime) — The date the ExternalRefund was created
• product_gid (ID) — The globally unique identifier of the ExternalProduct associated with the ExternalRefund. Use this field if you want to pass an ID from a different integration.
• product_id (ID) — The unique identifier of the ExternalProduct associated with the ExternalRefund. Use this field if you want to pass an ID from the same integration.
• product_variant_gid (ID) — The globally unique identifier of the ExternalProductVariant associated with the ExternalRefund. Use this field if you want to pass an ID from a different integration.
• product_variant_id (ID) — The unique identifier of the ExternalProductVariant associated with the ExternalRefund. Use this field if you want to pass an ID from the same integration.
• quantity (PositiveInt!) — The quantity of the ExternalRefund
• subtotal_amount (MoneyInput!) — The subtotal amount of the ExternalRefund
• total_tax_amount (MoneyInput!) — The total tax amount of the ExternalRefund
• updated_at (DateTime) — The date the ExternalRefund was last updated

Enums

ExternalOrderChannelType

Values

• CUSTOM
• MOBILE_APP
• POS
• WEB

ExternalOrderFulfillmentShipmentStatus

Values

• DELIVERED — The shipment has been delivered
• FAILED — The shipment has failed to be completed
• IN_TRANSIT — The shipment is in transit
• NOT_TRACKED — The shipment is not being tracked
• PENDING — The shipment is awaiting other actions before it can begin
• READY_FOR_PICKUP — The shipment is ready for pickup

ExternalOrderFulfillmentStatus

Values

• CANCELLED — The fulfillment was cancelled
• FULFILLED — The fulfillment has been completed
• NOT_TRACKED — The fulfillment is not being tracked
• OPEN — The fulfillment is being processed
• PENDING — The fulfillment is awaiting other actions being taken before it can begin processing

IntegratedOrderFulfillmentShipmentStatus

Values

• ATTEMPTED_DELIVERY
• DELAYED
• DELIVERED
• FAILED
• IN_TRANSIT
• NOT_TRACKED
• OUT_FOR_DELIVERY
• PENDING
• PICKED_UP
• READY_FOR_PICKUP

IntegratedOrderFulfillmentStatus

Values

• CANCELLED
• FULFILLED
• NOT_TRACKED
• OPEN
• PENDING

IntegratedOrderStatus

Values

• CANCELLED
• CLOSED
• INCOMPLETE
• OPEN

OrderAttributionStatus

Values

• CANCELLED
• CLOSED
• OPEN
• PARTIALLY_REFUNDED

SortOrderAttributionsBy

The available keys to sort OrderAttributions

Values

• CONVERTED_AT
• CREATED_AT
• UPDATED_AT