Types > PurchaseOrder
Commerce APITypesPurchaseOrder
PurchaseOrder

Description

Topic: Purchase Orders

Fields

bill_to: Address

Billing address


created_at: String!

Date and time when purchase order was created

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


currency: String!

Currency code

Example: "USD"


date: String!

Order date

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


draft: Boolean!

Whether purchase order is in a draft state or not

Example: true


email_message: Message


expected_at: String!

Date and time when purchase order shipment is expected

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


from_supplier: Supplier

Supplier this purchase order refers to

Expandable

Permission bit: "suppliers.read"


id: String!

Unique purchase order identifier. See also: Unique Identifiers

Example: "po_EQzGqWoY"


line_items: [PurchaseOrderLineItem!]!


number: Int!

Purchase order sequential number

Example: 1


reference: String!

Arbitrary reference string

Example: "5435345"


send_email: Boolean!

Whether to send this PO to supplier via email or not (when submitted)

Example: false


shipping: Int!

Shipping price

Example: 0


status: PurchaseOrderStatus!

Status of the purchase order

Example: "not_received"


supplier_note: String!

Note that will be visible to supplier (as part of the email)

Example: "TODO"


tax_inclusive_prices: Boolean!

Whether prices include the tax or not

Example: false


to_inventory_location: InventoryLocation

Destination inventory location

Expandable

Permission bit: "inventory_locations.read"


updated_at: String!

Date and time when purchase order was last updated

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


Used By

Mutations

purchaseOrdersClose, purchaseOrdersCreate, purchaseOrdersModify, purchaseOrdersOpen, purchaseOrdersReceive, purchaseOrdersReject

Queries

purchaseOrders

Types

PurchaseOrderExpandableItems, PurchaseOrderPage, PurchaseOrderSearchResult, UnifiedSearchResult

Preview (typescript)

Loading module