GET All Purchase Orders by Status

Developing

GET

{{url}}api/v1/admin/purchase/orders/status/{status}

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'http://ecompulse.test/api/v1/admin/purchase/orders/status/2' \
--header 'Accept: application/json' \
--header 'X-API-Key: exzbLclGAzBCyL0k1Yv29Evu6mwoYOATBF0lWPyT'

Response Example

{
    "status": "success",
    "message": "Purchases retrieved successfully",
    "data": [
        {
            "id": 2,
            "reference_no": "PO-00002",
            "draft_date": null,
            "open_date": "2024-05-24",
            "closed_date": "2024-05-21",
            "canceled_date": null,
            "expected_date": null,
            "note": null,
            "order_tax": "580.65",
            "order_shipping": "10.00",
            "order_discount": "0.00",
            "grand_total": "6,397.15",
            "warehouse": {
                "id": 1,
                "name": "Warehouse 1"
            },
            "vendor": {
                "id": 1,
                "name": "James Peter"
            },
            "status": 2,
            "products": [
                {
                    "id": 5,
                    "sku": "P5",
                    "name": "Freedom Body Corn Dress",
                    "total_qty": 17,
                    "price": "42.00",
                    "qty": 17,
                    "cost": "37.00",
                    "product_net_cost": "37.00",
                    "discount": "0.00",
                    "weight_based_price": "0.00",
                    "product_cost_tax": "0.00",
                    "subtotal": "629.00",
                    "tax_method_id": null,
                    "tax_id": null,
                    "option_id": null,
                    "option_values": null
                },
                ...
                ...
                ...
            ]
        },
        ...
        ...
        ...
    ]
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

status

integer

required

Status (0:Draft, 1:Open, 2:Closed, 3:Canceled)

Example:

Header Params

string

required

Example:

application/json

X-API-Key

string

required

Example:

Responses

🟢200Success

application/json

Body

object {0}

Modified at 2024-05-27 02:37:06

PUT Purchase Order

PUT Purchase Order Status