GOgoaugment
Purchase Order Management

Create purchase order

Create a purchase order along with its line items and its vendor and buyer contact records, in a single call.

This endpoint creates only. A purchaseOrderNumber you have already used returns 409 Conflict rather than updating the existing purchase order.

The vendor and contacts are matched before being created: reusing a vendor.vendorCode or a contact you have sent before links the new purchase order to the existing record instead of duplicating it.

purchaseOrderDate accepts either a calendar day (2026-08-18) or a full timestamp; only the UTC calendar day is stored.

post/v1/purchase-orders

Request

Request body

Example request

{
  "purchaseOrder": {
    "purchaseOrderNumber": "PO-1001",
    "purchaseOrderDate": "2026-08-18"
  },
  "lineItems": [
    {
      "lineNumber": "1",
      "unitOfMeasure": "CASE",
      "unitPrice": "12.50",
      "expectedArrivalDate": "2026-09-02"
    }
  ],
  "vendor": {
    "name": "Acme Foods",
    "vendorCode": "ACME"
  },
  "vendorContact": {
    "email": "vic@acmefoods.example",
    "phone": "+13125550100"
  },
  "buyerContact": {
    "email": "dana@example.com",
    "phone": "+13125550100",
    "phoneExtension": "204"
  }
}

Response

Purchase order created successfully

idstring required

Augment's identifier for the purchase order.

purchaseOrderNumberstring required
internalPurchaseOrderNumberstring nullable
status'OPEN' | 'CLOSED' | 'CANCELED' required

Lifecycle state of a purchase order or one of its line items.

purchaseOrderDatestring date required

The stored UTC calendar day.

customDataobject nullable
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "id": "01JPURCHASEORDERRECORD0001",
  "purchaseOrderNumber": "PO-1001",
  "purchaseOrderDate": "2026-08-18",
  "lineItems": [
    {
      "expectedArrivalDate": "2026-09-02"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.