ActivateAuthenticateAmplify
API Reference
DashboardSupportDeveloper Blog
Start typing to search…

Purchase Orders

❗Enterprise Feature

This feature is only available to customers with an enterprise Platform subscription. Please get in touch to discuss enabling it on your account.

The Purchase Orders API allows solution developers to store information in the Platform describing the purchase orders in their supply chain. This is normally done at the time when products are ordered from a supplier, supplying a record of exact quantities ordered.

Each purchase order created contains details on the parties involved in the creation of that order (such as the manufacturer or supplier, and the buyer), as well as the product type or SKU being produced and at which quantities.

API Status General availability: /purchaseOrders /purchaseOrders/:purchaseOrderId

PurchaseOrderDocument Data Model

An object representing a purchase order.

.id (string, required)
    The purchase order ID.

.evrythngId (string, read-only)
    Standard 24 character EVRYTHNG ID of this purchase order.

.createdAt (integer, read-only)
    Timestamp when the resource was created.

.updatedAt (integer, read-only)
    Timestamp when the resource was updated.

.version (string)
    The latest version of the purchase order.

.status (string, required)
    The status of the purchase order, such as 'open' or
    'cancelled'.

.purchaser (string)
    The name of the purchasing party.

.description (string)
    Friendly description of this resource.

.type (string, required)
    The type of purchase order determines how the manufacturer
    interprets the Order, such as 'stand-alone', 'reorder',
    'direct-ship'.

.issueDate (string, required)
    The date the purchase order was issued, in YYYY-MM-DD
    format.

.parties (array of PurchaseOrderPartyDocument, max. 13, required)
    The parties involved in the purchase order. Must contain one
    item for each of 'ship-from', 'ship-to', and 'supplier'.

.lines (array of LineItemDocument, max. 1000, required)
    Line Items outlining the products, quantities and dates
    included in the purchase order.

.tags (array of string)
    Array of string tags associated with this resource.

.customFields (CustomFieldsDocument)
    Object of case-sensitive key-value pairs of custom fields
    associated with the resource.

.identifiers (IdentifiersDocument)
    Various identifiers (EPC, GTIN, etc.) as a JSON object with
    one or more key-value pairs.

See also: PurchaseOrderPartyDocument, LineItemDocument

Filterable Fields

This resource type can be filtered using the following fields and operators.

PurchaseOrderPartyDocument Data Model

See also: AddressDocument

LineItemDocument Data Model

A single line item.

Create a Purchase Order

Read all Purchase Orders

List purchase orders in an account

Read a Purchase Order

Purchase Order resources can be read from the API using the id originally supplied in the creation request.

Update a Purchase Order

Update a Purchase Order by submitting a full update to the original resource. A partial update with a partial payload is possible for the following properties: version, status, purchaser, description, type, issueDate, parties, identifiers, customFields, tags.

Delete a Purchase Order

Delete a single Purchase Order by ID.