VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/PDV e terminal de balcão

Nomes alternativos do fechamento

Os endereços wk_pos_checkout e wkposcheckout, equivalentes a pos_checkout, para os terminais já instalados.

Os terminais antigos fecham a venda por wk_pos_checkout ou wkposcheckout. Os dois endereços executam o mesmo código de Fechar a venda: mesmo corpo, mesma resposta, mesmos erros, e a mesma limitação (produto físico exige forma de envio, que esta rota não aceita). Em software novo use pos_checkout.

Exigem um usuário administrador. Com /api/v1.0 os ids são UUID; com /api são decimais.

POST/api/v1.0/wk_pos_checkoutAdmin

Mesmo que pos_checkout, ids UUID

Igual a POST /api/v1.0/pos_checkout.

Corpo da requisição

scopestringobrigatório
place_order
Tem de ser place_order.
order_agentstringobrigatório
Identificação do caixa. Não é gravado.
product_infoarrayobrigatório
Itens: product_id, qty, is_free_product, selected_options.
customer_infoobjectobrigatório
email (obrigatório), user_id, firstname, lastname.
payment_infoobject
payment_type, o código da forma de pagamento.
shipping_coststringpadrão: 0
Frete em string decimal.
discountstringpadrão: 0
Desconto em string decimal.
order_commentstring
Observação do pedido.
POST/api/wk_pos_checkoutAdmin

Mesmo que pos_checkout, ids decimais

Igual a POST /api/pos_checkout.

Corpo da requisição

scopestringobrigatório
place_order
Tem de ser place_order.
order_agentstringobrigatório
Identificação do caixa. Não é gravado.
product_infoarrayobrigatório
Itens: product_id, qty, is_free_product, selected_options.
customer_infoobjectobrigatório
email (obrigatório), user_id, firstname, lastname.
payment_infoobject
payment_type, o código da forma de pagamento.
shipping_coststringpadrão: 0
Frete em string decimal.
discountstringpadrão: 0
Desconto em string decimal.
order_commentstring
Observação do pedido.
POST/api/v1.0/wkposcheckoutAdmin

Mesmo que pos_checkout, ids UUID

Igual a POST /api/v1.0/pos_checkout.

Corpo da requisição

scopestringobrigatório
place_order
Tem de ser place_order.
order_agentstringobrigatório
Identificação do caixa. Não é gravado.
product_infoarrayobrigatório
Itens: product_id, qty, is_free_product, selected_options.
customer_infoobjectobrigatório
email (obrigatório), user_id, firstname, lastname.
payment_infoobject
payment_type, o código da forma de pagamento.
shipping_coststringpadrão: 0
Frete em string decimal.
discountstringpadrão: 0
Desconto em string decimal.
order_commentstring
Observação do pedido.
POST/api/wkposcheckoutAdmin

Mesmo que pos_checkout, ids decimais

Igual a POST /api/pos_checkout.

Corpo da requisição

scopestringobrigatório
place_order
Tem de ser place_order.
order_agentstringobrigatório
Identificação do caixa. Não é gravado.
product_infoarrayobrigatório
Itens: product_id, qty, is_free_product, selected_options.
customer_infoobjectobrigatório
email (obrigatório), user_id, firstname, lastname.
payment_infoobject
payment_type, o código da forma de pagamento.
shipping_coststringpadrão: 0
Frete em string decimal.
discountstringpadrão: 0
Desconto em string decimal.
order_commentstring
Observação do pedido.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1.0/wk_pos_checkout" \
  -u "$ADMIN_EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"scope":"place_order","order_agent":"caixa-01","product_info":[{"product_id":"d8a6c5e7-8e44-4055-a0e2-49014f5d17f6","qty":1}],"customer_info":{"user_id":"f12f30a9-cbec-40ba-98f1-b7fa8f2e8e10","email":"maria.souza@example.com","firstname":"Maria","lastname":"Souza"},"payment_info":{"payment_type":"pagamento-na-entrega"}}'

Resposta

200Venda registrada (resumo)
json
{
  "status": 200,
  "data": {
    "success": true,
    "message": "",
    "order_data": { "order_id": "3f73310d-bfdd-4713-a664-305c08eda58b", "status": "O", "date": 1791749845, "error": [] }
  }
}

Todos os campos da resposta estão em Fechar a venda.

Erros

Os mesmos de Fechar a venda: erros de negócio com HTTP 200 e data.success: false, 401 sem credencial e 403 para quem não é administrador.

Produto físico continua sendo recusado

Escolher outro nome não muda a regra: sem forma de envio, uma loja que calcula frete recusa a venda de produto físico com shipping_service_unavailable.

Veja também

  • Fechar a venda
  • Login do caixa
Anterior
Nomes alternativos do catálogo
Próxima
Pedidos: rotas sem versão e app do seller
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também