v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the list of transfer orders for a center

This API retrieves the list of transfer 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/transfer_orders?center_id={center_id}&start_date={start_date}&end_date={end_date}&show_delivery_details={show_delivery_details}&date_criteria={date_criteria}&status={status}

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 transfer orders are to be retrieved. The type of transfer 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 transfer orders that were delivered between Aug 5, 2020 and Aug 7, 2020 (both dates inclusive).

end_datestring date required

Mandatory Format: YYYY-MM-DD Date until which the required transfer orders are to be retrieved. The type of transfer 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 transfer orders that were delivered between Aug 5, 2020 and Aug 7, 2020 (both dates inclusive).

show_delivery_detailsboolean

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

date_criteria'3'

Optional Indicates the type of transfer orders that are to be fetched. Default value is 3. Values are as follows: 1 - Raised, 2 - Delivered, and 3 - Completed.

status'-1'

Optional Indicates the status of transfer orders Default value is -1. Values are as follows: 1 - Created, 2 - Raised, and -1 - Any.

Response

200