purchase_order

Purchase Order - Get By Status

Retrieve purchase orders filtered by their current status.

get/purchase_order/get_by_status

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

Changed in 3 of the 13 revisions of this API.1124

  • fa53dd949b8e215See the full diff
    • the query request parameter status was restricted to a list of enum values

      request-parameter-became-enum

    • the query request parameter status became required

      request-parameter-became-required

    • api operation id get_purchase_order_get_by_status was added

      api-operation-id-added

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

      request-parameter-enum-value-added

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

      request-parameter-enum-value-added

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

      request-parameter-enum-value-added

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

      request-parameter-enum-value-added

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

      request-parameter-enum-value-added

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

      request-parameter-enum-value-added

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

      request-parameter-enum-value-added

    • added the new enum value transit to the query request parameter status

      request-parameter-enum-value-added

    • 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

    • 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

  • 46ceda52800097See the full diff
    • removed the enum value accepting from the query request parameter status

      request-parameter-enum-value-removed

    • removed the enum value acknowledged from the query request parameter status

      request-parameter-enum-value-removed

    • removed the enum value closed from the query request parameter status

      request-parameter-enum-value-removed

    • removed the enum value created from the query request parameter status

      request-parameter-enum-value-removed

    • removed the enum value edited from the query request parameter status

      request-parameter-enum-value-removed

    • removed the enum value receiving from the query request parameter status

      request-parameter-enum-value-removed

    • removed the enum value sent from the query request parameter status

      request-parameter-enum-value-removed

    • removed the enum value transit from the query request parameter status

      request-parameter-enum-value-removed

    • removed the media type application/json for the response with the status 200

      response-media-type-removed

    • api operation id get_purchase_order_get_by_status removed and replaced with

      api-operation-id-removed

    • the query request parameter status became optional

      request-parameter-became-optional

    • 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