API legada/Guia rápido/Embalagens e caixas

Descrições de caixas

Lê os títulos e descrições por idioma das caixas de produto na API legada.

Cada caixa tem um título e uma descrição por idioma. Esta página traz as duas leituras desses textos; para alterá-los, use Alterar caixa.

Listar descrições

Devolve os textos das caixas, uma linha por caixa e idioma, em páginas.

GET/api/v1.0/product_boxes_descriptionsAdmin

Listar descrições de caixas

A rota exige o módulo product-boxes ligado na loja; sem ele responde erro com a mensagem product-boxes: module disabled for tenant. Autenticação: HTTP Basic com e-mail:chave_de_api de um administrador, ou Authorization: Bearer <JWT>.

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250. Fora desse intervalo vale 10.

GET/api/v1.0/productboxesdescriptionsAdmin

Listar descrições (nome sem sublinhado)

Esta é a grafia sem sublinhado (productboxes), que o aplicativo do seller usa. É o mesmo código, com a mesma resposta. Como as demais rotas desta família, ela também responde sem o prefixo de versão (/api/productboxes), com os ids em número decimal dentro de uma string.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/product_boxes_descriptions?items_per_page=50"

Resposta

200Descrições retornadas

json

{
  "params": {
    "page": 1,
    "items_per_page": 10,
    "total_items": 18
  },
  "product_boxes_descriptions": [
    {
      "box_id": "959af717-ae72-427b-a497-58d3ff422cc8",
      "lang_code": "pt-BR",
      "description": "Grade com 6 pares",
      "title": "Grade 37 e 38"
    },
    {
      "box_id": "959af717-ae72-427b-a497-58d3ff422cc8",
      "lang_code": "en",
      "description": "Size run with 6 pairs",
      "title": "Size run 37 and 38"
    }
  ]
}

Campos da resposta

product_boxes_descriptions[].box_idstring

UUID da caixa.

product_boxes_descriptions[].lang_codestring

Código do idioma, por exemplo pt-BR ou en.

product_boxes_descriptions[].titlestring

Título da caixa nesse idioma.

product_boxes_descriptions[].descriptionstring

Descrição nesse idioma.

paramsobject

Paginação: page, items_per_page, total_items.

Erros

Status	Quando	Corpo
401	Sem credenciais ou chave inválida	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
403	O usuário não é administrador	`{"message":"Forbidden: admin scope required","status":403}`
500	Falha interna, ou módulo `product-boxes` desligado	`{"message":"product-boxes: module disabled for tenant","status":500}`

Descrições de uma caixa

Devolve os textos de uma caixa, uma linha por idioma, sem paginação.

GET/api/v1.0/product_boxes_descriptions/{boxID}Admin

Descrições de uma caixa

Parâmetros de caminho

boxIDstringobrigatório

Id da caixa: o UUID ou, se a caixa veio de uma plataforma anterior, o número legado.

GET/api/v1.0/productboxesdescriptions/{boxID}Admin

Descrições de uma caixa (nome sem sublinhado)

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/product_boxes_descriptions/959af717-ae72-427b-a497-58d3ff422cc8"

Resposta

200Descrições da caixa

json

{
  "product_boxes_descriptions": [
    {
      "box_id": "959af717-ae72-427b-a497-58d3ff422cc8",
      "lang_code": "pt-BR",
      "description": "Grade com 6 pares",
      "title": "Grade 37 e 38"
    },
    {
      "box_id": "959af717-ae72-427b-a497-58d3ff422cc8",
      "lang_code": "en",
      "description": "Size run with 6 pairs",
      "title": "Size run 37 and 38"
    }
  ]
}

Os campos são os mesmos da listagem.

Erros

Status	Quando	Corpo
401	Sem credenciais ou chave inválida	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
403	O usuário não é administrador	`{"message":"Forbidden: admin scope required","status":403}`
404	A caixa não existe	`{"message":"product box not found","status":404}`
500	Falha interna, ou módulo `product-boxes` desligado	`{"message":"product-boxes: module disabled for tenant","status":500}`

Veja também

API legada/Guia rápido/Embalagens e caixas

Descrições de caixas

Lê os títulos e descrições por idioma das caixas de produto na API legada.

Cada caixa tem um título e uma descrição por idioma. Esta página traz as duas leituras desses textos; para alterá-los, use Alterar caixa.

Listar descrições

Devolve os textos das caixas, uma linha por caixa e idioma, em páginas.

GET/api/v1.0/product_boxes_descriptionsAdmin

Listar descrições de caixas

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250. Fora desse intervalo vale 10.

GET/api/v1.0/productboxesdescriptionsAdmin

Listar descrições (nome sem sublinhado)

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/product_boxes_descriptions?items_per_page=50"

Resposta

200Descrições retornadas

json

{
  "params": {
    "page": 1,
    "items_per_page": 10,
    "total_items": 18
  },
  "product_boxes_descriptions": [
    {
      "box_id": "959af717-ae72-427b-a497-58d3ff422cc8",
      "lang_code": "pt-BR",
      "description": "Grade com 6 pares",
      "title": "Grade 37 e 38"
    },
    {
      "box_id": "959af717-ae72-427b-a497-58d3ff422cc8",
      "lang_code": "en",
      "description": "Size run with 6 pairs",
      "title": "Size run 37 and 38"
    }
  ]
}

Campos da resposta

product_boxes_descriptions[].box_idstring

UUID da caixa.

product_boxes_descriptions[].lang_codestring

Código do idioma, por exemplo pt-BR ou en.

product_boxes_descriptions[].titlestring

Título da caixa nesse idioma.

product_boxes_descriptions[].descriptionstring

Descrição nesse idioma.

paramsobject

Paginação: page, items_per_page, total_items.

Erros

Status	Quando	Corpo
401	Sem credenciais ou chave inválida	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
403	O usuário não é administrador	`{"message":"Forbidden: admin scope required","status":403}`
500	Falha interna, ou módulo `product-boxes` desligado	`{"message":"product-boxes: module disabled for tenant","status":500}`

Descrições de uma caixa

Devolve os textos de uma caixa, uma linha por idioma, sem paginação.

GET/api/v1.0/product_boxes_descriptions/{boxID}Admin

Descrições de uma caixa

Parâmetros de caminho

boxIDstringobrigatório

Id da caixa: o UUID ou, se a caixa veio de uma plataforma anterior, o número legado.

GET/api/v1.0/productboxesdescriptions/{boxID}Admin

Descrições de uma caixa (nome sem sublinhado)

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/product_boxes_descriptions/959af717-ae72-427b-a497-58d3ff422cc8"

Resposta

200Descrições da caixa

json

{
  "product_boxes_descriptions": [
    {
      "box_id": "959af717-ae72-427b-a497-58d3ff422cc8",
      "lang_code": "pt-BR",
      "description": "Grade com 6 pares",
      "title": "Grade 37 e 38"
    },
    {
      "box_id": "959af717-ae72-427b-a497-58d3ff422cc8",
      "lang_code": "en",
      "description": "Size run with 6 pairs",
      "title": "Size run 37 and 38"
    }
  ]
}

Os campos são os mesmos da listagem.

Erros

Status	Quando	Corpo
401	Sem credenciais ou chave inválida	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
403	O usuário não é administrador	`{"message":"Forbidden: admin scope required","status":403}`
404	A caixa não existe	`{"message":"product box not found","status":404}`
500	Falha interna, ou módulo `product-boxes` desligado	`{"message":"product-boxes: module disabled for tenant","status":500}`