Order Details

Get order details

[GET] /api/v6/sale_orders/{id}

Fields	Type	Description
id	integer	Identifier
order_code	string	Order code
real_amount	numeric	Total order amount
f_amount	numeric	Total paid amount
discount	numeric	Discount percentage
discount_amount	numeric	Discount amount
vat_amount	numeric	VAT amount
account_id	integer	Customer identifier
account_code	string	Customer code
account_email	string	Customer email
account_phone	numeric	Customer phone number
account_address	string	Customer address
contact_name	string	Contact name
contact_phone	string	Contact phone number
contact_email	string	Contact email
order_date	string	Order date in (Y-m-d) format
created_at	string	Creation date in (Y-m-d H:i:s) format
updated_at	string	Modification date in (Y-m-d H:i:s) format
status	integer	Status
status_label	string	Status name
store_id	integer	Warehouse identifier
assigned_user	integer	Order executor
assigned_user_name	string	Executor name
payment_status	string	Payment status (must also pass has_pay_off)
order_details	array	Product information in the order
order_details.*.product_id	integer	Product identifier
order_details.*.product_code	string	Product code
order_details.*.product_name	string	Product name
order_details.*.note	string	Product description
order_details.*.product_sale_off	numeric	Product discount
order_details.*.cash_discount	numeric	Cash discount
order_details.*.price	numeric	Product price
order_details.*.quantity	numeric	Product quantity
order_details.*.vat	numeric	Product VAT (%)
order_details.*.vat_amount	numeric	Product VAT (cash)
custom_fields	object	Data definition

HTTP Request

GET api/v6/sale_orders/4?fields=product_name HTTP/1.1
Host: example.getflycrm.com
Authorization: Bearer token

Status

200 OK

Response

{
  "id": 4,
  "order_code": "ORDER_CODE"
}