API legada/Guia rápido/Embalagens e caixas

GETDescrições das caixas

Devolve as informações descritivas de todas as configurações de caixa.

Este endpoint devolve as informações descritivas de todas as configurações de caixa disponíveis na plataforma Venddor. Ele traz dados complementares sobre as caixas, 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/productBoxesDescriptionsSeller

Lista as descrições de todas as caixas

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/" \
  -u "$EMAIL:$API_KEY"

Resposta

200Descrições retornadas

json

{
  "descriptions": [
    {
      "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"
    },
    {
      "description_id": 29,
      "box_id": 23,
      "lang_code": "pt",
      "title": "Caixa F12",
      "full_description": "Caixa grade contendo: 2 pares tamanho 37/38, 3 pares tamanho 39/40 e 1 par tamanho 41/42. Total: 6 pares.",
      "meta_keywords": "caixa, grade, F12, calçados",
      "meta_description": "Caixa grade F12 - sortimento de calçados com 6 pares em tamanhos variados"
    }
  ]
}

Campos da resposta

descriptionsarray

Array de objetos de descrição de caixa

descriptions[].description_idinteger

Identificador único da descrição da caixa

descriptions[].box_idinteger

Identificador da caixa a que esta descrição pertence

descriptions[].lang_codestring

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

descriptions[].titlestring

Título de exibição da caixa

descriptions[].full_descriptionstring

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

descriptions[].meta_keywordsstring

Palavras-chave de SEO relacionadas à caixa

descriptions[].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ções das caixas devolvidas
`401 Unauthorized`	As credenciais de autenticação estão ausentes ou são inválidas
`500 Internal Server Error`	Ocorreu um erro no servidor

Veja também