---
title: "Get purchase order by number"
method: GET
path: "/v1/purchase-orders"
tags: ["Purchase Order Management"]
---

# Get purchase order by number

`GET /v1/purchase-orders`

## Request

- Base URL: `https://api.prod.goaugment.com`
- URL: `https://api.prod.goaugment.com/v1/purchase-orders`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/goaugment/apis/augment-api/docs/v1/purchase-orders/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a purchase order and its line items by the purchase order number you assigned. Purchase order numbers are unique within your system.

## Query parameters

- `purchaseOrderNumber` string, required

## Response `200`

Purchase order found and returned successfully

- PurchaseOrderResponse: A purchase order with its line items.
  - `id` string, required: Augment's identifier for the purchase order.
  - `purchaseOrderNumber` string, required
  - `internalPurchaseOrderNumber` string, nullable
  - `status` 'OPEN' | 'CLOSED' | 'CANCELED', required: Lifecycle state of a purchase order or one of its line items.
  - `purchaseOrderDate` string, date, required: The stored UTC calendar day.
  - `customData` object, nullable
  - `lineItems` PurchaseOrderLineItemResponse[], required
    - `id` string, required: Augment's identifier for the line item.
    - `lineNumber` string, required
    - `sku` string, nullable
    - `description` string, nullable
    - `orderedQuantity` integer, nullable
    - `openQuantity` integer, nullable
    - `unitOfMeasure` string, nullable
    - `unitPrice` string, nullable
    - `currency` string, required
    - `status` 'OPEN' | 'CLOSED' | 'CANCELED': Lifecycle state of a purchase order or one of its line items.
    - `expectedArrivalDate` string, date, nullable: The stored UTC calendar day this line is expected to arrive.
    - `customData` object, nullable
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Purchase order not found

---

[API](https://skmtc.dev/goaugment/apis/augment-api.md) - [All operations](https://skmtc.dev/goaugment/apis/augment-api/llms.txt) - [OpenAPI document](https://skmtc.dev/goaugment/apis/augment-api/revisions/b61097634d79?raw)