Skip to main content
POST
/
ims
/
equipment
/
load-toolswork
Toolswork: load equipment
curl --request POST \
  --url https://api-lg.arms.cedarai.com/ims/equipment/load-toolswork \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "carrierId": 1,
  "details": [
    {
      "initialAndNumber": "HUEH 862431",
      "netWeightTons": 2000,
      "grossWeightTons": 3000,
      "comments": "very nice",
      "groupings": [
        {
          "type": "bin",
          "name": "bin 0"
        },
        {
          "type": "ash type",
          "name": "ash type 0"
        }
      ]
    },
    {
      "initialAndNumber": "YHZT 582774",
      "netWeightTons": 2000,
      "grossWeightTons": 3000,
      "groupings": [
        {
          "type": "bin",
          "name": "bin 1"
        },
        {
          "type": "ash type",
          "name": "ash type 1"
        }
      ]
    }
  ],
  "trackName": "Jacob Flores",
  "waybillTemplateId": 11
}
'
{}

Authorizations

​
x-arms-api-key
string
header
required

Your ARMS API key

​
x-arms-assume-user
string
header
required

Email of a user assigned to the appropriate user group

Query Parameters

​
carrierId
integer
required

Carrier identifier; required for all endpoints

​
viewAsUserGroup
string

Optional user group context

Body

application/json
​
carrierId
integer
required

Carrier identifier for the load.

​
details
object[]
required

List of equipment and attributes to load.

​
trackName
string
required

Track name where toolswork is loaded.

​
waybillTemplateId
integer
required

Waybill template identifier to use for the load.

​
timestamp
string

Optional timestamp of the load event.

Response

OK

The response is of type object.