Worksheet (Create) Brokerage

Creates a new Brokerage Worksheet.

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",
  "Status": "WORK",
  "Customer": "27 RECYCLING CORP XERO",
  "Supplier": "ABC METALS INC",
  "TaxCode": "CTS",
  "CustomerLocation": "Norwalk",
  "SupplierLocation": "Main Yard",
  "Department": "AMI TRADING",
  "UserDefined1": "udf 1",
  "UserDefined2": "udf 2",
  "UserDefined3": "udf 3",
  "UserDefined4": "udf 4",
  "UserDefined5": "udf 5",
  "SalesRep": "Alison Smith",
  "BuyRep": "Bob Wood Jr.",
  "EquipType": "1100 LITRE WHEELIE BIN",
  "EquipNo": "EQ123",
  "Logistics": "Setup",
  "PickupNo": "Pickup123",
  "ReleaseNo": "Rel123",
  "MillRcvNo": "MR1001",
  "BOLNo": "BOL2",
  "ShippingTerms": "CFR",
  "PaymentTerms": "NET 30",
  "TradeType": "EXPORT",
  "SalesOrderNo": "",
  "PurchaseOrderNo": "",
  "ShipDate": "09/23/2026",
  "Products": [
    {
      "Grade": "#1 Burned Wire",
      "AltNm": "1BW",
      "Packaging": "",
      "PackageCount": 0,
      "SellPrice": 100,
      "SellPriceUOM": "LBS",
      "SellQuantity": 15,
      "SellQuantityUOM": "KG",
      "PurchasePrice": 15000,
      "PurchasePriceUOM": "MT",
      "PurchaseQuantity": 230,
      "PurchaseQuantityUOM": "KG"
    },
    {
      "Grade": "Acrylic",
      "AltNm": "",
      "Packaging": "BALE",
      "PackageCount": 35,
      "SellPrice": 500,
      "SellPriceUOM": "ST",
      "SellQuantity": 45,
      "SellQuantityUOM": "LBS",
      "PurchasePrice": 2,
      "PurchasePriceUOM": "KG",
      "PurchaseQuantity": 3.4,
      "PurchaseQuantityUOM": "MT"
    }
  ]
}

Body Parameters

Product Line Fields

Automatic Order Linking

Automatic Order Linking is supported in this API endpoint when an Order is specified in the "SalesOrderNo" and/or "PurchaseOrderNo" parameters.
The Sales Order must be OPEN and belong to the Customer. The Purchase Order must be OPEN and belong to the Supplier.
Products are linked automatically by grade. Note that pricing only comes through if price is 0 or unspecified.

• Sales Order and Purchase Order specified: A product is only linked when its grade is on both orders. The Sell Price comes from the Sales Order and the Purchase Price comes from the Purchase Order. If NO products are included in the API call, we automatically pull in every grade that appears on both orders.
• Sales Order only: Products are linked to the Sales Order and pull the Sell Price. If NO products are included in the API call, we automatically pull in all SO products.
• Purchase Order only: Products are linked to the Purchase Order and pull the Purchase Price. If NO products are included in the API call, we automatically pull in all PO products.

When a Purchase Order is linked and PurchaseQuantity is 0 or unspecified, the Purchase Weight defaults to the Sell Weight.

Response Example

On Success [HTTP 201]:

{
    "Msg": "Successfully Created Worksheet 12256"
}

On Error [HTTP 500/HTTP 401/HTTP 400]:

{
    "ErrMsg": "Error: Purchase Order PO1234 not found in cieTrade or is not valid for selection. Make sure the PO is OPEN and for the same Supplier."
}