Buscapé - API de Pedidos - Recursos

A API pedidos possui todos os recursos necessários para que você esteja apto a vender seus produtos através do site Buscapé.


Consulta os dados de um pedido a partir de seu ID (no Buscapé).

Deve ser usado para recuperar os dados do pedido recebido pelo evento de callback. Nesta API todos os dados são retornados, inclusive dados do usuário que realizou a compra e de envio.

URL
Produção http://api.buscape.com.br
Sandbox http://sandbox-api.buscape.com.br
HEADERS
app-token Token de aplicação
auth-token Token de autenticação
Gerar URL Modelo Básico
Produção http://api.buscape.com.br/orders/{order_id}
Sandbox http://sandbox-api.buscape.com.br/orders/{order_id}

REQUEST
PARÂMETROS
Nome Tipo   Descrição
order_id PathVariable Obrigatório ID do pedido no Buscapé.

RESPONSE

Status Code: 200

BODY

Atualiza o status de um pedido a partir de seu ID (no Buscapé).

Deve ser utilizado para nos manter atualizados quanto aos status do pedido, isto é, enviado, cancelado ou entregue.

URL
Produção http://api.buscape.com.br
Sandbox http://sandbox-api.buscape.com.br
HEADERS
Content-Type application/json; charset=utf-8
app-token Token de aplicação
auth-token Token de autenticação
Gerar URL Modelo Básico
Produção http://api.buscape.com.br/orders/{order_id}
Sandbox http://sandbox-api.buscape.com.br/orders/{order_id}

REQUEST
PARÂMETROS
Nome Tipo   Descrição
order_id PathVariable Obrigatório ID do pedido no Buscapé.
BODY

{"status":"","reason":"","trackingCode":"","deliveryDate":""}

 


RESPONSE

Status Code: 200

Em caso de sucesso, o HttpCode será 200 e não retornará nenhum body.

Status Code: 400

BODY

Consulta os dados de pedidos a partir do status desejado.

Deve ser usado para garantir que todos os pedidos realizados no buscapé estão sendo processados na plataforma/loja, isto é, garantir que pedidos onde o evento de callback não funcionou possam ser processados e não fique sem o atendimento necessário (nossa sugestão é que esse procedimento seja automático e rode a cada 1 hora). Também pode ser usado para construir uma interface para o lojista verificar os pedidos que entraram através do buscapé.

URL
Produção http://api.buscape.com.br
Sandbox http://sandbox-api.buscape.com.br
HEADERS
app-token Token de aplicação
auth-token Token de autenticação
Gerar URL Modelo Básico
Produção http://api.buscape.com.br/orders/status/{status}
Sandbox http://sandbox-api.buscape.com.br/orders/status/{status}

REQUEST
PARÂMETROS
Nome Tipo   Descrição
status PathVariable Obrigatório Status do Pedido. Valores aceitos:
  • NEW
  • APPROVED
  • SENT
  • DELIVERED
  • CANCELLED
page QueryString Opcional Determina a página que deseja consultar os pedidos.
quantity QueryString Opcional Quantidade de resultados por página.

RESPONSE

Status Code: 200

BODY

O evento de callback é um webservice RESTFul que a loja deverá construir (seguindo a definição abaixo) para receber as novas vendas e confirmações de pagamento dos pedidos realizados através do site Buscapé.

Deve ser criado pela plataforma/loja para receber uma requisição do buscapé informando que uma venda foi realizada através do site Buscapé. O recebimento deste evento pode disparar, de acordo com status recebido, no sistema da loja a reserva do estoque, a criação do pedido e o envio do pedido.

Fluxo macro do comportamento da loja em cada status do pedido

  • Após receber o status new, a loja deverá reservar o estoque do produto.
  • Após receber o status approved, a loja deverá enviar o produto para o cliente.
  • Após receber o status cancelled, a loja deverá devolver o estoque reservado.
URL
Produção URL definida pela loja/plataforma
HEADERS
Content-Type application/json; charset=utf-8
Gerar URL Modelo Básico
Produção URL definida pela loja/plataforma/buscape/orders/callback

REQUEST
BODY

Na requisição realizada pelo Buscapé ao webservice de callback da loja será enviado as informações do pedido no formato a seguir:

{"status":"","processDate":"","orderId":""}

 


RESPONSE

Status Code: 200

Na resposta do callback deverá ser retornado o ID do pedido gerado pelo lojista, conforme exemplo abaixo:

BODY