get https://api.zenoti.com/v1/inventory/transfer_orders?center_id=&start_date=&end_date=&show_delivery_details=&date_criteria=&status=
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.
Response Details
Name | Type | Description |
---|---|---|
total_orders | int | Total number of transfer orders that are to be retrieved. |
orders | object | Object that contains the transfer 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 transfer order. |
order_number | string | Number of the transfer 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. |
country | string | Country of the vendor. |
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 | Address1 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 | string | TIN details of the vendor. |
ordered_date | DateTime | Ordered date of the order. |
raised_date | DateTime | Raised date of the order. |
closed_date | DateTime | closed date of the order. |
partials | object | Total quantity of the product. |
invoice_no | int | invoice details |
delivered_date | DateTime | Delivered date of the order. |
line_items | object | Object that contains items in the order. |
product_code | string | Product code. |
product_name | string | Product name. |
product_barcodes | list | Product barcodes. |
ordered_retail_quantity | float | Retail quantity ordered. |
ordered_consumable_quantity | float | Consumable quantity ordered. |
ordered_unit_price | float | Unit price ordered. |
ordered_tax_group_name | string | Ordered tax group name. |
ordered_tax_amount | float | Ordered tax amount. |
ordered_tax_breakup | object | Ordered tax breakup details. |
tax_component | string | 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. |