Worksheet (Create) Shipping

Creates a new Shipping 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

POST https://api.cietrade.net/CreateShippingWks

{
  "UserID": "example@email.net",
  "Status": "WORK",
  "Customer": "27 RECYCLING CORP XERO",
  "TaxCode": "CTS",
  "Location": "10505 Mecha Norwalk",
  "Department": "AMI TRADING",
  "Warehouse": "AAA Storage",
  "WarehouseStatus": "Scheduled",
  "UserDefined1": "udf 1",
  "UserDefined2": "udf 2",
  "UserDefined3": "udf 3",
  "UserDefined4": "udf 4",
  "UserDefined5": "udf 5",
  "SalesRep": "Alison Smith",
  "BuyRep": "Bob Wood Jr.",
  "TruckNo": "24681",
  "EquipType": "1100 LITRE WHEELIE BIN",
  "EquipNo": "EQ123",
  "Logistics": "Setup",
  "PickupNo": "Pickup123",
  "ReleaseNo": "Rel123",
  "BOLNo": "BOL2",
  "ShippingTerms": "CFR",
  "PaymentTerms": "NET 30",
  "TradeType": "EXPORT",
  "OrderNo": "",
  "MillRcvNo": "MR1001",
  "ScaleGross": 0,
  "ScaleTare": 0,
  "ShipDate": "09/23/2026",
  "Products": [
    {
      "Grade": "#1 Bare Bright Copper",
      "AltNm": "copper desc",
      "Packaging": "1 Roll",
      "PackageCount": 1,
      "Price": 6,
      "PriceUOM": "LBS",
      "Quantity": 50,
      "QuantityUOM": "KG",
      "Location": "",
      "Class": ""
    },
    {
      "Grade": "#1 Copper Tubing",
      "AltNm": "",
      "Packaging": "",
      "PackageCount": 0,
      "Price": 10,
      "PriceUOM": "MT",
      "Quantity": 15000,
      "QuantityUOM": "LBS",
      "Location": "",
      "Class": ""
    }
  ]
}

Body Parameters

Parameter	Description	Required
`UserID`	cieTrade.NET User Email. Used for Authentication and Logging.	REQUIRED
`Status`	Worksheet status. Defaults to "WORK". Also optionally supports the "COMPLETED" status	OPTIONAL
`Customer`	Customer name	REQUIRED
`TaxCode`	Tax code applied to the shipment.	OPTIONAL
`Location`	Location name	REQUIRED
`Department`	Department name	REQUIRED
`Warehouse`	Warehouse name	REQUIRED
`WarehouseStatus`	Warehouse Status (Scheduled, In Process, or Completed)	OPTIONAL
`UserDefined1`	User-defined field 1.	OPTIONAL
`UserDefined2`	User-defined field 2.	OPTIONAL
`UserDefined3`	User-defined field 3.	OPTIONAL
`UserDefined4`	User-defined field 4.	OPTIONAL
`UserDefined5`	User-defined field 5.	OPTIONAL
`SalesRep`	Sales representative name	OPTIONAL
`BuyRep`	Buy representative name	OPTIONAL
`TruckNo`	Truck number for the shipment.	OPTIONAL
`EquipType`	Type of equipment used for hauling.	OPTIONAL
`EquipNo`	Equipment number/identifier.	OPTIONAL
`Logistics`	Logistics method.	OPTIONAL
`PickupNo`	Pickup number reference.	OPTIONAL
`ReleaseNo`	Release number reference.	OPTIONAL
`BOLNo`	Bill of Lading number.	OPTIONAL
`ShippingTerms`	Shipping terms.	OPTIONAL
`PaymentTerms`	Payment terms.	OPTIONAL
`TradeType`	Type of trade transaction.	OPTIONAL
`OrderNo`	Sales Order number. See Automatic Order Linking section below.	OPTIONAL
`MillRcvNo`	Mill receiving number.	OPTIONAL
`ScaleGross`	Gross scale weight. Defaults to 0.	OPTIONAL
`ScaleTare`	Tare scale weight. Defaults to 0.	OPTIONAL
`ShipDate`	Date the shipment was shipped (e.g. "09/23/2026").	OPTIONAL
`Products`	List of product line items (see below) associated with the record.	OPTIONAL

Product Line Fields

Used by the Products array.

Field	Description	Required
`Grade`	Grade/Product Name	REQUIRED
`AltNm`	Alternate Name/Description	OPTIONAL
`Packaging`	Packaging Type	OPTIONAL
`PackageCount`	Packaging Count. Defaults to 0.	OPTIONAL
`Price`	Product Price. Defaults to 0.	OPTIONAL
`PriceUOM`	Price Unit of Measurement. Defaults to `LBS`. Accepts `EA`, `LBS`, `KG`, `ST`, `MT`, `UNIT`, `ADMT`, `MSF`, `CWT`, `GT`.	OPTIONAL
`Quantity`	Product Weight. Defaults to 0.	OPTIONAL
`QuantityUOM`	Weight Unit of Measurement. Defaults to `LBS`. Accepts `EA`, `LBS`, `KG`, `ST`, `MT`, `ADMT`, `GT`.	OPTIONAL
`Location`	Warehouse Location	OPTIONAL
`Class`	Inventory Class	OPTIONAL

Automatic Order Linking

Automatic Order Linking is supported in this API endpoint when an Order is specified in the "OrderNo" parameter.
Products are linked automatically by grade. Note that pricing only comes through if price is 0 or unspecified. If NO products are included in the API call, we automatically pull in all SO products from the linked order.

Response Example

On Success [HTTP 201]:

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

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

{
    "ErrMsg": "Error: Department ALLEHENY not found in cieTrade."
}