GraphQL API
Organization API
Organization / Types/ object

Product

A product of the company

Fields

33 fields
barcode•String!

Barcode

id•ID!

Unique primary key.

quantity•Int!

Quantity of items when scanned

brandName•String

Brand name of the product

code•String

Article number of the product

currency•String!

ISO 4217 currency code

value•String!

Amount

countryCodeOfOrigin•String

Country code of origin of the product

createdAt•DateTimeTz!

When the product was created.

description•String

Goods description for customs in English

height•Float!

Height

length•Float!

Length

unit•DimensionsUnit!

Unit

CM
width•Float!

Width

hsCode•String

HS code of the product

id•ID!

Unique primary key.

cursor•String!

A unique cursor that can be used for pagination.

node•IntegrationProduct!

The IntegrationProduct node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

cursor•String!

A unique cursor that can be used for pagination.

node•ProductMedia!

The ProductMedia node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

cursor•String!

A unique cursor that can be used for pagination.

node•Metafield!

The Metafield node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

name•String

Name of the product

cursor•String!

A unique cursor that can be used for pagination.

node•OrderLine!

The OrderLine node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

cursor•String!

A unique cursor that can be used for pagination.

node•ProductPart!

The ProductPart node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

cursor•String!

A unique cursor that can be used for pagination.

node•ProductPart!

The ProductPart node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

currency•String!

ISO 4217 currency code

value•String!

Amount

cursor•String!

A unique cursor that can be used for pagination.

node•ProductSupplier!

The ProductSupplier node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

cursor•String!

A unique cursor that can be used for pagination.

node•ProductWarehouse!

The ProductWarehouse node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

purchaseAdviceMode•PurchaseAdviceMode!

How purchasing advice is calculated for this product.

BACKORDERS_ONLYTARGET_STOCK
quantityAllocated•Int!

Quantity allocated to fulfillments

quantityAvailable•Int!

Quantity available

quantityIncoming•Int!

Quantity incoming on open purchase orders.

quantityOnHand•Int!

Quantity on hand in warehouses

quantityUnallocated•Int!

Total quantity unallocated (backorders) across all order lines

cursor•String!

A unique cursor that can be used for pagination.

node•StockMutation!

The StockMutation node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

cursor•String!

A unique cursor that can be used for pagination.

node•Stock!

The Stock node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

cursor•String!

A unique cursor that can be used for pagination.

node•Supplier!

The Supplier node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

cursor•String!

A unique cursor that can be used for pagination.

node•Tag!

The Tag node.

endCursor•String

The cursor to continue paginating forwards.

hasNextPage•Boolean!

When paginating forwards, are there more items?

hasPreviousPage•Boolean!

When paginating backwards, are there more items?

startCursor•String

The cursor to continue paginating backwards.

type•ProductType!

Type

PHYSICAL_BUNDLESTANDARDVIRTUAL_BUNDLE
updatedAt•DateTimeTz!

When the product was last updated.

unit•WeightUnit!

Weight unit

GKGLBSOZ
value•Float!

Weight value