Skip to main content
POST
/
t
/
v1
/
setout-cars
Setout Cars
curl --request POST \
  --url https://api-lg-k-h1.arms.cedarai.com/t/v1/setout-cars \
  --header 'Carrier: <carrier>' \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "work_order_id": "12345",
  "items": [
    {
      "setout_task_id": "task_001",
      "track_id": 67890,
      "position": 1
    },
    {
      "equipment_id": 55555,
      "track_id": 67890,
      "position": 2
    }
  ],
  "exceptions": []
}
'
{}

Authorizations

​
x-arms-api-key
string
header
required
​
x-arms-assume-user
string
header
required

Headers

​
Carrier
string
required

Carrier ID

Body

application/json

Request message for completing setout tasks.

Request message for completing setout tasks.

​
items
object[]
required

List of items to Setout. The associated Setout tasks will be closed on success.

​
exceptions
object[]
required
​
workOrderId
string
required
​
timestamp
string<date-time>
​
isLostConsist
boolean

Response

A successful response.

The response is of type object.