Order (Create)
Creates a new Purchase or Sales Order.
Authentication
Every request needs both of the following:
- An authorized UserID, passed in to the request body — this is the user's cieTrade.net email.
- A Bearer Token in the Authorization header of your tool or code call. The token is found under Settings → Integration → Api Token.
The user must have Can Access cieTrade API checked under Settings → Users & Roles, and must have an email address on their user record — the create and update endpoints record that user against every change they make.
Request Example
{
"UserID": "example@email.net",
"Department": "ORIENT",
"OrderType": "SPOT",
"ContractType": "SO",
"OrderDate": "2026/09/05",
"Status": "OPEN",
"Account": "3P GLOBAL RESOURCES LLC",
"RemitTo": "Miami",
"Reference": "PO-2026-0001",
"PaymentTerms": "NET 30",
"ShippingTerms": "CFR",
"SalesRep": "Kyle Lynch",
"SalesRepSecondary": "Bob Wood Jr.",
"TradeType": "DOMESTIC",
"ContainerCount": 2,
"MinWeight": 1000.00,
"MaxWeight": 2500.00,
"MinMaxWeightUOM": "MT",
"ShipVia": "Truck",
"Destination": "Ancona, Italy",
"UserDefined1": "UDF 1 EXAMPLE",
"UserDefined2": "UDF 2 TEST",
"Products": [
{
"Grade": "#1 Bare Bright Copper",
"AltNm": "Coppa",
"Packaging": "Bales",
"PackageCount": 3,
"Price": 125.50,
"PriceUOM": "MT",
"Quantity": 1000,
"QuantityUOM": "LBS"
},
{
"Grade": "Aluminum - Cans",
"AltNm": "",
"Packaging": "BALE",
"PackageCount": 10,
"Price": 98.75,
"PriceUOM": "LBS",
"Quantity": 50,
"QuantityUOM": "KG"
}
]
}
Body Parameters
| Parameter | Description | Required |
|---|---|---|
UserID |
cieTrade.NET User Email. Used for Authentication and Logging. | REQUIRED |
Department |
Department name | REQUIRED |
OrderType |
Order type. Accepts SPOT, CONTRACT, PROVISIONAL. |
REQUIRED |
ContractType |
Contract type ("SO" for Sales Order, "PO" for Purchase Order) | REQUIRED |
OrderDate |
Date of the order (e.g. "2026/09/05"). | REQUIRED |
Status |
Order status. Accepts WORK, REVIEW, OPEN, CLOSED. |
REQUIRED |
Account |
Customer/Supplier account name | REQUIRED |
RemitTo |
Remit-to location name | REQUIRED |
Reference |
Order reference number | OPTIONAL |
PaymentTerms |
Payment terms | OPTIONAL |
ShippingTerms |
Shipping terms | OPTIONAL |
SalesRep |
Primary sales representative name | OPTIONAL |
SalesRepSecondary |
Secondary sales representative name | OPTIONAL |
TradeType |
Type of trade transaction (e.g. "DOMESTIC") | OPTIONAL |
ContainerCount |
Number of containers/loads on the order. | OPTIONAL |
MinWeight |
Minimum order weight. | OPTIONAL |
MaxWeight |
Maximum order weight. | OPTIONAL |
MinMaxWeightUOM |
Unit of Measurement for MinWeight and MaxWeight. Accepts EA, LBS, KG, ST, MT, ADMT, LT. |
OPTIONAL |
ShipVia |
Shipping method (e.g. "Truck") | OPTIONAL |
Destination |
Shipment destination. | OPTIONAL |
UserDefined1 |
User-defined field 1. | OPTIONAL |
UserDefined2 |
User-defined field 2. | OPTIONAL |
Products |
List of product line items (see below) associated with the order. | OPTIONAL |
Product Line Fields
Used by theProducts array.
| Field | Description | Required |
|---|---|---|
Grade |
Grade/Product Name | REQUIRED |
AltNm |
Alternate Name/Description | OPTIONAL |
Packaging |
Packaging Type | OPTIONAL |
PackageCount |
Packaging Count | OPTIONAL |
Price |
Product Price | OPTIONAL |
PriceUOM |
Price Unit of Measurement. Accepts EA, LBS, KG, ST, MT, UNIT, ADMT, MSF, GT. |
OPTIONAL |
Quantity |
Product Weight | OPTIONAL |
QuantityUOM |
Weight Unit of Measurement. Accepts EA, LBS, KG, ST, MT, ADMT, GT. |
OPTIONAL |
Response Example
On Success [HTTP 201]:
{
"Msg": "Successfully Created Order 12249"
}
On Error [HTTP 500/HTTP 401/HTTP 400]:
{
"ErrMsg": "Error: Department ALLEHENY not found in cieTrade."
}