API legada/Guia rápido/Embalagens e caixas

GETDados de caixa por produto

Devolve a configuração de caixa de um produto específico.

Este endpoint devolve os dados detalhados da configuração de caixa de um produto específico, identificado pelo ID do produto. Ele informa qual configuração de caixa está associada ao produto, para que você entenda como o produto é embalado e vendido em um sortimento de caixa. A autenticação é obrigatória: use Basic Authentication com as suas credenciais de API.

GET/api/productBoxesVariants/{product_id}Seller

Consulta os dados de caixa de um produto

Parâmetros de caminho

product_idintegerobrigatório

Identificador único do produto cujos dados de caixa serão consultados

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

Resposta

200Variante de caixa do produto retornada

json

{
  "variant": {
    "variant_id": 65824,
    "product_id": 145632,
    "product_code": "7898765432108",
    "product_feature_id": 575,
    "variant_name": "F8",
    "box_id": 15,
    "box_type": "G",
    "status": "A",
    "box_info": {
      "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

variantobject

Objeto da variante do produto com os detalhes da configuração de caixa

variant.variant_idinteger

Identificador único da variante do produto

variant.product_idinteger

Identificador do produto ao qual esta variante pertence

variant.product_codestring

Código universal do produto (código de barras)

variant.product_feature_idinteger

ID da característica usada para o tamanho da caixa (normalmente 575, a característica de tamanho)

variant.variant_namestring

Nome da variante da caixa (por exemplo, "F8", "F12")

variant.box_idinteger

Identificador da configuração de caixa associada a esta variante

variant.box_typestring

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

variant.statusstring

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

variant.box_infoobject

Informações detalhadas da configuração de caixa

variant.box_info.box_idinteger

Identificador único da caixa

variant.box_info.titlestring

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

variant.box_info.descriptionstring

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

variant.box_info.box_typestring

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

variant.box_info.size_variant_idstring

ID da variante de tamanho vinculada a esta caixa

variant.box_info.statusstring

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

variant.box_info.size_qty_infoarray

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

Códigos de status

Código de status	Descrição
`200 OK`	Requisição bem-sucedida, dados da variante de caixa do produto devolvidos
`401 Unauthorized`	As credenciais de autenticação estão ausentes ou são inválidas
`404 Not Found`	O produto com o ID informado não existe ou não está associado a uma configuração de caixa
`500 Internal Server Error`	Ocorreu um erro no servidor

Veja também

GETDados de caixa por produto

Devolve a configuração de caixa de um produto específico.

GET/api/productBoxesVariants/{product_id}Seller

Consulta os dados de caixa de um produto

Parâmetros de caminho

product_idintegerobrigatório

Identificador único do produto cujos dados de caixa serão consultados

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

Resposta

200Variante de caixa do produto retornada

json

{
  "variant": {
    "variant_id": 65824,
    "product_id": 145632,
    "product_code": "7898765432108",
    "product_feature_id": 575,
    "variant_name": "F8",
    "box_id": 15,
    "box_type": "G",
    "status": "A",
    "box_info": {
      "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

variantobject

Objeto da variante do produto com os detalhes da configuração de caixa

variant.variant_idinteger

Identificador único da variante do produto

variant.product_idinteger

Identificador do produto ao qual esta variante pertence

variant.product_codestring

Código universal do produto (código de barras)

variant.product_feature_idinteger

ID da característica usada para o tamanho da caixa (normalmente 575, a característica de tamanho)

variant.variant_namestring

Nome da variante da caixa (por exemplo, "F8", "F12")

variant.box_idinteger

Identificador da configuração de caixa associada a esta variante

variant.box_typestring

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

variant.statusstring

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

variant.box_infoobject

Informações detalhadas da configuração de caixa

variant.box_info.box_idinteger

Identificador único da caixa

variant.box_info.titlestring

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

variant.box_info.descriptionstring

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

variant.box_info.box_typestring

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

variant.box_info.size_variant_idstring

ID da variante de tamanho vinculada a esta caixa

variant.box_info.statusstring

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

variant.box_info.size_qty_infoarray

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

Códigos de status

Código de status	Descrição
`200 OK`	Requisição bem-sucedida, dados da variante de caixa do produto devolvidos
`401 Unauthorized`	As credenciais de autenticação estão ausentes ou são inválidas
`404 Not Found`	O produto com o ID informado não existe ou não está associado a uma configuração de caixa
`500 Internal Server Error`	Ocorreu um erro no servidor