Skip to content
Glasswise Docs

/v1/label-formats/{id} (PATCH)

PATCH
/v1/label-formats/{id}
curl --request PATCH \
  --url https://example.com/v1/label-formats/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "quantity": 1, "gtin": "example", "consumer_product_variant": "example", "lot": "example", "internal_reference": "example", "shop_url": "example", "available_from": "example", "image_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Update a label format. Omitted keys are untouched, explicit null clears a nullable field. quantity is in MILLILITRES. ref and label_id are immutable.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
quantity

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

integer
> 0
gtin
string
<= 2000 characters
consumer_product_variant
string
<= 2000 characters
lot
string
<= 2000 characters
internal_reference
string
<= 2000 characters
shop_url
string
<= 2000 characters
available_from

ISO date from which the e-label is valid

string
<= 2000 characters
image_id
string format: uuid
Examplegenerated
{
  "quantity": 1,
  "gtin": "example",
  "consumer_product_variant": "example",
  "lot": "example",
  "internal_reference": "example",
  "shop_url": "example",
  "available_from": "example",
  "image_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

The updated format

Media typeapplication/json
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
{
  "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"
}

400

Section titled “400”

Invalid body

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"
}

401

Section titled “401”

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"
}

403

Section titled “403”

Format not writable

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"
}

404

Section titled “404”

Format not found

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"
}

502

Section titled “502”

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"
}