purchase_order

Purchase Order - Get Single By Number

Changed on

Retrieve a single purchase order by its PO number.

get/purchase_order/get_single_by_number

Request

  • Base URL
    https://api.skulabs.com
  • URL
    https://api.skulabs.com/purchase_order/get_single_by_number
  • Auth
    HTTP bearer

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

  • fa53dd949b8eRevision changes
    • breaking

      the query request parameter number became required

    • info

      api operation id get_purchase_order_get_single_by_number was added

    • info

      for the query request parameter number, the type was generalized from number to string, and format from integer to no format

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • e4bdf6984278Revision changes
    • breaking

      for the query request parameter fields, the type changed from array to object