Schema breakdown for Noms storefront graphql endpoint
Endpoint
https://storefront.api.nacelle.com/graphql/v1/spaces/[your_storefront_ID]
To find your custom endpoint, login to your Nacelle Dashboard > select your space > click Space Settings > click the API Details tab > find the Storefront Endpoint under the Storefront API section.
Required Headers
| Name | Value | Example |
|---|---|---|
| x-nacelle-space-id | The spaceID for the request | "x-nacelle-space-id": "a space id" |
| Authorization | An authorization token granting access to the space id | "Authorization": "Bearer ey...." |
The authorization token is used to embed a customer id to allow a customer to query records from a frontend.
Schema Types
Query
The query root. These queries are authenticated and will return data based on the customer associated with the authentication token.
| Field | Argument | Type | Description |
|---|---|---|---|
| order | Order | This query will return a single order given its id. | |
| id | UUID! | The id of the order to retrieve | |
| customer | Customer | This query will return the customer. | |
| orders | OrderConnection! | This query will return a orders for a customer. | |
| filter | OrderFilter | (Optional) Supported filter parameters | |
Objects
Address
An Address is a object representing a physical address that can be used for shipping or billing
| Field | Argument | Type | Description |
|---|---|---|---|
| id | UUID! | The unique address id | |
| countryISO2 | String! | The two-letter code for the country of the address. | |
| province | String | The region of the address, such as the province, state, or district. | |
| city | String! | The name of the city, district, village, or town | |
| postalCode | String! | The postal code for the address | |
| state | String! | The state for the address | |
| address1 | String! | The first line of the address. Typically the street address or PO Box number. | |
| address2 | String | The second line of the address. Typically the number of the apartment, suite, or unit. | |
| comment | String | ||
| zip ⚠️ | String! | ⚠️ DEPRECATED use postalCode instead | |
| country ⚠️ | String! | ⚠️ DEPRECATED use countryISO2 instead | |
CalcResult
Represents a tax result calculated by a tax service containing the tax data for the cart
| Field | Argument | Type | Description |
|---|---|---|---|
| createdAt | Int | When the tax result was created | |
| service | Service | The service used to calculate the tax result | |
| currency | String | The currency of the tax result | |
| items | CalcResultItemsData | The line item data of the tax result | |
| shipping | CalcResultShippingData | The shipping data of the tax result | |
| expiresAt | Int | When the tax result expires | |
| externalID | String | The external ID of the tax result | |
| taxDate | Int | The tax date of the tax result | |
CalcResultEntry
Represents a tax result entry
| Field | Argument | Type | Description |
|---|---|---|---|
| orderItemID | String | The unique ID of the order item | |
| amount | String | The amount of the item | |
| taxAmount | String | The tax amount of the item | |
| quantity | Uint | The positive quantity of the item | |
| taxBehavior | String | The tax behavior of the item | |
| taxCode | String | The tax code of the item | |
| breakdown | [CalcResultEntryBreakdown] | The tax breakdown of the item | |
CalcResultEntryBreakdown
Represents a breakdown of a tax result entry
CalcResultItemsData
Represents a tax result of all item data
| Field | Argument | Type | Description |
|---|---|---|---|
| totalAmount | String | The total amount of the items without tax | |
| totalTaxAmount | String | The total tax amount of the items | |
| totalWithTaxAmount | String | The total amount of the items with tax | |
| entries | [CalcResultEntry] | The line item data of the tax result | |
CalcResultShippingData
Represents a tax result of shipping data
| Field | Argument | Type | Description |
|---|---|---|---|
| totalAmount | String | The total amount of the shipping without tax | |
| totalTaxAmount | String | The total tax amount of the shipping | |
| totalWithTaxAmount | String | The total amount of the shipping with tax | |
| entries | CalcResultEntry | The shipping data of the tax result | |
Customer
Represents a customer in the system
| Field | Argument | Type | Description |
|---|---|---|---|
| id | UUID! | The unique customer id | |
| firstName | String | The customers first name | |
| lastName | String | The customers last name | |
| String | The customers email | ||
| phone | String | The customers phone number | |
| meta | Map | A map of meta data for the customer | |
| addresses | [Address] | The customers addresses | |
| createdAt | Time | When the customer was created | |
| modifiedAt | Time | When the customer was last modified | |
| sourceExternalID | String | The external id of the source, used for syncing with external systems | |
| destinationExternalID | String | The destination id of the customer, used for syncing with external systems | |
Fulfillment
Represents a fulfillment in the system
| Field | Argument | Type | Description |
|---|---|---|---|
| id | UUID! | The unique fulfillment id | |
| externalId | String! | The external id for the fulfillment | |
| assignedLocationId | String | External location ID that has been assigned for fulfillment work | |
| destinationAddress | Address | The destination where the items should be sent | |
| deliveryType | String! | The type of delivery | |
| deliveryMethod | String! | The type of delivery method | |
| nacelle_status | FulfillmentStatus! | The nacelle status of the fulfillment | |
| status | String | The merchant status of the fulfillment | |
| shipmentStatus | String | The current shipment status of the fulfillment | |
| deliveryDate | Int | Timestamp at which the Fulfillment has been delivered (unix timestamp in seconds) | |
| deliveryEstimation | String | Comment describing when delivery expected, received from the shipping company. E.g. "28 July 2023 before 9pm". | |
| trackingCompany | String | The name of the tracking company | |
| trackingNumbers | [String!] | A list of tracking numbers provided by the shipping company | |
| trackingUrls | [String!] | A list of tracking URLs | |
| fulfillmentOrderItems | [FulfillmentOrderItem!] | A list of order item fulfillment data | |
FulfillmentConnection
An object containing an array of Fulfillment data and pagination information
| Field | Argument | Type | Description |
|---|---|---|---|
| pageInfo | PageInfo! | Information to aid in pagination. | |
| edges | [FulfillmentEdge]! | An array of FulfillmentsEdge's. | |
FulfillmentEdge
An object containing a node with Fulfillment data and a cursor
| Field | Argument | Type | Description |
|---|---|---|---|
| cursor | Cursor! | A cursor for use in pagination. | |
| node | Fulfillment! | The order item data | |
FulfillmentOrderItem
Represents a fulfillment order item data attached to the Fulfillment object.
Money
Represents a single price
Order
Represents a single order in the system
| Field | Argument | Type | Description |
|---|---|---|---|
| id | UUID! | The unique order id | |
| status | String! | The status of the order | |
| nacelleEntryId | String | The nacelle entry id of the order | |
| String | The email address associated with the customer. | ||
| phone | String | The phone number associated with the customer. | |
| sourceExternalId | String | The external id of the orders source | |
| destinationExternalId | String | The destination id of the order, used for syncing with external systems | |
| comment | String | A comment about the order | |
| createdAt | Time! | When the order was created | |
| modifiedAt | Time! | When the order was last modified | |
| canceledAt | NullTime | When the order was canceled | |
| canceledReason | String | The reason the order was canceled | |
| currency | String | The currency of the order for example USD, CAD, etc. | |
| shippingMethod | String | The shipping method for the order | |
| meta | Map | [source] The meta data for the order | |
| customer | Customer | [source] The customer for the order | |
| shippingAddress | Address | [source] The shipping address for the order | |
| billingAddress | Address | [source] The billing address for the order | |
| payment | Payment | [source] The payment information for the order | |
| taxResult | CalcResult | [source] The tax calculation information for the order | |
| taxRate | Money | The tax rate of the order | |
| shippingPrice | Money | The shipping price of the order | |
| deadline | Uint | ||
| orderItems ⚠️ | [OrderItem]! | ⚠️ DEPRECATED use items instead | |
| items | OrderItemConnection! | [source] A query to get all the order items based on the filter | |
| filter | OrderItemFilter | [source] Supported filter parameters | |
| fulfillments | FulfillmentConnection! | [source] A query to get all the fulfillments based on the filter | |
| filter | FulfillmentFilter | [source] Supported filter parameters | |
| price | Money | [source] The total price of the order | |
| subtotalPrice | Money | [source] The subtotal price of the order | |
| tax | Money | [source] The total tax of the order | |
| discounts | Money | [source] The total discounts of the order | |
| paymentMethod ⚠️ | String | ⚠️ DEPRECATED use payment instead | |
| paymentService ⚠️ | String | ⚠️ DEPRECATED use payment instead | |
| paymentStatus ⚠️ | String | ⚠️ DEPRECATED use payment instead | |
| totalPrice ⚠️ | Int | ⚠️ DEPRECATED use price instead | |
| totalSubtotalPrice ⚠️ | Int | ⚠️ DEPRECATED use subtotalPrice instead | |
| totalTotalTax ⚠️ | Int | ⚠️ DEPRECATED use tax instead | |
| totalDiscounts ⚠️ | Int | ⚠️ DEPRECATED use discounts instead | |
OrderConnection
An object containing an array of Order data and pagination information
OrderEdge
An object containing a node with Order data and a cursor
OrderItem
Represents a single order item in an order
| Field | Argument | Type | Description |
|---|---|---|---|
| id | UUID! | The unique order item id | |
| productID | String | The nacelle entry id of the product this item represents | |
| variantID | String | The nacelle entery id of the variant this item represents | |
| status | String! | The status of the order item | |
| sourceExternalID | String | The external id of the order item | |
| destinationExternalID | String | The destination id of the order item, used for syncing with external systems | |
| comment | String | A comment about the order item | |
| priceAmount | Money | The total price of the order item | |
| subtotalPriceAmount | Money | The subtotal price of the order item | |
| taxAmount | Money | The total tax of the order item | |
| discountsAmount | Money | The total discounts of the order item | |
| taxRate | Money | The tax rate of the order item | |
| quantity | Uint | The total quantity of the order item | |
| meta | Map | The meta data for the order item | |
| sku | String | The product sku | |
| createdAt | Time! | When the order item was created | |
| description ⚠️ | String | ⚠️ DEPRECATED use meta instead | |
| nacelleEntryID ⚠️ | String | ⚠️ DEPRECATED use productID instead | |
| productExternalID ⚠️ | String | ⚠️ DEPRECATED use variantID instead | |
| price ⚠️ | Int | ⚠️ DEPRECATED use priceAmount instead | |
OrderItemConnection
An object containing an array of OrderItem data and pagination information
| Field | Argument | Type | Description |
|---|---|---|---|
| pageInfo | PageInfo! | Information to aid in pagination. | |
| edges | [OrderItemEdge]! | An array of OrderItemsEdge's. | |
OrderItemEdge
An object containing a node with OrderItem data and a cursor
PageInfo
Contains information that can be used to navigate through paginated data, additionally details whether there are more pages to query.
Payment
Represents a payment in the system
| Field | Argument | Type | Description |
|---|---|---|---|
| id | UUID! | The unique payment id | |
| status | PaymentStatus! | The status of the payment | |
| amountValue | Money | The total price of the payment | |
| currency | String! | The currency of the payment for example USD, CAD, etc. | |
| external_id | String | The external id for the payment for example the stripe payment intent id | |
| processor_name | String | The payment processor name for the payment. For example Stripe, Paypal, etc. | |
| payment_type | String | The type of payment. For example credit card, paypal, etc. | |
| processor_status | String | The status of the payment processor | |
| payment_data | Map | The meta data for the payment | |
| cardBrand | String | The brand of the card used for the payment. For example Visa, Mastercard, etc. | |
| amount ⚠️ | Int! | ⚠️ DEPRECATED use amountValue instead | |
| brand ⚠️ | String | ⚠️ DEPRECATED use cardBrand instead | |
Inputs
FulfillmentFilter
Filter results for Fulfillment collections
| Field | Type | Description | |
|---|---|---|---|
| after | Cursor | (Optional) A cursor for navigating in forwards through data | |
| before | Cursor | (Optional) A cursor for navigating in backwards through data | |
| first | Int | (Optional) How many records to return. Defaults to 50. Max value of 100 | |
| orderBy | OrderBy | (Optional) How the returned rows are ordered either version, or timestamp. | |
| direction | Direction | (Optional) What direction the data is retrieved by. | |
OrderFilter
Filter results for Order collections
| Field | Type | Description | |
|---|---|---|---|
| after | Cursor | (Optional) A cursor for navigating in forwards through data | |
| before | Cursor | (Optional) A cursor for navigating in backwards through data | |
| start | Time | (Optional) A timestamp that filters out all events before it, timezone is utc +00:00 | |
| end | Time | (Optional) A timestamp that filters out all events after it, timezone is utc +00:00 | |
| first | Int! | (Optional) First denotes how many records to return | |
| id | UUID | (Optional) The order id to filter by | |
| search | String | (Optional) The string to search for in the order | |
| status | String | (Optional) The status to filter by | |
| orderBy | OrderBy | (Optional) How the returned rows are ordered either version, or timestamp. | |
| direction | Direction | (Optional) What direction the data is retrieved by. | |
OrderItemFilter
Filter results for OrderItem collections
| Field | Type | Description | |
|---|---|---|---|
| after | Cursor | (Optional) A cursor for navigating in forwards through data | |
| before | Cursor | (Optional) A cursor for navigating in backwards through data | |
| first | Int | (Optional) How many records to return. Defaults to 50. Max value of 100 | |
| orderBy | OrderBy | (Optional) How the returned rows are ordered either version, or timestamp. | |
| direction | Direction | (Optional) What direction the data is retrieved by. | |
| showCanceled | Boolean | (Optional) Whether to return canceled items | |
Enums
Direction
Direction to return results in
| Value | Description |
|---|---|
| ASC | |
| DESC |
OrderBy
What to order results by in a collection
| Value | Description |
|---|---|
| CREATEDAT | |
| MODIFIEDAT |
Scalars
Boolean
The Boolean scalar type represents true or false.
Count
Cursor
A base64 encoded string
FulfillmentStatus
Represents the status of a fulfillment. Possible values: open, partially_fulfilled, in_progress, scheduled, cancelled, on_hold, incomplete, succeeded
Int
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Map
Maps represent a custom json object attached to a resource.
NullTime
Represents a nullable time
PaymentStatus
Represents the status of a payment. Possible values: created, pending, succeeded, failed, requires_confirmation, balance_due, credit_owed
Service
Represents the enum for services used for calculating TaxResult
String
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Time
Represents a date and time according to ISO-8601
UUID
Represents a UUID according to RFC 4122
Uint
Represents a positive integer value