API atual/Referência completa/Preço e estoque

Aviso de volta ao estoque

Inscreve um e-mail para ser avisado quando um produto esgotado voltar, e cancela a inscrição.

Quando um produto acaba, o comprador pode deixar o e-mail para ser avisado na volta do estoque. Estas duas operações criam e cancelam essa inscrição. Elas só funcionam para produtos cuja ação de falta de estoque (out_of_stock_action) é S ("avisar quando voltar"); o valor aparece no detalhe do produto.

Quando o estoque volta, a loja envia o e-mail e a inscrição passa a "avisada".

Inscrever-se

POST/api/v1/storefront/products/{id}/stock-subscribePública

Pede aviso de volta ao estoque

Parâmetros de caminho

iduuidobrigatório

Id do produto (UUID completo).

Corpo da requisição

emailstring

E-mail que recebe o aviso. Obrigatório para visitantes; para cliente logado, o padrão é o e-mail da conta.

unified_variation_idinteger

Opcional. Id da variação específica (por exemplo, o tamanho M) quando só ela está esgotada. Sem ele, vale o produto principal.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/storefront/products/5e833a7f-1a77-402c-835a-32594350d7a7/stock-subscribe" \
  -H "Content-Type: application/json" \
  -d '{"email": "maria.souza@example.com"}'

Resposta

200Inscrição registrada

json

{"id":"9b5f7c0e-3c1a-4d6e-8f21-0a7d4e5b6c11","status":"P"}

Campos da resposta

iduuid

Id da inscrição. Guarde-o para cancelar.

statusstring

PNC

Estado: P pendente (aguardando o estoque voltar), N avisada, C cancelada. Uma nova inscrição vem como P.

Erros

Status	Quando	Corpo de exemplo
400	O produto não aceita aviso (`out_of_stock_action` diferente de `S`).	`{"error":"signup_not_enabled"}`
400	Visitante sem e-mail.	`{"error":"email_required"}`
400	E-mail inválido, ou corpo que não é JSON.	`{"error":"invalid_email"}`
404	O produto não existe.	`{"error":"product_not_found"}`
409	O produto (ou a variação) ainda tem estoque.	`{"error":"already_in_stock"}`

Cancelar a inscrição

DELETE/api/v1/storefront/stock-subscriptions/{id}Pública

Cancela um aviso de volta ao estoque

O próprio id da inscrição serve de chave, junto com o e-mail: quem recebeu o aviso por e-mail pode cancelar sem fazer login.

Parâmetros de caminho

iduuidobrigatório

Id da inscrição, devolvido por stock-subscribe.

Parâmetros de consulta

emailstring

E-mail da inscrição. Obrigatório para visitantes. Para cliente logado, basta o token se o e-mail da conta for o mesmo da inscrição.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/v1/storefront/stock-subscriptions/9b5f7c0e-3c1a-4d6e-8f21-0a7d4e5b6c11?email=maria.souza@example.com"

Resposta

200Inscrição cancelada

json

{"id":"9b5f7c0e-3c1a-4d6e-8f21-0a7d4e5b6c11","status":"C"}

Erros

Status	Quando	Corpo de exemplo
403	O e-mail não confere com o da inscrição, ou não foi enviado.	`{"error":"email_mismatch"}`
404	A inscrição não existe.	`{"error":"subscription_not_found"}`
500	O id não é um UUID válido.	`{"error":"lookup_failed","detail":"..."}`

Veja também

Aviso de volta ao estoque

Inscreve um e-mail para ser avisado quando um produto esgotado voltar, e cancela a inscrição.

Quando o estoque volta, a loja envia o e-mail e a inscrição passa a "avisada".

Inscrever-se

POST/api/v1/storefront/products/{id}/stock-subscribePública

Pede aviso de volta ao estoque

Parâmetros de caminho

iduuidobrigatório

Id do produto (UUID completo).

Corpo da requisição

emailstring

E-mail que recebe o aviso. Obrigatório para visitantes; para cliente logado, o padrão é o e-mail da conta.

unified_variation_idinteger

Opcional. Id da variação específica (por exemplo, o tamanho M) quando só ela está esgotada. Sem ele, vale o produto principal.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/storefront/products/5e833a7f-1a77-402c-835a-32594350d7a7/stock-subscribe" \
  -H "Content-Type: application/json" \
  -d '{"email": "maria.souza@example.com"}'

Resposta

200Inscrição registrada

json

{"id":"9b5f7c0e-3c1a-4d6e-8f21-0a7d4e5b6c11","status":"P"}

Campos da resposta

iduuid

Id da inscrição. Guarde-o para cancelar.

statusstring

PNC

Estado: P pendente (aguardando o estoque voltar), N avisada, C cancelada. Uma nova inscrição vem como P.

Erros

Status	Quando	Corpo de exemplo
400	O produto não aceita aviso (`out_of_stock_action` diferente de `S`).	`{"error":"signup_not_enabled"}`
400	Visitante sem e-mail.	`{"error":"email_required"}`
400	E-mail inválido, ou corpo que não é JSON.	`{"error":"invalid_email"}`
404	O produto não existe.	`{"error":"product_not_found"}`
409	O produto (ou a variação) ainda tem estoque.	`{"error":"already_in_stock"}`

Cancelar a inscrição

DELETE/api/v1/storefront/stock-subscriptions/{id}Pública

Cancela um aviso de volta ao estoque

O próprio id da inscrição serve de chave, junto com o e-mail: quem recebeu o aviso por e-mail pode cancelar sem fazer login.

Parâmetros de caminho

iduuidobrigatório

Id da inscrição, devolvido por stock-subscribe.

Parâmetros de consulta

emailstring

E-mail da inscrição. Obrigatório para visitantes. Para cliente logado, basta o token se o e-mail da conta for o mesmo da inscrição.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/v1/storefront/stock-subscriptions/9b5f7c0e-3c1a-4d6e-8f21-0a7d4e5b6c11?email=maria.souza@example.com"

Resposta

200Inscrição cancelada

json

{"id":"9b5f7c0e-3c1a-4d6e-8f21-0a7d4e5b6c11","status":"C"}

Erros

Status	Quando	Corpo de exemplo
403	O e-mail não confere com o da inscrição, ou não foi enviado.	`{"error":"email_mismatch"}`
404	A inscrição não existe.	`{"error":"subscription_not_found"}`
500	O id não é um UUID válido.	`{"error":"lookup_failed","detail":"..."}`