Variantes de caixas
Lê as variantes (caixa x produto, com preço e estoque) das caixas de produto na API legada.
Uma variante liga uma caixa a um produto e guarda o preço da caixa para aquele produto e quantas caixas há para vender. Esta página traz as duas leituras disponíveis.
Listar variantes
Devolve as ligações entre caixas e produtos, com o preço e o estoque de cada uma, em páginas.
/api/v1.0/product_boxes_variantsAdminListar variantes 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: 1items_per_pageintegerpadrão: 10box_idstringproduct_idstringbox_typestringCG/api/v1.0/productboxesvariantsAdminListar variantes (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
curl -u "$EMAIL:$API_KEY" \
"$BASE_URL/api/v1.0/product_boxes_variants?items_per_page=50"Resposta
{
"params": {
"page": 1,
"items_per_page": 10,
"total_items": 4
},
"product_boxes_variants": [
{
"id": "b26c0c55-d0c4-4746-84e2-7e1a246fa568",
"box_id": "bf446c69-239f-481a-8132-87c27b7e78a9",
"product_id": "0641c3f0-1e2e-434a-ac50-87b2aca6c71a",
"price": "9999.00",
"amount": 5,
"box_type": "C",
"timestamp": 1784515076
}
]
}Campos da resposta
product_boxes_variants[].idstringproduct_boxes_variants[].box_idstringproduct_boxes_variants[].product_idstringproduct_boxes_variants[].pricestring"0.00" quer dizer "preço do produto vezes os pares".product_boxes_variants[].amountinteger0 usa o estoque do produto.product_boxes_variants[].box_typestringCGproduct_boxes_variants[].timestampintegerparamsobjectpage, 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} |
Variantes de um produto
Devolve todas as caixas à venda para um produto, sem paginação.
/api/v1.0/product_boxes_variants/{productID}AdminVariantes de caixas de um produto
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 caminho
productIDstringobrigatórioParâmetros de consulta
box_typestringCG/api/v1.0/productboxesvariants/{productID}AdminVariantes de um produto (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
curl -u "$EMAIL:$API_KEY" \
"$BASE_URL/api/v1.0/product_boxes_variants/0641c3f0-1e2e-434a-ac50-87b2aca6c71a?box_type=C"Resposta
{
"product_boxes_variants": [
{
"id": "b26c0c55-d0c4-4746-84e2-7e1a246fa568",
"box_id": "bf446c69-239f-481a-8132-87c27b7e78a9",
"product_id": "0641c3f0-1e2e-434a-ac50-87b2aca6c71a",
"price": "9999.00",
"amount": 5,
"box_type": "C",
"timestamp": 1784515076
}
]
}Os campos de cada variante são os mesmos da listagem. Um produto sem caixas devolve a lista vazia.
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} |