v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the list of purchase orders for a center

This API retrieves the list of purchase orders for the specified center during the specified time period.

You must specify appropriate details for the center_id,start_date, and end_date parameters. Optionally, you can provide details for the show_delivery_details,date_criteria, and status parameters.

get/v1/inventory/purchase_orders

Query parameters

center_idstring required

Mandatory Unique 32-character identifier of the center.

start_datestring date required

Mandatory Format: YYYY-MM-DD Start date beginning from which the required purchase orders are to be retrieved. The type of purchase orders to be retrieved depends on the value of the date_criteria parameter. For example, if you specify start_date as 2020-09-05, end_date as 2020-09-07, and date_criteria as 2, this API will retrieve all the purchase orders that were delivered between Sep 5, 2020 and Sep 7, 2020 (both dates inclusive).

end_datestring date required

Mandatory Format: YYYY-MM-DD Date until which the required purchase orders are to be retrieved. The type of purchase orders to be retrieved depends on the value of the date_criteria parameter. For example, if you specify start_date as 2020-09-05, end_date as 2020-09-07, and date_criteria as 2, this API will retrieve all the purchase orders that were delivered between Sep 5, 2020 and Sep 7, 2020 (both dates inclusive).

show_delivery_detailsboolean

Optional Indicates whether the delivery details of the purchase orders are to be displayed. Default value is false.

date_criteria'1' | '2' | '3' | '4'

Optional Indicates the type of purchase orders that are to be fetched. Default value is 4. Values are as follows: 1 - Raised, 2 - Delivered, 3 - Completed and 4 - All (fetch purchase orders across all statuses). Note: Delivered will only contain fully delivered purchase orders. It will not fetch partially delivered purchase orders. Completed will fetch both fully delivered and partially delivered purchase orders.`

status'-1' | '1' | '2'

Optional Indicates the status of purchase orders Default value is -1. Values are as follows: 1 - Created, 2 - Raised, and -1 - Any. Note: To retrieve purchase orders in Created/Raised status, use date_criteria=4 with the appropriate status.

Response

200