purchase_order

Purchase Order - Get By Status

Changed on

Retrieve purchase orders filtered by their current status.

get/purchase_order/get_by_status

Request

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

Query parameters

status'closed' | 'created' | 'receiving' | 'acknowledged' | 'sent' | 'edited' | 'transit' | 'accepting' required

PO status to filter by

Response

Purchase orders by status

Example response

{
  "purchase_orders": [
    {
      "_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 status was restricted to a list of enum values

    • breaking

      the query request parameter status became required

    • info

      api operation id get_purchase_order_get_by_status was added

    • info

      added the new enum value accepting to the query request parameter status

    • info

      added the new enum value acknowledged to the query request parameter status

    • info

      added the new enum value closed to the query request parameter status

    • info

      added the new enum value created to the query request parameter status

    • info

      added the new enum value edited to the query request parameter status

    • info

      added the new enum value receiving to the query request parameter status

    • info

      added the new enum value sent to the query request parameter status

    • info

      added the new enum value transit to the query request parameter 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 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

  • 08cd9cfa14ddRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status