Worksheet (Create) Receiving PR

Creates a new Receiving 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/CreateReceivingWks

{
  "UserID": "user@example.com",
  "Status": "WORK",
  "Supplier": "123 (RECYCLING)",
  "Location": "INVOICE",
  "Department": "ALLEGHENY",
  "Warehouse": "ALBANY",
  "WarehouseStatus": "IN PROCESS",
  "UserDefined1": "20%",
  "UserDefined2": "",
  "UserDefined3": "",
  "UserDefined4": "",
  "UserDefined5": "",
  "SalesRep": "Emily Gray",
  "TruckNo": "802B",
  "EquipType": "1100 LITRE WHEELIE BIN",
  "EquipNo": "213123",
  "Logistics": "SETUP",
  "PickupNo": "1000-P",
  "ReleaseNo": "REL123",
  "BOLNo": "BOL 82000",
  "BOLWeightLBS": 150,
  "Driver": "Adam Scott",
  "ShippingTerms": "CIF",
  "ScaleGross": 250,
  "ScaleTare": 80,
  "RcvDate": "09/09/2026",
  "TradeType": "BROKERAGE",
  "OrderNo": "",
  "PRODUCTS": [
    {
      "GRADE": "Kraft Bag Bleached Multiwall",
      "ALTNM": "",
      "PACKAGING": "ROLLS",
      "PACKAGECOUNT": 0,
      "PRICE": 250,
      "PRICEUOM": "KG",
      "QUANTITY": 100,
      "QUANTITYUOM": "LBS",
      "LOCATION": "",
      "CLASS": ""
    },
    {
      "GRADE": "#1 - PREPARED STEEL (SERIAL)",
      "ALTNM": "STEEL S",
      "PACKAGING": "55-GALLON DRUM",
      "PACKAGECOUNT": 5,
      "PRICE": 250,
      "PRICEUOM": "MT",
      "QUANTITY": 170,
      "QUANTITYUOM": "KG",
      "LOCATION": "SILO 2",
      "CLASS": "WIP"
    },
    {
      "GRADE": "ALUMINUM NP",
      "ALTNM": "",
      "PACKAGING": "",
      "PACKAGECOUNT": 0,
      "PRICE": 100,
      "PRICEUOM": "ST",
      "QUANTITY": 45000,
      "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
`Supplier`	Supplier name	REQUIRED
`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
`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
`BOLWeightLBS`	Bill of Lading weight in pounds. Defaults to 0.	OPTIONAL
`Driver`	Driver name.	OPTIONAL
`ShippingTerms`	Shipping terms.	OPTIONAL
`TradeType`	Type of trade transaction.	OPTIONAL
`OrderNo`	Purchase Order number. See Automatic Order Linking section below.	OPTIONAL
`ScaleGross`	Gross scale weight. Defaults to 0.	OPTIONAL
`ScaleTare`	Tare scale weight. Defaults to 0.	OPTIONAL
`RcvDate`	Date the shipment was received.	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	OPTIONAL
`Price`	Product Price	OPTIONAL
`PriceUOM`	Price Unit of Measurement. Accepts `EA`, `LBS`, `KG`, `ST`, `MT`, `UNIT`, `ADMT`, `MSF`, `CWT`, `GT`.	OPTIONAL
`Quantity`	Product Weight	OPTIONAL
`QuantityUOM`	Weight Unit of Measurement. 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. If an Order is specified in the "OrderNo" parameter, we look for products from that order. If no Order is specified, we automatically select the most recent open order for the Supplier.
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 PO products from the linked order.
These automatic features can be disabled in cieTrade settings under Worksheets & Orders. "Do not apply grades from orders" and "Do not auto select PO on worksheets".

Response Example

On Success [HTTP 201]:

{
    "Msg": "Successfully Created Worksheet PR-12249"
}

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

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