Skip to content
Docs
Select language:English

/api/v1/things/{id}/box-check

POST
/api/v1/things/{id}/box-check
curl --request POST \
  --url https://example.com/api/v1/things/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/box-check \
  --header 'Content-Type: application/json' \
  --data '{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "lines": [ { "thingId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "expectedQty": "example", "foundQty": "example" } ], "foundElsewhereIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
lines
required
Array<object>
<= 500 items
object
thingId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
expectedQty
required
string
/^\d{1,9}(\.\d{1,3})?$/
foundQty
required
string
/^\d{1,9}(\.\d{1,3})?$/
foundElsewhereIds
Array<string>
<= 200 items
Examplegenerated
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "lines": [
    {
      "thingId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "expectedQty": "example",
      "foundQty": "example"
    }
  ],
  "foundElsewhereIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
boxCheckId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
seen
required
Array<string>
notHere
required
Array<string>
split
required
Array<object>
object
originalId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
newId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
movedIn
required
Array<string>
undo
object
eventId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
until
required
string
Examplegenerated
{
  "boxCheckId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "seen": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "notHere": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "split": [
    {
      "originalId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "newId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ],
  "movedIn": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "undo": {
    "eventId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "until": "example"
  }
}