Order (Detail)
The Order Detail endpoint returns a a JSON data table that provides information on the individual products expected to be being received or shipped against a sales or purchase. This includes: Product Name, Quantity Ordered, Price, Extension, product attributes, and user defined fields. Each result row represents one product related to one order.
ListOrderDetails Example
https://api.cietrade.net/ListOrderDetails?UserID=Example@cietrade.com&DateFrom=1/15/2025&DateTo=6/15/2025&Account=84698&Source=PO&Dept=ALLEGHENY&OrderNumber=102607&Status=open
| UserID | cieTrade.net User Name. | Required | |
| Source | Accepts “PO/SO” if not provided the user will get a kickback message of "Source is a required field" | Required | |
| Location | Target Dispatch Job Location or blank value for all locations of the specified Account parameter (above). Cannot have a value without an Account parameter. | Optional | |
| DateFrom | Start of ORDER date range. Optional, if not provided, it will default to 30 days prior to today's date. | Optional | |
| DateTo | End of ORDER date range. Optional, if not provided, it will default to Todays Date. | Optional | |
| Account | Accepts account name or ID as saved. | Optional | |
| Status | Accepts(“WORK”,”REVIEW”,”OPEN”,”CLOSED”,”CANCELED”) | Optional | |
| OrderNumber | Specific order number to target order details for. | Optional | |
| Dept | Department Filter Example: “00” as it is stored in cieTrade, or Department Short Name. This parameter is Optional, no default value if not provided. | Optional | |
| TradeType | Trade Type filter as defined in settings. Default Is all Trade Types | Optional | |
| SalesRep | Sales Rep Name. Returns only order assigned to the specified rep. Default is ALL reps. | Optional | |
Response Example
{
"order_source": "PO",
"order_number": "102607",
"grade_name": "EACH",
"grade_alternate_name": "AlternateName",
"specifications": "BW 1lb, RW 3ft, DIA 4mm, LEN 6-ft., Core 5in, CAL 2, BLACK",
"weight": 5.00,
"weight_uom": "E",
"price": 15.00,
"price_uom": "E",
"hc_amount": 75.00,
"home_currency": "USD",
"amount": 75.00,
"amount_currency": "USD",
"unit_type": "Containers",
"unit_count": 5,
"color": "BLACK",
"property_set": "Roll",
"roll_basis_weight": "1",
"roll_basis_weight_uom": "LB ",
"roll_caliper": "2",
"roll_width": "3",
"roll_width_uom": "IN",
"roll_diameter": "4",
"roll_diameter_uom": "IN",
"roll_core_size": "5.00",
"roll_core_size_uom": "IN",
"roll_linear_length": "12",
"roll_linear_length_uom": "IN",
"plastic_type": "",
"plastic_form": "",
"plastic_melt": "",
"UDF1": "",
"UDF2": "",
"UDF3": "",
"UDF4": "",
"UDF5": ""
}