Objects - Charter

Model tree

ShopGetVariables

shop takes no arguments. This object has no settable fields.

ProductsListVariables

Variables for the products connection.

Field	Type	Description
`first`	`integer`	How many results to return, at most 250. Larger pages cost more against the store’s query-cost budget. ≥ 1; ≤ 250; defaults to `50`
`after`	`string`	The `endCursor` from the previous page’s `pageInfo`.
`reverse`	`boolean`	Reverse the sort order. Defaults to false.
`query`	`string`	A Shopify search string. Supported qualifiers include `title:`, `vendor:`, `product_type:`, `tag:`, `status:` (active/archived/draft), `created_at:`, `updated_at:` and `inventory_total:`. Terms combine with AND; use OR explicitly. Example: `status:active vendor:Acme`. A record created moments ago may not appear here yet; search is eventually consistent, so confirm a write with the id it returned. Use only the qualifiers listed: Shopify ignores one it does not recognise instead of rejecting it, so a typo like `vendorr:` returns the whole unfiltered set rather than an error.
`sortKey`	ProductSortKeys	Which field to sort by. Shopify sorts by ID by default.

ProductGetVariables

Variables for the product query.

Field	Type	Description
`id` *	`string`	A Shopify global ID, of the form `gid://shopify/Product/1234567890`.

ProductCreateVariables

Variables for the productCreate mutation.

Field	Type	Description
`product` *	ProductCreateInput	The product to create.

ProductCreateInput

The input to productCreate.

Field	Type	Description
`title` *	`string`	The product’s title. Required.
`descriptionHtml`	`string`	The product description, as HTML.
`vendor`	`string`	The product’s vendor name.
`productType`	`string`	A custom product type, used for filtering and reporting.
`tags`	`string`[]	Tags to attach to the product.
`status`	ProductStatus	The product’s status. Defaults to ACTIVE. DRAFT keeps it out of the storefront.
`handle`	`string`	The URL slug for the product. Derived from the title when omitted.

ProductUpdateVariables

Variables for the productUpdate mutation.

Field	Type	Description
`product` *	ProductUpdateInput	The product changes.

ProductUpdateInput

The input to productUpdate. Only id is required.

Field	Type	Description
`id` *	`string`	A Shopify global ID, of the form `gid://shopify/Product/1234567890`.
`title`	`string`	A new title.
`descriptionHtml`	`string`	A new description, as HTML.
`vendor`	`string`	A new vendor name.
`productType`	`string`	A new product type.
`tags`	`string`[]	Tags. This replaces the product’s tags rather than adding to them.
`status`	ProductStatus	A new status.
`handle`	`string`	A new URL slug.

OrdersListVariables

Variables for the orders connection.

Field	Type	Description
`first`	`integer`	How many results to return, at most 250. Larger pages cost more against the store’s query-cost budget. ≥ 1; ≤ 250; defaults to `50`
`after`	`string`	The `endCursor` from the previous page’s `pageInfo`.
`reverse`	`boolean`	Reverse the sort order. Defaults to false.
`query`	`string`	A Shopify search string. Supported qualifiers include `financial_status:` (paid/pending/refunded/voided), `fulfillment_status:` (shipped/unshipped/partial), `created_at:`, `updated_at:`, `email:`, `name:` and `tag:`. Example: `financial_status:paid fulfillment_status:unshipped`. Use only the qualifiers listed: Shopify ignores one it does not recognise instead of rejecting it, so a typo like `vendorr:` returns the whole unfiltered set rather than an error. Note that a `created_at:` window reaching further back than 60 days returns nothing unless the app holds the `read_all_orders` scope.
`sortKey`	OrderSortKeys	Which field to sort by. Shopify sorts by PROCESSED_AT by default.

OrderGetVariables

Variables for the order query.

Field	Type	Description
`id` *	`string`	A Shopify global ID, of the form `gid://shopify/Order/1234567890`.

CustomersListVariables

Variables for the customers connection.

Field	Type	Description
`first`	`integer`	How many results to return, at most 250. Larger pages cost more against the store’s query-cost budget. ≥ 1; ≤ 250; defaults to `50`
`after`	`string`	The `endCursor` from the previous page’s `pageInfo`.
`reverse`	`boolean`	Reverse the sort order. Defaults to false.
`query`	`string`	A Shopify search string. Supported qualifiers include `email:`, `first_name:`, `last_name:`, `phone:`, `tag:`, `orders_count:` and `total_spent:`. Example: `orders_count:>5`. A record created moments ago may not appear here yet; search is eventually consistent, so confirm a write with the id it returned. Use only the qualifiers listed: Shopify ignores one it does not recognise instead of rejecting it, so a typo like `vendorr:` returns the whole unfiltered set rather than an error.
`sortKey`	CustomerSortKeys	Which field to sort by.

CustomerGetVariables

Variables for the customer query.

Field	Type	Description
`id` *	`string`	A Shopify global ID, of the form `gid://shopify/Customer/1234567890`.

CustomerCreateVariables

Variables for the customerCreate mutation.

Field	Type	Description
`input` *	CustomerInput	The customer to create.

CustomerInput

The input to customerCreate.

Field	Type	Description
`email`	`string`	The customer’s email address. Either this or `phone` is needed for Shopify to accept the customer.
`phone`	`string`	The customer’s phone number, in E.164 format.
`firstName`	`string`	The customer’s first name.
`lastName`	`string`	The customer’s last name.
`note`	`string`	A note about the customer.
`tags`	`string`[]	Tags to attach to the customer.

CustomerUpdateVariables

Variables for the customerUpdate mutation.

Field	Type	Description
`input` *	CustomerUpdateInput	The customer’s `id` plus the fields to change.

CustomerUpdateInput

The input to customerUpdate.

Field	Type	Description
`id` *	`string`	The customer’s global ID, `gid://shopify/Customer/...`.
`email`	`string`	The customer’s email address.
`phone`	`string`	The customer’s phone number, in E.164 format.
`firstName`	`string`	The customer’s first name.
`lastName`	`string`	The customer’s last name.
`note`	`string`	A note about the customer.
`tags`	`string`[]	Tags for the customer. This replaces the existing tags rather than adding to them.

OrderFulfillmentOrdersVariables

Variables for reading an order’s fulfillment orders.

Field	Type	Description
`id` *	`string`	The order’s global ID, `gid://shopify/Order/...`.
`first`	`integer`	How many fulfillment orders to read. ≥ 1; ≤ 50; defaults to `10`

FulfillmentCreateVariables

Variables for the fulfillmentCreate mutation.

Field	Type	Description
`fulfillment` *	FulfillmentInput	What to fulfil.
`message`	`string`	A message recorded against the fulfillment.

FulfillmentInput

What to fulfil, and whether to tell the customer.

Field	Type	Description
`lineItemsByFulfillmentOrder` *	FulfillmentOrderLineItems[]	The fulfillment orders being fulfilled. min 1 items
`notifyCustomer`	`boolean`	Email the customer. Absent, Shopify does not.
`trackingInfo`	FulfillmentTracking	Carrier and tracking number.

FulfillmentOrderLineItems

One fulfillment order, whole or in part.

Field	Type	Description
`fulfillmentOrderId` *	`string`	The fulfillment order’s global ID, from the resolve step.
`fulfillmentOrderLineItems`	FulfillmentOrderLineItem[]	Specific lines to fulfil. Absent, the whole fulfillment order.

FulfillmentOrderLineItem

One line of a fulfillment order, when fulfilling it only in part.

Field	Type	Description
`id` *	`string`	The line’s global ID, `gid://shopify/FulfillmentOrderLineItem/...`.
`quantity` *	`integer`	How many units to fulfil. ≥ 1

FulfillmentTracking

Where the customer can follow the parcel.

Field	Type	Description
`company`	`string`	The carrier’s name.
`number`	`string`	The tracking number.
`url`	`string`	A tracking URL.

InventoryAdjustVariables

Variables for inventoryAdjustQuantities, including its idempotency key.

Field	Type	Description
`input` *	InventoryAdjustInput	The adjustment to apply.
`idempotencyKey`	`string`	Deduplicates this adjustment for 24 hours. A fresh one is generated per call; pass your own to make a retry safe to repeat.

InventoryAdjustInput

A relative stock adjustment.

Field	Type	Description
`name` *	InventoryStateName	Which stock state to move.
`reason` *	InventoryAdjustReason	Why the stock moved. `correction` is the general case.
`changes` *	InventoryChange[]	The movements to apply. min 1 items
`referenceDocumentUri`	`string`	A URI for the document this adjustment came from.

InventoryChange

One stock movement, relative to what is there now.

Field	Type	Description
`delta` *	`integer`	How much to add or remove. Negative reduces the count.
`inventoryItemId` *	`string`	The item’s global ID, `gid://shopify/InventoryItem/...`.
`locationId` *	`string`	The location’s global ID, `gid://shopify/Location/...`.
`changeFromQuantity` *	`integer`	The quantity you expect to be there now, from `variant_inventory_level`. Shopify refuses the change if the count has moved since, so read it immediately before adjusting.
`ledgerDocumentUri`	`string`	A URI recording why the stock moved. Shopify requires one for every state except `available`, and it must not be a gid.

VariantInventoryLevelVariables

Variables for reading one variant’s stock at one location.

Field	Type	Description
`id` *	`string`	The variant’s global ID, `gid://shopify/ProductVariant/...`.
`locationId` *	`string`	The location’s global ID, `gid://shopify/Location/...`.
`names`	`string`[]	Which stock states to read: available, committed, incoming, on_hand, reserved, damaged, safety_stock, quality_control. min 1 items

LocationsVariables

Variables for the locations connection.

Field	Type	Description
`first`	`integer`	How many results to return, at most 250. Larger pages cost more against the store’s query-cost budget. ≥ 1; ≤ 250; defaults to `50`
`after`	`string`	The `endCursor` from the previous page’s `pageInfo`.
`reverse`	`boolean`	Reverse the sort order. Defaults to false.
`query`	`string`	A Shopify search string.
`includeInactive`	`boolean`	Include deactivated locations. Absent, only active ones.

OrderStateVariables

Variables for orderClose and orderOpen.

Field	Type	Description
`input` *	OrderIdInput	The order to change.

OrderIdInput

The single-field input orderClose and orderOpen share.

Field	Type	Description
`id` *	`string`	The order’s global ID, `gid://shopify/Order/...`.

OrderCancelVariables

Variables for orderCancel.

Field	Type	Description
`orderId` *	`string`	The order’s global ID.
`reason` *	OrderCancelReason	Why the order is being cancelled.
`restock` *	`boolean`	Whether to return the items to inventory.
`notifyCustomer`	`boolean`	Email the customer. Absent, Shopify does not.
`staffNote`	`string`	An internal note on the cancellation. max length 255

DraftOrderCreateVariables

Variables for draftOrderCreate.

Field	Type	Description
`input` *	`object`	The draft order. Useful keys: `lineItems` (each with `variantId` and `quantity`, or `title` and `originalUnitPrice` for a custom line), `customerId`, `email`, `note`, `tags`, `shippingAddress`.

DraftOrderCompleteVariables

Variables for draftOrderComplete.

Field	Type	Description
`id` *	`string`	The draft order’s global ID.
`paymentGatewayId`	`string`	The gateway to charge through, when taking payment now.
`sourceName`	`string`	Where the resulting order came from.

ProductVariantsBulkCreateVariables

Variables for productVariantsBulkCreate.

Field	Type	Description
`productId` *	`string`	The product’s global ID, `gid://shopify/Product/...`.
`variants` *	ProductVariantBulkInput[]	The variants to add. min 1 items
`strategy`	ProductVariantsBulkCreateStrategy	Use ‘REMOVE_STANDALONE_VARIANT’ when adding the first real variant to a product that still carries its default placeholder.

ProductVariantBulkInput

One variant to add to a product.

Field	Type	Description
`optionValues` *	VariantOptionValue[]	What distinguishes this variant. min 1 items
`price`	`string`	The price, as a decimal string. Dollars as written, not a count of cents: “15.00” is fifteen dollars and “1500” is fifteen hundred.
`compareAtPrice`	`string`	The struck-through price, as a decimal string. Dollars as written, not a count of cents: “15.00” is fifteen dollars and “1500” is fifteen hundred.
`barcode`	`string`	The variant’s barcode.
`taxable`	`boolean`	Whether tax applies.
`inventoryItem`	VariantInventoryItem	SKU and stock tracking.

VariantOptionValue

One option value that distinguishes a variant, such as Size / Large.

Field	Type	Description
`name` *	`string`	The value, such as ‘Large’.
`optionName` *	`string`	The option it belongs to, such as ‘Size’.

VariantInventoryItem

The variant fields Shopify moved onto the inventory item.

Field	Type	Description
`sku`	`string`	The variant’s SKU.
`tracked`	`boolean`	Whether Shopify tracks stock for this variant.

ProductStatus

Value
`ACTIVE`
`ARCHIVED`
`DRAFT`

ProductSortKeys

Value
`CREATED_AT`
`ID`
`INVENTORY_TOTAL`
`PRODUCT_TYPE`
`PUBLISHED_AT`
`RELEVANCE`
`TITLE`
`UPDATED_AT`
`VENDOR`

OrderSortKeys

Value
`CREATED_AT`
`CURRENT_TOTAL_PRICE`
`CUSTOMER_NAME`
`DESTINATION`
`FINANCIAL_STATUS`
`FULFILLMENT_STATUS`
`ID`
`ORDER_NUMBER`
`PO_NUMBER`
`PROCESSED_AT`
`RELEVANCE`
`TOTAL_ITEMS_QUANTITY`
`TOTAL_PRICE`
`UPDATED_AT`

CustomerSortKeys

Value
`CREATED_AT`
`ID`
`LOCATION`
`NAME`
`RELEVANCE`
`UPDATED_AT`

InventoryStateName

Value
`available`
`damaged`
`quality_control`
`reserved`
`safety_stock`

InventoryAdjustReason

Value
`correction`
`cycle_count_available`
`damaged`
`movement_created`
`movement_updated`
`movement_received`
`movement_canceled`
`other`
`promotion`
`quality_control`
`received`
`reservation_created`
`reservation_deleted`
`reservation_updated`
`restock`
`safety_stock`
`shrinkage`

OrderCancelReason

Value
`CUSTOMER`
`DECLINED`
`FRAUD`
`INVENTORY`
`OTHER`
`STAFF`

ProductVariantsBulkCreateStrategy

Value
`DEFAULT`
`REMOVE_STANDALONE_VARIANT`

​Model tree

​ShopGetVariables

​ProductsListVariables

​ProductGetVariables

​ProductCreateVariables

​ProductCreateInput

​ProductUpdateVariables

​ProductUpdateInput

​OrdersListVariables

​OrderGetVariables

​CustomersListVariables

​CustomerGetVariables

​CustomerCreateVariables

​CustomerInput

​CustomerUpdateVariables

​CustomerUpdateInput

​OrderFulfillmentOrdersVariables

​FulfillmentCreateVariables

​FulfillmentInput

​FulfillmentOrderLineItems

​FulfillmentOrderLineItem

​FulfillmentTracking

​InventoryAdjustVariables

​InventoryAdjustInput

​InventoryChange

​VariantInventoryLevelVariables

​LocationsVariables

​OrderStateVariables

​OrderIdInput

​OrderCancelVariables

​DraftOrderCreateVariables

​DraftOrderCompleteVariables

​ProductVariantsBulkCreateVariables

​ProductVariantBulkInput

​VariantOptionValue

​VariantInventoryItem

​ProductStatus

​ProductSortKeys

​OrderSortKeys

​CustomerSortKeys

​InventoryStateName

​InventoryAdjustReason

​OrderCancelReason

​ProductVariantsBulkCreateStrategy