Description

Modify one or multiple purchase orders.

Permission bit: "purchase_orders.modify"

Topic: Purchase Orders

Arguments

data: [PurchaseOrderModify!]!

Main argument for mutations.

ids: [String!]!

List of purchase order ids. See also: Unique Identifiers

Example: ["po_EQzGqWoY"]

shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"

Data Argument Fields

bill_to: AddressCreate

Bill to address

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

expected_at: String

Date and time when purchase order shipment is expected

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

Timestamp (RFC 3339)

from_supplier_id: String

Unique supplier id (source)

Example: "su_EQzGqWoY"

Valid when: from_supplier_id matches regexp pattern: ^su_

line_items: [PurchaseOrderLineItemCreate!]

reference: String

Arbitrary reference string

Example: "5435345"

Valid when: reference's length doesn't exceed 250 characters

send_email: Boolean

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

Example: false

shipping: Int

Shipping price

Example: 0

Valid when: shipping is a non-negative integer

supplier_note: String

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

Example: "TODO"

Valid when: supplier_note's length doesn't exceed 4096 characters

tax_inclusive_prices: Boolean

Whether prices include the tax or not

Example: false

to_inventory_location_id: String

Unique inventory location id (destination)

Example: "il_EQzGqWoY"

Valid when: to_inventory_location_id matches regexp pattern: ^il_

Result

[PurchaseOrder!]

Preview (typescript)

Loading module