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.

Response Details

NameTypeDescription
total_ordersintTotal number of purchase orders that are to be retrieved.
ordersobjectObject that contains the purchase orders-related elements. For more information, refer to the orders Object table.
ErrorobjectObject that contains error message and error code details.

orders Object

NameTypeDescription
order_idguidUnique 32-character identifier of the purchase order.
order_numberstringNumber of the purchase order.
center_namestringName of the center.
centerobjectDetails of the center.
codestringCode of the center.
addressobjectAddress of the center.
address1stringAddress1 of the center.
address2stringAddress2 of the center
citystringCity of the center.
statestringState of the center.
countryclosed_datestringCountry of the center.
zip_codestringZip code of the center.
vendor_namestringName of the vendor.
vendorobjectObject that contains all vendor details-related elements.
codestringCode of the vendor.
addressobjectAddress of the vendor.
address1stringAddress1 of the vendor.
address2stringAddress2 of the vendor.
citystringCity of the vendor.
statestringState of the vendor.
countrystringCountry of the vendor.
cststringCST details of the vendor.
tinDateTimeTIN details of the vendor.
ordered_dateDateTimeOrdered date of the order.
raised_dateDateTimeRaised date of the order.
closed_dateobjectclosed date of the order.
partialsintTotal quantity of the product.
invoice_noDateTimeinvoice details
delivered_dateobjectDelivered date of the order.
line_itemsstringObject that contains items in the order.
product_codestringProduct code.
product_namelistProduct name.
product_barcodesfloatProduct barcodes.
ordered_retail_quantityfloatRetail quantity ordered.
ordered_consumable_quantityfloatConsumable quantity ordered.
ordered_unit_pricestringUnit price ordered.
ordered_tax_group_namefloatOrdered tax group name.
ordered_tax_amountobjectOrdered tax amount.
ordered_tax_breakupstringOrdered tax breakup details.
tax_componentfloatOrdered tax component.
tax_amountfloatOrdered tax amount.
delivered_retail_quantityfloatRetail quantity delivered.
delivered_consumable_quantityfloatConsumable quantity delivered.
delivered_unit_pricefloatUnit price delivered.
delivered_discount_typefloatDelivered discount type.
delivered_discount_valuefloatDelivered discount value.
delivered_tax_group_namestringDelivered tax group name.
delivered_tax_amountfloatDelivered tax amount.
tax_componentstringTax component.
delivered_tax_breakupobjectDelivered tax breakup details.
tax_componentstringDelivery tax component.
tax_amountfloatDelivery tax amount.
notesstringInvoice notes.
discount_valuefloatOrder discount value.
shipping_and_handlingfloatShipping and handling charges.
other_chargesfloatOther charges.
notesstringOrder notes.
Language
Authorization
Header
Click Try It! to start a request and see the response here!