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...."

Schema Types

Table of Contents

- Query

Objects
Inputs
Enums
- Direction
- OrderBy
Scalars
- Boolean
- Count
- Cursor
- FulfillmentStatus
- Int
- Map
- NullTime
- PaymentStatus
- Service
- String
- Time
- UUID
- Uint

Query

The query root.

Field	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 a customer event given its id.
id	UUID!	The id of the customer to retrieve
customerOrders	OrderConnection!	This query will return an OrderConnection containing the requested data along with pagination information for users to continue paging through this customers orders.
customerID	UUID!	The id of the customer to retrieve orders for
filter	OrderFilter	(Optional) Supported filter parameters
orders	OrderConnection!	This query will return an OrderConnection containing the requested data along with pagination information for users to continue paging through all filtered orders.
filter	OrderFilter	(Optional) Supported filter parameters
customers	CustomerConnection!	This query will return an CustomerConnection containing the requested data along with pagination information for users to continue paging through all filtered customers.
filter	CustomerFilter	(Optional) Supported filter parameters

Objects

Address

An Address is a object representing a physical address that can be used for shipping or billing

Field	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	A comment about the address
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	Type	Description
createdAt	Int	When the tax result was created
service	Service	Service that was used for generating tax data
currency	String	Currency in ISO 4217 three-letter format.
items	CalcResultItemsData	Tax data for order items.
shipping	CalcResultShippingData	Tax data for order shipping.
expiresAt	Int	Time at which the tax data will expire. Measured in seconds since the Unix epoch.
externalID	String	External ID used in tax service API (e.g. stripe).
taxDate	Int	Tax datetime that was used for calculating the tax data. Measured in seconds since the Unix epoch.

CalcResultEntry

Represents a tax result entry

Field	Type	Description
orderItemID	String	Item ID. Filled only for items data.
amount	String	Amount used for calculating taxes in string-decimal format.
taxAmount	String	Amount of taxes for this object in string-decimal format.
quantity	Uint	Quantity of items. Filled only for items data.
taxBehavior	String	Specifies whether the `amount` includes taxes. Could be 'inclusive' or 'exclusive'.
taxCode	String	Tax code used for calculating taxes for this object. Depends on the used tax service API.
breakdown	[CalcResultEntryBreakdown]	Tax details breakdown (if tax service API provides this data).

CalcResultEntryBreakdown

Represents a breakdown of a tax result entry

Field	Type	Description
amount	String	Amount of tax in string-decimal format.
taxabilityReason	String	The reasoning behind this tax. Depends on the used tax service API.
displayName	String	A localized display name for tax type, intended to be human-readable. Depends on the used tax service API.
percentage	String	The tax rate percentage in string-decimal format.
taxType	String	The tax type, such as 'vat' or 'sales_tax'. Depends on the used tax service API.

CalcResultItemsData

Represents a tax result of all item data

Field	Type	Description
totalAmount	String	Total amount of items without taxes in string-decimal format.
totalTaxAmount	String	Total amount of items taxes in string-decimal format.
totalWithTaxAmount	String	Total amount of items with taxes in string-decimal format.
entries	[CalcResultEntry]	Tax details for these items.

CalcResultShippingData

Represents a tax result of shipping data

Field	Type	Description
totalAmount	String	Total amount of shipping without taxes in string-decimal format.
totalTaxAmount	String	Total amount of shipping taxes in string-decimal format.
totalWithTaxAmount	String	Total amount of shipping with taxes in string-decimal format.
entries	CalcResultEntry	Tax details for the shipping.

Customer

Represents a customer in the system

Field	Type	Description
id	UUID!	The unique customer id
firstName	String	The customers first name
lastName	String	The customers last name
email	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

CustomerConnection

An object containing an array of Customer data and pagination information

Field	Argument	Type	Description
pageInfo		PageInfo!	Information to aid in pagination.
edges		[CustomerEdge]!	A list of edges.

CustomerEdge

An object containing a node with Customer data and a cursor

Field	Argument	Type	Description
cursor		Cursor!	A cursor for use in pagination.
node		Customer!	The customer data

Fulfillment

Represents a fulfillment in the system

Field	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 fulfillment data

FulfillmentOrderItem

Represents a fulfillment order item data attached to the Fulfillment object.

Field	Argument	Type	Description
orderItemID		UUID!	Order Item ID
quantity		Uint!	Quantity of fulfilled goods for this Order Item

Money

Represents a single price

Field	Type	Description
amount	Int!	[source] An amount for the money
currencyCode	String!	[source] A currencyCode identifier for the amount
precisionDigits	Int	[source] (optional) The precision to which the currency amount should be displayed

Order

Represents a single order in the system

Field	Type	Description
id	UUID!	The unique order id
status	String!	The status of the order
nacelleEntryId	String	The nacelle entry id of the order
email	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	String	The tax rate of the order in string-decimal format
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

Field	Argument	Type	Description
pageInfo		PageInfo!	Information to aid in pagination.
edges		[OrderEdge]!	A list of edges.

OrderEdge

An object containing a node with Order data and a cursor

Field	Argument	Type	Description
cursor		Cursor!	A cursor for use in pagination.
node		Order!	The item at the end of OrderEdge.

OrderItem

Represents a single order item in an order

Field	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	String	The tax rate of the order item in string-decimal format
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

Field	Argument	Type	Description
cursor		Cursor!	A cursor for use in pagination.
node		OrderItem!	The order item data

PageInfo

Contains information that can be used to navigate through paginated data, additionally details whether there are more pages to query.

Field	Type	Description
hasNextPage	Boolean!	Whether there is a next page to view
hasPreviousPage	Boolean!	Whether there is a previous page to view
startCursor	String!	The starting cursor of this request
endCursor	String!	The ending cursor of this request

Payment

Represents a payment in the system

Field	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

CustomerFilter

Filter results for Customer 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) Returns the first n collections of a query. Defaults to 50. Max value of 100

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