API legada/Referência completa/Embalagens e caixas

GETConsultar caixa

Devolve a configuração completa de uma caixa de produtos específica.

Este endpoint devolve informações detalhadas de uma caixa de produtos específica, identificada pelo ID. Ele traz a configuração completa da caixa, incluindo conteúdo, tipo, status e outros detalhes relevantes. A autenticação é obrigatória: use Basic Authentication com as suas credenciais de API.

GET/api/productBoxes/{box_id}Seller

Consulta uma caixa

Parâmetros de caminho

box_idintegerobrigatório

Identificador único da caixa de produtos a consultar

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

Resposta

200Caixa retornada

json

{
  "box": {
    "box_id": 15,
    "title": "F8",
    "description": "1 par 35/36, 3 pares 37/38 e 2 pares 39/40",
    "box_type": "G",
    "size_variant_id": "20270",
    "status": "A",
    "size_qty_info": [
      {
        "size": "35/36",
        "amount": "1"
      },
      {
        "size": "37/38",
        "amount": "3"
      },
      {
        "size": "39/40",
        "amount": "2"
      }
    ]
  }
}

Campos da resposta

boxobject

Objeto da caixa com os detalhes da configuração

box.box_idinteger

Identificador único da caixa

box.titlestring

Código identificador da caixa (por exemplo, "F8", "F12")

box.descriptionstring

Descrição legível do conteúdo da caixa

box.box_typestring

Tipo da caixa: "G" para caixa de grade (sortimento), "C" para caixa fechada (conjunto completo)

box.size_variant_idstring

ID da variante de tamanho vinculada a esta caixa

box.statusstring

Status da caixa: "A" para ativa, "D" para desativada

box.size_qty_infoarray

Array de pares tamanho/quantidade que definem o conteúdo da caixa

box.size_qty_info[].sizestring

Identificador do tamanho (por exemplo, "35/36", "37/38")

box.size_qty_info[].amountstring

Quantidade de itens neste tamanho dentro da caixa

Códigos de status

Código de status	Descrição
`200 OK`	Requisição bem-sucedida, detalhes da caixa devolvidos
`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
`500 Internal Server Error`	Ocorreu um erro no servidor

Veja também