Skip to content
Docs
Select language:English

/api/v1/labels/batches (POST)

POST
/api/v1/labels/batches
curl --request POST \
  --url https://example.com/api/v1/labels/batches \
  --header 'Content-Type: application/json' \
  --data '{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "kind": "things", "thingIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "placeIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "unprinted": { "placeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "blankCount": 1, "stock": "example", "startCell": 1, "dryRun": true }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
id
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)$/
locationId
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)$/
kind
required
string
Allowed values: things places blank
thingIds
Array<string>
>= 1 items <= 500 items
placeIds
Array<string>
>= 1 items <= 500 items
unprinted
object
placeId
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)$/
blankCount
integer
>= 1 <= 500
stock
required
string
startCell
integer
>= 1 <= 200
dryRun
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
labels
required
Array<object>
object
code
required
string
url
required
string
kind
required
string
Allowed values: thing place blank
name
string
path
string
targetId
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)$/
blank
required
number
excluded
required
object
pending
required
number
other
required
number
Example
{
  "labels": [
    {
      "kind": "thing"
    }
  ]
}

201

Section titled “201”

Default Response

Media typeapplication/json
object
batch
required
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)$/
locationId
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)$/
kind
required
string
Allowed values: things places blank
stock
required
string
startCell
required
number
createdAt
required
string
printedConfirmedAt
required
string | null
labels
required
Array<object>
object
code
required
string
url
required
string
kind
required
string
Allowed values: thing place blank
name
string
path
string
targetId
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)$/
excluded
required
object
pending
required
number
other
required
number
Example
{
  "batch": {
    "kind": "things",
    "labels": [
      {
        "kind": "thing"
      }
    ]
  }
}