GraphQL API
Organization API
Organization / Types/ object

PurchaseOrderLine

An line of an purchase order

Fields

7 fields
id•ID!

Unique primary key.

id•ID!

Unique primary key.

name•String!

Name of the ordered product

billingAddress•Address

Billing address of the order

brand•Brand!

Brand of the order

canceledAt•DateTimeTz

When the order was canceled.

createdAt•DateTimeTz!

When the order was created.

customer•Customer

Customer of the order

customsInvoiceNumber•String

Invoice number for customs

customsShipmentType•CustomsShipmentType

Shipment export type for customs

DOCUMENTSGIFTRETURNED_GOODSSALE_GOODSSAMPLE

Events related to this order

Exceptions related to this order

fulfillmentPreferences•OrderFulfillmentPreferences

Fulfillment preferences of the order.

fulfillments•FulfillmentConnection!

Fulfillments of the order

id•ID!

Unique primary key.

integration•Integration

Integration of the order

integrationReference•String

Integration reference of the order

isUpdatable•Boolean!

Whether this order can be updated.

Order lines

locale•String

BCP-47 locale used for communication templates

Metafields attached to this order

quantityAllocated•Int!

Quantity allocated in to fulfillments

quantityOrdered•Int!

Quantity ordered

quantityShipped•Int!

Quantity (already) shipped

quantityUnallocated•Int!

Quantity that is not (yet) allocated to a fulfillment

recipientAddress•Address

Recipient address of the order

reference•String

Reference of the order

Shipments

shippedAt•DateTimeTz

When the order was shipped.

shippingPrice•Money

Shipping cost paid by the customer

status•OrderStatus!

Status of the order

ALLOCATEDCANCELEDCREATEDEXPECTEDPARTIALLY_SHIPPEDSHIPPEDUNALLOCATED

Support tickets linked to this order

updatedAt•DateTimeTz!

When the order was last updated.

parentLine•OrderLine

Parent order line (for bundles)

currency•String!

ISO 4217 currency code

value•String!

Amount

currency•String!

ISO 4217 currency code

value•String!

Amount

Barcodes linked to this product

brandName•String

Brand name of the product

code•String

Article number of the product

costPrice•Money

Cost price of the product

countryCodeOfOrigin•String

Country code of origin of the product

createdAt•DateTimeTz!

When the product was created.

description•String

Goods description for customs in English

dimensions•Dimensions

Dimensions of the product

hsCode•String

HS code of the product

id•ID!

Unique primary key.

integrationProducts•IntegrationProductConnection!

The integration products associated with this product.

The media associated with this product.

Metafields attached to this product

name•String

Name of the product

Order lines of the product.

partOfBundles•ProductPartConnection!

List bundles

List parts

price•Money

Selling price of the product.

productSuppliers•ProductSupplierConnection!

Purchasing configuration for suppliers linked to this product.

productWarehouses•ProductWarehouseConnection!

The product warehouses associated with this product.

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

stockMutations•StockMutationConnection!

List stock mutations

List stocks

The suppliers associated with this product.

List linked tags

Type

PHYSICAL_BUNDLESTANDARDVIRTUAL_BUNDLE
updatedAt•DateTimeTz!

When the product was last updated.

weight•Weight

Weight of the product

quantityAllocated•Int!

Quantity allocated in to fulfillments

quantityOrdered•Int!

Quantity ordered

quantityShipped•Int!

Quantity (already) shipped

quantityUnallocated•Int!

Quantity that is not (yet) allocated to a fulfillment

currency•String!

ISO 4217 currency code

value•String!

Amount

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

CM
width•Float!

Width

hsCode•String

HS code of the product

id•ID!

Unique primary key.

A list of IntegrationProduct edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

A list of ProductMedia edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

A list of Metafield edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

name•String

Name of the product

A list of OrderLine edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

A list of ProductPart edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

A list of ProductPart edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

currency•String!

ISO 4217 currency code

value•String!

Amount

A list of ProductSupplier edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

A list of ProductWarehouse edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

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

A list of StockMutation edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

A list of Stock edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

A list of Supplier edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

edges•[TagEdge!]!

A list of Tag edges.

pageInfo•PageInfo!

Pagination information about the list of edges.

Type

PHYSICAL_BUNDLESTANDARDVIRTUAL_BUNDLE
updatedAt•DateTimeTz!

When the product was last updated.

Weight unit

GKGLBSOZ
value•Float!

Weight value

quantityOrdered•Int!

Quantity ordered

quantityReceived•Int!

Quantity received in completed goods receipts

sellAhead•Int!

Quantity to allow pre-orders for this order line