Order (Header)

The Order Header includes information that defines an instance of either a sales or purchase order excluding the products or items being ordered which is defined in a separate end point called "Order-Detail" The ListOrders API end point returns a a JSON data table with a list of Orders and associated properties including Order Number, Customer reference, Date, Customer or Suppler Name, Shipping Point or Destination , Shipping and payment terms etc. . Each row in the result data represents an individual Order.

ListOrders Example

https://api.cietrade.net/ListOrders?UserID=Example@cietrade.com&DateFrom=1/15/2025&DateTo=6/15/2025&Account=daktest234&Source=PO&Dept=ALLEGHENY&OrderNumber=102593&Status=open&SalesRep&TradeType&ReportUOM=L

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.	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
ReportUOM	UOM for "total weight" of order to be reported in. If no value is provided, the API will default to “Straight Tons”, ST

Response Example

{
        "order_source": "PO",
        "order_number": "102593",
        "account_name": "DAKTEST234",
        "account_id": "43982",
        "department": "ALLEGHENY",
        "status": "OPEN",
        "order_type": "Spot",
        "trade_type": "BROKERAGE",
        "order_date": "2025-05-06",
        "delivery_date": "2025-06-27",
        "expiration_date": "2025-06-21",
        "billing_address": "test",
        "order_location": "DAKTEST2 123 test address norwalk, CT 06810 USA",
        "terms": "CIF",
        "payment_terms": "1% 10 Net 30",
        "ship_via": "Rolloff",
        "destination_port": "Algerciras",
        "product": "#1 Copper Wire",
        "sales_rep": "Emily Gray",
        "hc_order_value": 123.00,
        "home_currency": "USD",
        "order_value": 123.00,
        "order_currency": "USD",
        "order_quantity": "0.001",
        "unit_of_measure": "ST",
        "ref_number": "ref#",
        "shipping_remarks": "Shippipng Remarks",
        "instructions": "Notes Notes",
        "UDF1": "udf1",
        "UDF2": "N/A"
    }