Skip to content

/v1/labels/{id}/formats (GET)

GET
/v1/labels/{id}/formats
curl --request GET \
--url https://example.com/v1/labels/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/formats \
--header 'Authorization: Bearer <token>'
id
required
string format: uuid

The label’s formats

Media typeapplication/json
object
items
required
Array<object>
<= 200 items
object
id
required
string format: uuid
label_id
required
string format: uuid
ref
required
string | null
<= 2000 characters
quantity
required

Fill volume in MILLILITRES, e.g. 750 or 1500

number | null
gtin
required
string | null
<= 2000 characters
consumer_product_variant
required
string | null
<= 2000 characters
lot
required
string | null
<= 2000 characters
internal_reference
required
string | null
<= 2000 characters
shop_url
required
string | null
<= 2000 characters
short_url
required
string | null
<= 2000 characters
available_from
required
string | null
<= 2000 characters
image_id
required
string | null format: uuid
created_at
required
string | null
<= 2000 characters
updated_at
required
string | null
<= 2000 characters
Examplegenerated
{
"items": [
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"label_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"ref": "example",
"quantity": 1,
"gtin": "example",
"consumer_product_variant": "example",
"lot": "example",
"internal_reference": "example",
"shop_url": "example",
"short_url": "example",
"available_from": "example",
"image_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"created_at": "example",
"updated_at": "example"
}
]
}

Missing or invalid bearer token

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Upstream error

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}