Skip to main content

SupplierOrder

A purchase order raised against a supplier. Carries header data (supplier, currency, warehouse, dates), per-line procurement details, and the totals and tax status used by accounting. Goods are booked in against the supplier order via GoodsReceipt.

type SupplierOrder implements Node {
id: ID!
actualDeliveryDate: DateTime
amountNet: Float
amountTotal: Float
createdAt: DateTime!
currencyFactor: Float!
currencyFactorCapturedAt: DateTime
currencyId: ID!
customFields: JSON
dueDate: DateTime
expectedDeliveryDate: DateTime
internalComment: String
number: String!
orderDateTime: DateTime!
paymentState: SupplierOrderPaymentState!
positionPrice: Float
salesChannelId: ID
state: SupplierOrderState!
supplierId: ID
supplierOrderNumber: String
taxStatus: String
taxationType: SupplierTaxationType!
updatedAt: DateTime
warehouseId: ID
currency: Currency
goodsReceiptLineItems(
first: Int = 10
after: String
filter: GoodsReceiptLineItemFilterInput
): GoodsReceiptLineItemConnection
goodsReceipts(
first: Int = 10
after: String
filter: GoodsReceiptFilterInput
): GoodsReceiptConnection
lineItems(
first: Int = 10
after: String
filter: SupplierOrderLineItemFilterInput
): SupplierOrderLineItemConnection
salesChannel: SalesChannel
supplier: Supplier
tags(
first: Int = 10
after: String
filter: TagFilterInput
): TagConnection
warehouse: Warehouse
}

Fields​

SupplierOrder.id ● ID! non-null scalar​

Global identifier for this entity.

SupplierOrder.actualDeliveryDate ● DateTime scalar​

Date the supplier actually delivered.

SupplierOrder.amountNet ● Float scalar​

Net total in the order's currency, excluding tax.

SupplierOrder.amountTotal ● Float scalar​

Grand total in the order's currency, including tax.

SupplierOrder.createdAt ● DateTime! non-null scalar​

Timestamp the supplier order was created.

SupplierOrder.currencyFactor ● Float! non-null scalar​

Exchange rate of the order's currency at the time the order was raised or its currency was last changed, as units of that currency per one unit of the system default currency. Used to show the order total in the system default currency; stock is valued with the exchange rate of the goods receipt (GoodsReceipt.currencyFactor), not with this one.

SupplierOrder.currencyFactorCapturedAt ● DateTime scalar​

Timestamp currencyFactor was taken. Null for orders raised before exchange rates were recorded.

SupplierOrder.currencyId ● ID! non-null scalar​

ID of the currency the order is denominated in. Taken from the supplier when the order is raised, unless createSupplierOrder names another one. Can be changed in the Administration until the order is completed or cancelled, one of its goods receipts is completed, or one of its goods receipts also belongs to another supplier order.

SupplierOrder.customFields ● JSON scalar​

Custom fields configured for supplier orders, as a JSON object keyed by custom field technical name. Null when no custom fields are set. Write via setSupplierOrderCustomFields.

SupplierOrder.dueDate ● DateTime scalar​

Due date for paying the supplier.

SupplierOrder.expectedDeliveryDate ● DateTime scalar​

Date the supplier promised delivery. Defaulted from the line items' expected dates; can be tightened via updateSupplierOrderExpectedDeliveryDate.

SupplierOrder.internalComment ● String scalar​

Free-form internal note. Not printed on the document sent to the supplier.

SupplierOrder.number ● String! non-null scalar​

Internal supplier order number. Used in the admin UI and on documents.

SupplierOrder.orderDateTime ● DateTime! non-null scalar​

Timestamp the supplier order was raised.

SupplierOrder.paymentState ● SupplierOrderPaymentState! non-null enum​

Payment state of the supplier order.

SupplierOrder.positionPrice ● Float scalar​

Sum of all line item prices before order-level discounts/charges, in the order's currency.

SupplierOrder.salesChannelId ● ID scalar​

ID of the sales channel the supplier order is attributed to. Drives the default tax / currency setup.

SupplierOrder.state ● SupplierOrderState! non-null enum​

State of the supplier order.

SupplierOrder.supplierId ● ID scalar​

ID of the supplier.

SupplierOrder.supplierOrderNumber ● String scalar​

Order number assigned by the supplier (i.e. how the supplier references this order).

SupplierOrder.taxStatus ● String scalar​

Tax status of the order (gross, net, tax-free).

SupplierOrder.taxationType ● SupplierTaxationType! non-null enum​

Taxation type the order was raised with, taken from the supplier's override or derived from the countries of the supplier and of the company. Decides the tax rate of the line items.

SupplierOrder.updatedAt ● DateTime scalar​

Timestamp of the last update to the supplier order itself, including a state change. A change to its line items alone does not necessarily update it, see SupplierOrderLineItem.updatedAt.

SupplierOrder.warehouseId ● ID scalar​

ID of the warehouse the goods are destined for.

SupplierOrder.currency ● Currency object​

SupplierOrder.goodsReceiptLineItems ● GoodsReceiptLineItemConnection object​

SupplierOrder.goodsReceiptLineItems.first ● Int scalar​
SupplierOrder.goodsReceiptLineItems.after ● String scalar​
SupplierOrder.goodsReceiptLineItems.filter ● GoodsReceiptLineItemFilterInput input​

SupplierOrder.goodsReceipts ● GoodsReceiptConnection object​

SupplierOrder.goodsReceipts.first ● Int scalar​
SupplierOrder.goodsReceipts.after ● String scalar​
SupplierOrder.goodsReceipts.filter ● GoodsReceiptFilterInput input​

SupplierOrder.lineItems ● SupplierOrderLineItemConnection object​

SupplierOrder.lineItems.first ● Int scalar​
SupplierOrder.lineItems.after ● String scalar​
SupplierOrder.lineItems.filter ● SupplierOrderLineItemFilterInput input​

SupplierOrder.salesChannel ● SalesChannel object​

SupplierOrder.supplier ● Supplier object​

SupplierOrder.tags ● TagConnection object​

SupplierOrder.tags.first ● Int scalar​
SupplierOrder.tags.after ● String scalar​
SupplierOrder.tags.filter ● TagFilterInput input​

SupplierOrder.warehouse ● Warehouse object​

Interfaces​

Node interface​

Any entity that can be loaded by its global id through the node(id: ID!) query.

Returned By​

addSupplierOrderLineItem mutation ● cancelOpenSupplierOrderQuantities mutation ● cancelSupplierOrder mutation ● createSupplierOrder mutation ● markSupplierOrderAsConfirmed mutation ● markSupplierOrderAsOrdered mutation ● markSupplierOrderAsPaid mutation ● markSupplierOrderAsPartiallyPaid mutation ● markSupplierOrderAsUnpaid mutation ● removeSupplierOrderLineItem mutation ● setSupplierOrderCustomFields mutation ● supplierOrder query ● updateSupplierOrderExpectedDeliveryDate mutation ● updateSupplierOrderLineItem mutation

Member Of​

GoodsReceiptLineItem object ● SupplierOrderEdge object ● SupplierOrderLineItem object

Webhook topics​

TopicFires when
supplier-order/cancelled
Required scopesupplier_orders:read
A supplier order is cancelled.
supplier-order/completed
Required scopesupplier_orders:read
A supplier order is completed. Open quantities are cancelled at that point.
supplier-order/confirmed
Required scopesupplier_orders:read
A supplier order reaches the state confirmed.
supplier-order/created
Required scopesupplier_orders:read
A supplier order is created.
supplier-order/delivered
Required scopesupplier_orders:read
A supplier order reaches the state delivered.
supplier-order/expected-delivery-date-changed
Required scopesupplier_orders:read
The expected delivery date of a supplier order or of one of its line items changes, including when it is set automatically on confirmation.
supplier-order/line-items-changed
Required scopesupplier_orders:read
The ordered content of a supplier order changes: a line item is added or removed, or the ordered quantity or price of a line item changes.
supplier-order/partially-delivered
Required scopesupplier_orders:read
A supplier order reaches the state partially delivered.
supplier-order/sent-to-supplier
Required scopesupplier_orders:read
A supplier order reaches the state sent to supplier.

The webhooks guide explains how to subscribe to a topic and verify the notifications it sends.