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.

Body·
required
application/json

Creates a purchase order together with its line items and its vendor and buyer contact records.

  • buyerContact
    Type: object
    required

    The buying contact at your organization. At least one of email or phone is required.

  • lineItems
    Type: array object[] ·
    required

    The ordered lines. May be empty.

    One ordered line on a purchase order.

  • purchaseOrder
    Type: object
    required
  • vendor
    Type: object
    required

    The vendor shipping the purchase order. Matched on vendorCode within your system: an existing vendor is reused rather than duplicated.

  • vendorContact
    Type: object nullable

    A contact at the vendor. At least one of email or phone is required when supplied.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/v1/purchase-orders
curl https://api.prod.goaugment.com/v1/purchase-orders \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic username:password' \
  --data '{
  "purchaseOrder": {
    "purchaseOrderNumber": "PO-1001",
    "internalPurchaseOrderNumber": "INT-7",
    "status": "OPEN",
    "purchaseOrderDate": "2026-08-18"
  },
  "lineItems": [
    {
      "lineNumber": "1",
      "sku": "SKU-1",
      "description": "Canned tomatoes, 12 ct",
      "orderedQuantity": 100,
      "openQuantity": 100,
      "unitOfMeasure": "CASE",
      "unitPrice": "12.50",
      "currency": "USD",
      "status": "OPEN",
      "expectedArrivalDate": "2026-09-02"
    }
  ],
  "vendor": {
    "name": "Acme Foods",
    "vendorCode": "ACME"
  },
  "vendorContact": {
    "name": "Vic Vendor",
    "email": "vic@acmefoods.example"
  },
  "buyerContact": {
    "name": "Dana Buyer",
    "email": "dana@example.com",
    "phone": "+13125550100",
    "phoneExtension": "204"
  }
}'

{
  "id": "01JPURCHASEORDERRECORD0001",
  "purchaseOrderNumber": "PO-1001",
  "internalPurchaseOrderNumber": "string",
  "status": "OPEN",
  "purchaseOrderDate": "2026-08-18",
  "customData": {},
  "lineItems": [
    {
      "id": "string",
      "lineNumber": "string",
      "sku": "string",
      "description": "string",
      "orderedQuantity": 1,
      "openQuantity": 1,
      "unitOfMeasure": "string",
      "unitPrice": "string",
      "currency": "string",
      "status": "OPEN",
      "expectedArrivalDate": "2026-09-02",
      "customData": {}
    }
  ],
  "createdAt": "2026-09-01T22:38:15.521Z",
  "updatedAt": "2026-09-01T22:38:15.521Z"
}

Purchase order created successfully