API legada/Referência completa/Embalagens e caixas

GETDescrição de uma caixa

Devolve as informações descritivas de uma configuração de caixa específica.

Este endpoint devolve as informações descritivas de uma configuração de caixa específica, identificada pelo ID. Ele traz dados complementares sobre a caixa, que podem ser usados para exibição, relatórios ou cruzamento com os dados dos produtos. A autenticação é obrigatória: use Basic Authentication com as suas credenciais de API.

GET/api/productBoxesDescriptions/{box_id}Seller

Consulta a descrição de uma caixa

Parâmetros de caminho

box_idintegerobrigatório

Identificador único da caixa cuja descrição será consultada

Cabeçalhos

Authorizationstringobrigatório

Basic Auth: combinação usuário:senha codificada em Base64 (o par email:api_key).

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/productBoxesDescriptions/15" \
  -u "$EMAIL:$API_KEY"

Resposta

200Descrição retornada

json

{
  "description": {
    "description_id": 28,
    "box_id": 15,
    "lang_code": "pt",
    "title": "Caixa F8",
    "full_description": "Caixa grade contendo: 1 par tamanho 35/36, 3 pares tamanho 37/38 e 2 pares tamanho 39/40. Total: 6 pares.",
    "meta_keywords": "caixa, grade, F8, calçados",
    "meta_description": "Caixa grade F8 - sortimento de calçados com 6 pares em tamanhos variados"
  }
}

Campos da resposta

descriptionobject

Objeto de descrição da caixa com as informações descritivas

description.description_idinteger

Identificador único da descrição da caixa

description.box_idinteger

Identificador da caixa a que esta descrição pertence

description.lang_codestring

Código do idioma da descrição (por exemplo, "pt" para português)

description.titlestring

Título de exibição da caixa

description.full_descriptionstring

Descrição completa do conteúdo da caixa, própria para exibição nas páginas de produto

description.meta_keywordsstring

Palavras-chave de SEO relacionadas à caixa

description.meta_descriptionstring

Meta description de SEO da caixa

Códigos de status

Código de status	Descrição
`200 OK`	Requisição bem-sucedida, descrição da caixa devolvida
`401 Unauthorized`	As credenciais de autenticação estão ausentes ou são inválidas
`404 Not Found`	A caixa com o ID informado não existe ou não tem descrição
`500 Internal Server Error`	Ocorreu um erro no servidor

Veja também