Queryable objects

We borrow the shape of a lot of queryable objects from Shopify.

AppliedDiscount

The order-level discount applied to an order.

FieldTypeDescription
amountMoney!Amount of money discounted.
codeStringThe optional discount code.
typeAppliedDiscountKind!Type of the order-level discount.

CalculatedOrder

The computed properties for an order.

FieldTypeDescription
appliedDiscountAppliedDiscountOrder-level discount applied to the order.
availableShippingRates[ShippingRate!]!The available shipping rates for the order.
customerCustomer!The Shopify Customer.
lineItems[LineItem!]!Line items in the order with their computed properties.
shippingLineShippingLineLine item that contains the shipping costs.
subtotalPriceMoney!Subtotal of the line items and their discounts (does not contain shipping charges or shipping discounts or taxes).
taxLines[TaxLine!]!Total amount of taxes charged for each line item and shipping line.
totalPriceMoney!Total amount of the order (includes taxes, shipping charges, and discounts).
totalShippingPriceMoney!Total shipping charge for the order.
totalTaxMoney!Total amount of taxes for the order.

Customer

The customer.

FieldType
displayNameString!
emailString!
idID!
phoneString

CustomerPaymentMethod

A Submarine payment method for a customer.

FieldType
defaultBoolean!
idID!
sourceIDString
typeString
statusString!

LineItem

FieldTypeDescription
discountedTotalMoney!Total price with discounts applied.
discountedUnitPriceMoney!Unit price with discounts applied.
nameString!Name of the product.
originalTotalMoney!Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.
originalUnitPriceMoney!Variant price without any discounts applied.
productIdIDThe ID of the product.
quantityInt!Number of variant items in the order.
skuStringVariant SKU number.
taxableBoolean!Whether the variant is taxable.
totalDiscountMoneyThe total discount amount applied to the line item. This value is not subtracted in the line item price.
variantIdID!The ID of the product variant.
variantTitleString!The title of the product variant.

Money

A representation of an amount of money.

FieldType
amountFloat
currencyCodeCurrencyCode

Order

The Submarine order.

πŸ“˜

Note

This object mirrors the CalculatedOrder above, with the addition of the following three fields.

FieldTypeDescription
createdAtDateTime!Date and time when the order was created.
shopifyIdID!The ID of the created Shopify order.
shopifyTransactionIdID!The ID of the associated Shopify transaction.

ShippingLine

Represents the shipping details that the customer chose for their order.

FieldTypeDescription
codeString
priceMoney!The price of the shipping rate.
shippingRateHandleString!A unique identifier for the shipping rate.
titleString!The title of the shipping rate.

ShippingRate

A Shopify shipping rate.

FieldType
handleString!
priceMoney
titleString

TaxLine

Represents the information about the tax charged on the order.

FieldTypeDescription
priceMoney!The amount of tax to be charged in shop and presentment currencies.
rateFloat!The tax rate to be applied.
titleString!The name of the tax.

CompletedDraftOrder

An object containing information about a recently completed draft order.

FieldTypeDescription
orderIdIDThe ID of the Shopify order that was created by the completion.
orderNameStringThe name of the Shopify order that was created by the completion.
processorReferenceIDProcessor reference for the generated charge.
submarineReferenceIDSubmarine reference for the generated charge.

UserError

An error generated from the API.

FieldType
fieldString
messages[String]