InboundShipmentItem

A line item received (or expected) on an inbound shipment.

createdAt · DateTime! · required

When the record was created.

damagedQuantity · Int! · required

The quantity received damaged for this line item.

id · ID! · required

The id of this shipment line item.

packingMode · PackingMode! · required

How this line item is packed.

product · Product

The product received on this line item.

Requires: products_read

Show fields

attribute · Attribute

Look up a single attribute on this product by its name, if set.

Requires: products_read

Show fields

Arguments

name · String! · required

The machine name of the attribute to look up.

Fields

description · String

An optional description of what the attribute represents.

displayName · String! · required

The human-readable label shown for the attribute.

id · ID! · required

The unique identifier of the attribute’s definition.

name · String! · required

The attribute’s machine name, unique within the account.

type · AttributeType! · required

The data type of the attribute’s value.

value · JSON

The attribute’s value, resolved to the typed JSON form for its type — read type to know the shape. E.g. SHORT_TEXT → a string, WEIGHT → { value, unit }, MONEY → { amount, currency }. Null if unset. See AttributeType for each type’s shape.

attributes · [Attribute!]! · required

The merchant-defined attributes set on this product.

Show fields

description · String

An optional description of what the attribute represents.

displayName · String! · required

The human-readable label shown for the attribute.

id · ID! · required

The unique identifier of the attribute’s definition.

name · String! · required

The attribute’s machine name, unique within the account.

type · AttributeType! · required

The data type of the attribute’s value.

value · JSON

The attribute’s value, resolved to the typed JSON form for its type — read type to know the shape. E.g. SHORT_TEXT → a string, WEIGHT → { value, unit }, MONEY → { amount, currency }. Null if unset. See AttributeType for each type’s shape.

barcodes · [String!]! · required

Barcodes associated with this product.

cost · Money

The merchant’s unit cost for the product.

Show fields

amount · Decimal! · required

The exact amount as a decimal string (e.g. “19.99”).

currency · String! · required

ISO 4217 currency code (e.g. USD).

createdAt · DateTime! · required

When the record was created.

description · String! · required

The product’s long-form description.

dimensions · Dimensions

The product’s length, width, and height, expressed in a single shared unit.

Show fields

height · Float

The height, in unit.

length · Float

The length, in unit.

unit · DimensionUnit! · required

The unit all three measurements are expressed in.

width · Float

The width, in unit.

hsCode · String

The Harmonized System code used for customs.

id · ID! · required

The id of this product.

image · ProductImage

The first (default) image for this product, if any.

Requires: products_read

Show fields

altText · String! · required

Alternative text describing the image.

default · Boolean! · required

Whether this is the default image.

id · ID! · required

The id of this image.

position · Int! · required

The image’s ordering position.

url · String! · required

The public URL of the image.

images · ProductImageConnection! · required

A paginated list of the product’s images.

Requires: products_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.

last · Int

Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.

Fields

edges · [ProductImageEdge!]! · required

The list of edges (each a node plus its pagination cursor).

nodes · [ProductImage!]! · required

The nodes in this page, without the edge/cursor wrapper — a convenience over edges.

pageInfo · PageInfo! · required

Pagination metadata for the current page.

inventoryLevel · LocationInventoryLevel

This product’s inventory level at a single location, if any.

Requires: inventory_read

Show fields

Arguments

locationId · ID! · required

The id of the location to fetch the level at.

Fields

available · Int! · required

The quantity available to sell.

buildable · Int! · required

The quantity that can be built from components.

committed · Int! · required

The quantity committed to existing orders.

createdAt · DateTime! · required

When the record was created.

id · ID! · required

The id of this inventory level.

inventoryProduct · InventoryProduct

A fulfillment-oriented view of the product, readable by anyone who can see this level (e.g. a 3PL). For the full product, use product.

Requires: inventory_read

location · Location

The location these inventory levels are held at.

Requires: locations_read

product · Product

The full product these inventory levels are for. Only readable by the account that owns the product; use inventoryProduct otherwise.

Requires: products_read

quantity · Int! · required

The total quantity on hand at the location.

reserved · Int! · required

The quantity reserved across all reservation buckets.

updatedAt · DateTime! · required

When the record was last updated.

inventoryLevels · LocationInventoryLevelConnection! · required

Per-location inventory levels for this product.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.

last · Int

Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.

Fields

edges · [LocationInventoryLevelEdge!]! · required

The list of edges (each a node plus its pagination cursor).

nodes · [LocationInventoryLevel!]! · required

The nodes in this page, without the edge/cursor wrapper — a convenience over edges.

pageInfo · PageInfo! · required

Pagination metadata for the current page.

options · [ProductOptionValue!]! · required

The variant’s selected option values (e.g. Size: M, Color: Red), ordered by the family’s option positions.

Show fields

name · String! · required

The option name, e.g. Size.

value · String! · required

The selected value, e.g. M.

originCountry · String

The country of origin, as a country code.

physicalItem · Boolean! · required

Whether the product is a physical, shippable item.

price · Money

The product’s selling price.

Show fields

amount · Decimal! · required

The exact amount as a decimal string (e.g. “19.99”).

currency · String! · required

ISO 4217 currency code (e.g. USD).

productFamily · ProductFamily

The product family this product belongs to, if any.

Requires: products_read

Show fields

attribute · Attribute

Look up a single attribute on this family by its name, if set.

Requires: products_read

Show fields

Arguments

name · String! · required

The machine name of the attribute to look up.

attributes · [Attribute!]! · required

The merchant-defined attributes set on this family.

createdAt · DateTime! · required

When the record was created.

description · String! · required

The product family’s long-form description.

id · ID! · required

The id of this product family.

image · ProductFamilyImage

The first (default) image for this family, if any.

Requires: products_read

images · ProductFamilyImageConnection! · required

A paginated list of the family’s images.

Requires: products_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.

last · Int

Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.

options · [ProductFamilyOption!]! · required

The variant options (e.g. Size, Color) for this family.

products · ProductConnection! · required

A paginated list of the products (variants) in this family.

Requires: products_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.

last · Int

Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.

tags · [String!]! · required

Free-form tags applied to the product family.

title · String! · required

The product family’s title.

updatedAt · DateTime! · required

When the record was last updated.

vendor · String

The vendor or manufacturer of the product family.

sku · String

The stock keeping unit identifying this product.

tags · [String!]! · required

Free-form tags applied to the product.

taxCode · String

The tax code used to classify the product for taxation.

taxable · Boolean! · required

Whether the product is subject to tax.

title · String! · required

The product’s title.

upc · String

The Universal Product Code for this product.

updatedAt · DateTime! · required

When the record was last updated.

vendor · String

The vendor or manufacturer of the product.

weight · Weight

The product’s weight.

Show fields

unit · WeightUnit! · required

The unit the value is expressed in.

value · Float! · required

The numeric magnitude of the weight.

purchaseOrder · PurchaseOrder

The purchase order this received item was ordered on, if any.

Requires: inventory_read

Show fields

closedAt · DateTime

When the purchase order was closed.

createdAt · DateTime! · required

When the record was created.

id · ID! · required

The id of this purchase order.

items · PurchaseOrderItemConnection! · required

A paginated list of the order’s line items.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.

last · Int

Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.

Fields

edges · [PurchaseOrderItemEdge!]! · required

The list of edges (each a node plus its pagination cursor).

nodes · [PurchaseOrderItem!]! · required

The nodes in this page, without the edge/cursor wrapper — a convenience over edges.

pageInfo · PageInfo! · required

Pagination metadata for the current page.

location · Location

The location the order’s inventory is destined for.

Requires: locations_read

Show fields

city · String

The city of the location’s address.

company · String

The company name associated with the location.

countryCode · String

The country code, e.g. “US”.

createdAt · DateTime! · required

When the record was created.

id · ID! · required

The id of this location.

inventoryLevels · LocationInventoryLevelConnection! · required

Per-product inventory levels held at this location.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.

last · Int

Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.

name · String! · required

The location’s display name.

phone · String

The contact phone number for the location.

postalCode · String

The postal or ZIP code, e.g. “84101”.

stateCode · String

The state or province code, e.g. “UT”.

street1 · String

The first line of the street address.

street2 · String

The second line of the street address.

updatedAt · DateTime! · required

When the record was last updated.

note · String

An internal note on the purchase order.

orderedAt · Date

The date the order was placed with the supplier.

poNumber · String! · required

The merchant-facing purchase order number.

referenceNumber · String

An external reference for the purchase order.

shipments · InboundShipmentConnection! · required

Inbound shipments fulfilling this purchase order.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.

last · Int

Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.

Fields

edges · [InboundShipmentEdge!]! · required

The list of edges (each a node plus its pagination cursor).

nodes · [InboundShipment!]! · required

The nodes in this page, without the edge/cursor wrapper — a convenience over edges.

pageInfo · PageInfo! · required

Pagination metadata for the current page.

status · PurchaseOrderStatus! · required

The current lifecycle status of the purchase order.

supplier · Supplier

The supplier the order was placed with.

Requires: inventory_read

Show fields

contacts · [SupplierContact!]! · required

The contact people at this supplier.

createdAt · DateTime! · required

When the record was created.

currency · String

The ISO 4217 currency code the supplier transacts in.

id · ID! · required

The id of this supplier.

leadTimeDays · Int

The supplier’s typical lead time, in days.

name · String! · required

The supplier’s name.

phone · String

The supplier’s phone number.

productVendors · [String!]! · required

Product vendor names associated with this supplier.

purchaseOrders · PurchaseOrderConnection! · required

Purchase orders placed with this supplier.

Requires: inventory_read

Show fields

Arguments

after · String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

before · String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

first · Int

Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.

last · Int

Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.

updatedAt · DateTime! · required

When the record was last updated.

website · String

The supplier’s website URL.

supplierNote · String

A note shared with the supplier.

tags · [String!]! · required

Free-form tags applied to the purchase order.

updatedAt · DateTime! · required

When the record was last updated.

quantity · Int! · required

The quantity expected on this line item.

receivedQuantity · Int! · required

The quantity received for this line item.

updatedAt · DateTime! · required

When the record was last updated.