Retrieve the list of purchase orders for a center

get

https://api.zenoti.com/v1/inventory/purchase_orders

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Response Details

Name	Type	Description
total_orders	int	Total number of purchase orders that are to be retrieved.
orders	object	Object that contains the purchase orders-related elements. For more information, refer to the orders Object table.
Error	object	Object that contains error message and error code details.

orders Object

Name	Type	Description
order_id	guid	Unique 32-character identifier of the purchase order.
order_number	string	Number of the purchase order.
center_name	string	Name of the center.
center	object	Details of the center.
code	string	Code of the center.
address	object	Address of the center.
address1	string	Address1 of the center.
address2	string	Address2 of the center
city	string	City of the center.
state	string	State of the center.
countryclosed_date	string	Country of the center.
zip_code	string	Zip code of the center.
vendor_name	string	Name of the vendor.
vendor	object	Object that contains all vendor details-related elements.
code	string	Code of the vendor.
address	object	Address of the vendor.
address1	string	Address1 of the vendor.
address2	string	Address2 of the vendor.
city	string	City of the vendor.
state	string	State of the vendor.
country	string	Country of the vendor.
cst	string	CST details of the vendor.
tin	DateTime	TIN details of the vendor.
ordered_date	DateTime	Ordered date of the order.
raised_date	DateTime	Raised date of the order.
closed_date	object	closed date of the order.
partials	int	Total quantity of the product.
invoice_no	DateTime	invoice details
delivered_date	object	Delivered date of the order.
line_items	string	Object that contains items in the order.
product_code	string	Product code.
product_name	list	Product name.
product_barcodes	float	Product barcodes.
ordered_retail_quantity	float	Retail quantity ordered.
ordered_consumable_quantity	float	Consumable quantity ordered.
ordered_unit_price	string	Unit price ordered.
ordered_tax_group_name	float	Ordered tax group name.
ordered_tax_amount	object	Ordered tax amount.
ordered_tax_breakup	string	Ordered tax breakup details.
tax_component	float	Ordered tax component.
tax_amount	float	Ordered tax amount.
delivered_retail_quantity	float	Retail quantity delivered.
delivered_consumable_quantity	float	Consumable quantity delivered.
delivered_unit_price	float	Unit price delivered.
delivered_discount_type	float	Delivered discount type.
delivered_discount_value	float	Delivered discount value.
delivered_tax_group_name	string	Delivered tax group name.
delivered_tax_amount	float	Delivered tax amount.
tax_component	string	Tax component.
delivered_tax_breakup	object	Delivered tax breakup details.
tax_component	string	Delivery tax component.
tax_amount	float	Delivery tax amount.
notes	string	Invoice notes.
discount_value	float	Order discount value.
shipping_and_handling	float	Shipping and handling charges.
other_charges	float	Other charges.
notes	string	Order notes.

Query Params

center_id

string

required

Defaults to {center_id}

Mandatory Unique 32-character identifier of the center.

start_date

date

required

Defaults to 2022-11-11

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_date

date

required

Defaults to 2022-11-12

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_details

boolean

Defaults to false

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

date_criteria

string

enum

Defaults to 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.`

Allowed:

status

string

enum

Defaults to -1

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.

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Response Details

orders Object

200200

400400