purchase_order

Purchase Order - Get Single By Number

Retrieve a single purchase order by its PO number.

get/purchase_order/get_single_by_number

Query parameters

numberstring required

PO number

fieldsobject

Projection fields object, e.g. { "name": 1 }

Response

Purchase order by number

Example response

{
  "purchase_order": {
    "_id": "507f1f77bcf86cd799439011",
    "log": [
      {
        "user_id": "507f1f77bcf86cd799439011",
        "time": "2025-01-15T12:00:00.000Z"
      }
    ],
    "due_date": "2025-01-15",
    "arrival_date": "2025-01-15",
    "closed_date": "2025-01-15",
    "tags": [
      "507f1f77bcf86cd799439011",
      "507f1f77bcf86cd799439012"
    ],
    "store_id": "507f1f77bcf86cd799439011"
  }
}

Changes

Changed in 4 of the 13 revisions of this API.419

Mar 2, 2026fa53dd949b8e18See the full diff
- ▲
  the query request parameter number became required
  request-parameter-became-required
- ○
  api operation id get_purchase_order_get_single_by_number was added
  api-operation-id-added
- ○
  for the query request parameter number, the type/format was generalized from number/integer to string/
  request-parameter-type-generalized
- ○
  added the media type application/json for the response with the status 200
  response-media-type-added
- ○
  added the media type application/json for the response with the status 400
  response-media-type-added
- ○
  added the media type application/json for the response with the status 401
  response-media-type-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
Apr 23, 2024e4bdf69842781See the full diff
- ▲
  for the query request parameter fields, the type/format was changed from array/ to object/
  request-parameter-type-changed
Apr 22, 202408cd9cfa14dd13See the full diff
- ▲
  for the query request parameter number, the type/format was changed from string/ to number/integer
  request-parameter-type-changed
- ○
  for the query request parameter fields, the type/format was generalized from string/ to array/
  request-parameter-type-generalized
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
Apr 19, 202446ceda52800018See the full diff
- ▲
  removed the media type application/json for the response with the status 200
  response-media-type-removed
- ○
  api operation id get_purchase_order_get_single_by_number removed and replaced with
  api-operation-id-removed
- ○
  the query request parameter number became optional
  request-parameter-became-optional
- ○
  for the query request parameter fields, the type/format was generalized from object/ to string/
  request-parameter-type-generalized
- ○
  removed the non-success response with the status 400
  response-non-success-status-removed
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
- ○
  removed the non-success response with the status 429
  response-non-success-status-removed
- ○
  removed the non-success response with the status 500
  response-non-success-status-removed
This revision also has 85 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history