API Reference

Este webhook será acionado sempre que:

  • O status de um pedido for alterado na loja;
  • Um novo pedido for cadastrado na loja.

A URI deverá ser cadastrada no aplicativo do cliente, como um callback de "Pedido":

O body da requisição enviada à URI configurada será o mesmo de um item da requisição: Listar Pedidos

{
    "entity_id": 1,
    "increment_id": "100000001",
    "state": "new",
    "checkout_url": "",
    "created_at": "2023-08-07T10:44:23",
    "updated_at": "2023-08-07T10:44:23",
    "subtotal": 240,
    "total": 255,
    "shipping": {
        "price": 15,
        "method": "Correios",
        "address_id": 1
    },
    "payment": {
        "total_discount": 0,
        "gateway": "getpago_pix",
        "type": "pix",
        "installments": false,
        "address_id": 2
    },
    "customer": {
        "entity_id": false,
        "firstname": "Get Commerce",
        "lastname": "Loja Virtual",
        "email": "[email protected]",
        "document": "00000000000",
        "telephone": "5555999999999" 
    },
    "items": [
        {
            "entity_id": 17,
            "sku": "sku-do-produto",
            "price": 80,
            "qty": 1
        },
        {
            "entity_id": 19,
            "sku": "sku-do-produto-2",
            "price": 80,
            "qty": 5
        }
    ]
}