Przejdź do głównej zawartości

Order

Dla: Programista

Typ obiektowyOrder

A client's order at the print shop: the products to make, for whom, when and how to deliver them, and how the order is paid.

Pola

PoleTypOpis
additionalCosts[AdditionalCost!]

Additional costs of the order, on the order itself and on its products, by position. An empty list (never null) when there are none.

additionalCostsTotalFloat

Sum of the net amounts of all additional costs of the order, in the order currency. 0 (never null) when there are none.

Wymaga zakresu prices:read.

archivedBoolean!

True when the order was moved to the archive (only received or cancelled orders). An archived order cannot be changed, and neither can anything inside it: its products, costs, payments and files.

billingEntityIdID

Identifier of the print shop's billing entity that invoices the order; null while none is chosen.

clientClient

Client associated with this order.

Wymaga zakresu clients:read.

clientIdID!

Identifier of the client (the print shop's customer) the order is for.

completionDateDateTime

When the order is due to be completed (date and time). Null when not agreed yet.

contactOrderContact

Person to contact about the order; null when none was entered.

createdAtDateTime!

When the order was created.

currencyIdID

Identifier of the order currency, in which the order's prices, costs and payments are expressed. Null on older orders, which are in the print shop's home currency.

deliveries[OrderDelivery!]

Delivery addresses, in their order; empty for pickup or before the address is known.

displayIdString!

Order number people use in Prynt and on documents, for example 1084/2026. Unique; Prynt assigns it when the order is created.

exchangeRateFloat

Exchange rate from the order currency to the print shop's home currency, fixed when the currency was set (1 for the home currency). Null on older orders.

Wymaga zakresu prices:read.

files[File!]

Files attached to the order itself (files of its products are on Product.files), uploaded completely, newest first. An empty list (never null) when there are none.

Wymaga zakresu files:read.

idID!

Identifier of the order (UUID).

invoiceOrderInvoice

Billing details to put on the invoice; null when none were entered.

isDeadlineBoolean

True when completionDate is a strict deadline that must not move; false otherwise. Never null.

paymentDueDateDateTime

Day by which the client should pay (UTC midnight of that day); null when not set.

paymentMethodPaymentMethod

How the client pays; null while not chosen.

paymentStatusPaymentStatus!

Where payment of the order stands.

payments[OrderPayment!]

Payments received for the order, latest payment date first. An empty list (never null) when nothing was paid yet.

productionProductionProgress!

How far production of the order has got: the roll-up of the operations of all its products and elements.

Wymaga zakresu production:read.

products[Product!]

Products of the order, by their number within the order. An empty list (never null) when the order has none yet.

sourceOrderSource!

Channel the order came in through.

statusOrderStatus!

Stage of the order. Prynt moves it forward with production; see OrderStatus for who sets each value.

totalPackagesInt!

Number of packages the whole order ships in (0 when none).

totalPalletsInt!

Number of pallets the whole order ships on (0 when none).

transportMethodTransportMethod!

How the order reaches the client.

transportPriceFloat

Net price of transport in the order currency; null when not charged separately.

Wymaga zakresu prices:read.

updatedAtDateTime!

When the order or anything inside it (products, their elements and operations, payments, additional costs, files, contact, deliveries, invoice data) last changed, including every status change of the production tasks of its operations (one created, started, paused, resumed, completed or cancelled). Writing back the same values does not move it. Filter on it with updatedFrom to fetch only what changed since your last sync.

Używane w