API legada/Guia rápido/Embalagens e caixas

Alterar caixa

Altera uma caixa de produto na API legada, enviando só os campos que mudam.

Use esta rota para corrigir a composição de uma caixa, trocar seus textos ou tirá-la de venda.

Alterar uma caixa

Altera tipo, status, composição ou textos de uma caixa. Só o que você enviar muda; size_qty_info, quando enviado, substitui a composição inteira.

PUT/api/v1.0/product_boxes/{boxID}Admin

Alterar uma caixa

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

boxIDstringobrigatório

Id da caixa: o UUID ou, se a caixa veio de uma plataforma anterior, o número legado.

Corpo da requisição

box_typestring

CG

Tipo da caixa. Obrigatório no POST.

statusstring

ADH

Status. Padrão A no POST.

size_qty_infoarray

Composição, lista de {"size","amount"}. No POST, ao menos uma linha com tamanho e quantidade maior que zero. No PUT, substitui a lista inteira.

size_variant_idstring

Valor de tamanho. No PUT, "" desliga a ligação.

descriptionsobject

Textos por idioma: {"pt-BR": {"title": "...", "description": "..."}}. No POST, ao menos um título com texto.

PUT/api/v1.0/productboxes/{boxID}Admin

Alterar uma caixa (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

bash

curl -X PUT -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "D", "size_qty_info": [{"size": "40", "amount": 4}]}' \
  "$BASE_URL/api/v1.0/product_boxes/959af717-ae72-427b-a497-58d3ff422cc8"

Resposta

200Caixa alterada

json

{
  "box_id": "959af717-ae72-427b-a497-58d3ff422cc8",
  "box_type": "G",
  "status": "D",
  "size_qty_info": [
    {
      "size": "40",
      "amount": 4
    }
  ],
  "size_variant_id": "",
  "title": "Grade 37 e 38",
  "description": "Grade com 6 pares",
  "lang_code": "pt-BR",
  "timestamp": 1791752065
}

O corpo é a caixa alterada, nos mesmos campos de Listar e consultar caixas.

Erros

Status	Quando	Corpo
400	Corpo inválido, ou valor recusado pela regra da caixa	`{"message":"invalid request body","status":400}`
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}`
404	A caixa não existe	`{"message":"product box not found","status":404}`
500	Falha interna, ou módulo `product-boxes` desligado	`{"message":"product-boxes: module disabled for tenant","status":500}`

Veja também

Alterar caixa

Altera uma caixa de produto na API legada, enviando só os campos que mudam.

Use esta rota para corrigir a composição de uma caixa, trocar seus textos ou tirá-la de venda.

Alterar uma caixa

Altera tipo, status, composição ou textos de uma caixa. Só o que você enviar muda; size_qty_info, quando enviado, substitui a composição inteira.

PUT/api/v1.0/product_boxes/{boxID}Admin

Alterar uma caixa

Parâmetros de caminho

boxIDstringobrigatório

Id da caixa: o UUID ou, se a caixa veio de uma plataforma anterior, o número legado.

Corpo da requisição

box_typestring

CG

Tipo da caixa. Obrigatório no POST.

statusstring

ADH

Status. Padrão A no POST.

size_qty_infoarray

Composição, lista de {"size","amount"}. No POST, ao menos uma linha com tamanho e quantidade maior que zero. No PUT, substitui a lista inteira.

size_variant_idstring

Valor de tamanho. No PUT, "" desliga a ligação.

descriptionsobject

Textos por idioma: {"pt-BR": {"title": "...", "description": "..."}}. No POST, ao menos um título com texto.

PUT/api/v1.0/productboxes/{boxID}Admin

Alterar uma caixa (nome sem sublinhado)

Exemplo de requisição

bash

curl -X PUT -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "D", "size_qty_info": [{"size": "40", "amount": 4}]}' \
  "$BASE_URL/api/v1.0/product_boxes/959af717-ae72-427b-a497-58d3ff422cc8"

Resposta

200Caixa alterada

json

{
  "box_id": "959af717-ae72-427b-a497-58d3ff422cc8",
  "box_type": "G",
  "status": "D",
  "size_qty_info": [
    {
      "size": "40",
      "amount": 4
    }
  ],
  "size_variant_id": "",
  "title": "Grade 37 e 38",
  "description": "Grade com 6 pares",
  "lang_code": "pt-BR",
  "timestamp": 1791752065
}

O corpo é a caixa alterada, nos mesmos campos de Listar e consultar caixas.

Erros

Status	Quando	Corpo
400	Corpo inválido, ou valor recusado pela regra da caixa	`{"message":"invalid request body","status":400}`
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}`
404	A caixa não existe	`{"message":"product box not found","status":404}`
500	Falha interna, ou módulo `product-boxes` desligado	`{"message":"product-boxes: module disabled for tenant","status":500}`