/v1/labels/{id} (GET)

GET

/v1/labels/{id}

const url = 'https://example.com/v1/labels/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/labels/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

required

string format: uuid

Responses

200

One label with embedded formats and translations

application/json

object

required

string format: uuid

workspace_id

required

string format: uuid

brand_id

required

string | null format: uuid

ref

required

string | null

<= 2000 characters

name

required

string

<= 2000 characters

internal_name

required

string | null

<= 2000 characters

name_line_2

required

string | null

<= 2000 characters

name_line_3

required

string | null

<= 2000 characters

name_line_2_small

required

boolean | null

name_line_3_small

required

boolean | null

vintage

required

string | null

<= 2000 characters

is_non_vintage

required

boolean

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

locale

required

string | null

<= 2000 characters

label_design

required

string | null

<= 2000 characters

color

required

string | null

<= 2000 characters

product_type

required

string | null

<= 2000 characters

sweetness

required

string | null

<= 2000 characters

country_of_origin_id

required

string | null format: uuid

single_vineyard_id

required

string | null format: uuid

production_method_id

required

string | null format: uuid

packaging_gas

required

string | null

<= 2000 characters

bottler_id

required

string | null format: uuid

distributor_id

required

string | null format: uuid

ppwr_importer_id

required

string | null format: uuid

ppwr_manufacturer_id

required

string | null format: uuid

producer_number_only

required

boolean | null

bottler_number_only

required

boolean | null

distributor_number_only

required

boolean | null

hide_producer

required

boolean | null

hide_bottler

required

boolean | null

hide_distributor

required

boolean | null

hide_ppwr_importer

required

boolean | null

hide_ppwr_manufacturer

required

boolean | null

hide_conformity_declaration

required

boolean | null

alcohol

required

number | null

alcohol_label

required

number | null

residual_sugar

required

number | null

sugar

required

number | null

acidity

required

number | null

glycerin

required

number | null

energy_kcal

required

number | null

energy_kj

required

number | null

fat

required

number | null

fat_negligible

required

boolean | null

saturated_fat

required

number | null

carbohydrates

required

number | null

carbohydrates_negligible

required

boolean | null

protein

required

number | null

protein_negligible

required

boolean | null

salt

required

number | null

salt_negligible

required

boolean | null

portion_size

required

number | null

calculate_manually

required

boolean | null

summarize_small_amounts

required

boolean | null

use_gs1_digital_link

required

boolean | null

use_recycling_regulations

required

boolean | null

show_allergen_text

required

boolean | null

show_inspection_number

required

boolean | null

show_product_type

required

boolean | null

show_quantity

required

boolean | null

show_sweetness

required

boolean | null

inspection_number

required

string | null

<= 2000 characters

organic_certificate_number

required

string | null

<= 2000 characters

minimum_durability_date

required

string | null

<= 2000 characters

dealcoholisation_applied

required

boolean | null

dealcoholisation_status

required

string | null

<= 2000 characters

marketing_link_type

required

string | null

<= 2000 characters

marketing_link_href

required

string | null

<= 2000 characters

outside_eu_forward_href

required

string | null

<= 2000 characters

scan_with_glasswise_href

required

string | null

<= 2000 characters

scan_with_glasswise_forward_href

required

string | null

<= 2000 characters

image_id

required

string | null format: uuid

image_orientation

required

string | null

<= 2000 characters

original_image_id

required

string | null format: uuid

data_sheet_file_id

required

string | null format: uuid

inspection_report_id

required

string | null format: uuid

primary_brand_asset_id

required

string | null format: uuid

notes

required

string | null

<= 2000 characters

is_published

required

boolean

is_archived

required

boolean

published_at

required

string | null

<= 2000 characters

short_url

required

string | null

<= 2000 characters

short_url_marketing

required

string | null

<= 2000 characters

default_format_id

required

string | null format: uuid

created_at

required

string | null

<= 2000 characters

updated_at

required

string | null

<= 2000 characters

formats

required

Array<object>

<= 200 items

object

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

translations

required

Array<object>

<= 200 items

object

locale

required

string

<= 2000 characters

description

required

string | null

<= 2000 characters

description_full

required

string | null

<= 2000 characters

designation_of_origin

required

string | null

<= 2000 characters

origin

required

string | null

<= 2000 characters

region

required

string | null

<= 2000 characters

quality

required

string | null

<= 2000 characters

sensory_description

required

string | null

<= 2000 characters

aroma

required

string | null

<= 2000 characters

serving_temperature

required

string | null

<= 2000 characters

harvest_date

required

string | null

<= 2000 characters

age_of_the_vines

required

string | null

<= 2000 characters

soil

required

string | null

<= 2000 characters

yield_per_hectare

required

string | null

<= 2000 characters

maturation

required

string | null

<= 2000 characters

aging_potential

required

string | null

<= 2000 characters

single_vineyard

required

string | null

<= 2000 characters

allergen_text

required

string | null

<= 2000 characters

custom_ingredients

required

string | null

<= 2000 characters

message_certifications

required

string | null

<= 2000 characters

message_food_pairing

required

string | null

<= 2000 characters

message_geographical

required

string | null

<= 2000 characters

message_organic

required

string | null

<= 2000 characters

message_production_method

required

string | null

<= 2000 characters

message_recycling

required

string | null

<= 2000 characters

message_responsible_consumption

required

string | null

<= 2000 characters

message_sustainability

required

string | null

<= 2000 characters

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "brand_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "ref": "example",
  "name": "example",
  "internal_name": "example",
  "name_line_2": "example",
  "name_line_3": "example",
  "name_line_2_small": true,
  "name_line_3_small": true,
  "vintage": "example",
  "is_non_vintage": true,
  "quantity": 1,
  "gtin": "example",
  "consumer_product_variant": "example",
  "lot": "example",
  "internal_reference": "example",
  "locale": "example",
  "label_design": "example",
  "color": "example",
  "product_type": "example",
  "sweetness": "example",
  "country_of_origin_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "single_vineyard_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "production_method_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "packaging_gas": "example",
  "bottler_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "distributor_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "ppwr_importer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "ppwr_manufacturer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "producer_number_only": true,
  "bottler_number_only": true,
  "distributor_number_only": true,
  "hide_producer": true,
  "hide_bottler": true,
  "hide_distributor": true,
  "hide_ppwr_importer": true,
  "hide_ppwr_manufacturer": true,
  "hide_conformity_declaration": true,
  "alcohol": 1,
  "alcohol_label": 1,
  "residual_sugar": 1,
  "sugar": 1,
  "acidity": 1,
  "glycerin": 1,
  "energy_kcal": 1,
  "energy_kj": 1,
  "fat": 1,
  "fat_negligible": true,
  "saturated_fat": 1,
  "carbohydrates": 1,
  "carbohydrates_negligible": true,
  "protein": 1,
  "protein_negligible": true,
  "salt": 1,
  "salt_negligible": true,
  "portion_size": 1,
  "calculate_manually": true,
  "summarize_small_amounts": true,
  "use_gs1_digital_link": true,
  "use_recycling_regulations": true,
  "show_allergen_text": true,
  "show_inspection_number": true,
  "show_product_type": true,
  "show_quantity": true,
  "show_sweetness": true,
  "inspection_number": "example",
  "organic_certificate_number": "example",
  "minimum_durability_date": "example",
  "dealcoholisation_applied": true,
  "dealcoholisation_status": "example",
  "marketing_link_type": "example",
  "marketing_link_href": "example",
  "outside_eu_forward_href": "example",
  "scan_with_glasswise_href": "example",
  "scan_with_glasswise_forward_href": "example",
  "image_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "image_orientation": "example",
  "original_image_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "data_sheet_file_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "inspection_report_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "primary_brand_asset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "notes": "example",
  "is_published": true,
  "is_archived": true,
  "published_at": "example",
  "short_url": "example",
  "short_url_marketing": "example",
  "default_format_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "created_at": "example",
  "updated_at": "example",
  "formats": [
    {
      "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"
    }
  ],
  "translations": [
    {
      "locale": "example",
      "description": "example",
      "description_full": "example",
      "designation_of_origin": "example",
      "origin": "example",
      "region": "example",
      "quality": "example",
      "sensory_description": "example",
      "aroma": "example",
      "serving_temperature": "example",
      "harvest_date": "example",
      "age_of_the_vines": "example",
      "soil": "example",
      "yield_per_hectare": "example",
      "maturation": "example",
      "aging_potential": "example",
      "single_vineyard": "example",
      "allergen_text": "example",
      "custom_ingredients": "example",
      "message_certifications": "example",
      "message_food_pairing": "example",
      "message_geographical": "example",
      "message_organic": "example",
      "message_production_method": "example",
      "message_recycling": "example",
      "message_responsible_consumption": "example",
      "message_sustainability": "example"
    }
  ]
}

401

Missing or invalid bearer token

application/problem+json

object

type

required

string

<= 2000 characters

title

required

string

<= 2000 characters

status

required

number

detail

string

<= 2000 characters

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

404

Label not found or not visible

application/problem+json

object

type

required

string

<= 2000 characters

title

required

string

<= 2000 characters

status

required

number

detail

string

<= 2000 characters

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

502

Upstream error

application/problem+json

object

type

required

string

<= 2000 characters

title

required

string

<= 2000 characters

status

required

number

detail

string

<= 2000 characters

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

/v1/labels/{id} (GET)

Authorizations

Parameters

Path Parameters

Responses

200

Examplegenerated

401

Examplegenerated

404

Examplegenerated

502

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated