Queryable objects
We borrow the shape of a lot of queryable objects from Shopify.
AppliedDiscount
The order-level discount applied to an order.
| Field | Type | Description |
|---|---|---|
| amount | Money! | Amount of money discounted. |
| code | String | The optional discount code. |
| type | AppliedDiscountKind! | Type of the order-level discount. |
CalculatedOrder
The computed properties for an order.
| Field | Type | Description |
|---|---|---|
| appliedDiscount | AppliedDiscount | Order-level discount applied to the order. |
| availableShippingRates | [ShippingRate!]! | The available shipping rates for the order. |
| customer | Customer! | The Shopify Customer. |
| lineItems | [LineItem!]! | Line items in the order with their computed properties. |
| shippingLine | ShippingLine | Line item that contains the shipping costs. |
| subtotalPrice | Money! | 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. |
| totalPrice | Money! | Total amount of the order (includes taxes, shipping charges, and discounts). |
| totalShippingPrice | Money! | Total shipping charge for the order. |
| totalTax | Money! | Total amount of taxes for the order. |
Customer
The customer.
| Field | Type |
|---|---|
| displayName | String! |
| String! | |
| id | ID! |
| phone | String |
CustomerPaymentMethod
A Submarine payment method for a customer.
| Field | Type |
|---|---|
| default | Boolean! |
| id | ID! |
| sourceID | String |
| type | String |
| status | String! |
LineItem
| Field | Type | Description |
|---|---|---|
| discountedTotal | Money! | Total price with discounts applied. |
| discountedUnitPrice | Money! | Unit price with discounts applied. |
| name | String! | Name of the product. |
| originalTotal | Money! | Total price (without discounts) of the line item, based on the original unit price of the variant x quantity. |
| originalUnitPrice | Money! | Variant price without any discounts applied. |
| productId | ID | The ID of the product. |
| quantity | Int! | Number of variant items in the order. |
| sku | String | Variant SKU number. |
| taxable | Boolean! | Whether the variant is taxable. |
| totalDiscount | Money | The total discount amount applied to the line item. This value is not subtracted in the line item price. |
| variantId | ID! | The ID of the product variant. |
| variantTitle | String! | The title of the product variant. |
Money
A representation of an amount of money.
| Field | Type |
|---|---|
| amount | Float |
| currencyCode | CurrencyCode |
Order
The Submarine order.
Note
This object mirrors the
CalculatedOrderabove, with the addition of the following three fields.
| Field | Type | Description |
|---|---|---|
| createdAt | DateTime! | Date and time when the order was created. |
| shopifyId | ID! | The ID of the created Shopify order. |
| shopifyTransactionId | ID! | The ID of the associated Shopify transaction. |
ShippingLine
Represents the shipping details that the customer chose for their order.
| Field | Type | Description |
|---|---|---|
| code | String | |
| price | Money! | The price of the shipping rate. |
| shippingRateHandle | String! | A unique identifier for the shipping rate. |
| title | String! | The title of the shipping rate. |
ShippingRate
A Shopify shipping rate.
| Field | Type |
|---|---|
| handle | String! |
| price | Money |
| title | String |
TaxLine
Represents the information about the tax charged on the order.
| Field | Type | Description |
|---|---|---|
| price | Money! | The amount of tax to be charged in shop and presentment currencies. |
| rate | Float! | The tax rate to be applied. |
| title | String! | The name of the tax. |
CompletedDraftOrder
An object containing information about a recently completed draft order.
| Field | Type | Description |
|---|---|---|
| orderId | ID | The ID of the Shopify order that was created by the completion. |
| orderName | String | The name of the Shopify order that was created by the completion. |
| processorReference | ID | Processor reference for the generated charge. |
| submarineReference | ID | Submarine reference for the generated charge. |
UserError
An error generated from the API.
| Field | Type |
|---|---|
| field | String |
| messages | [String] |
Updated over 1 year ago