Amo | Integrações
    Amo | Integrações
    • APIs
    • Criando token de autenticação
    • Webhook de pedidos
    • Orders
      • Listar pedidos
        GET
      • Detalhes de um pedido
        GET
      • Atualizar satus de um pedido
        PUT
      • Create Order
        POST
    • Establishments
      • Atualizar disponibilidade da loja
        PUT
      • Atualizar prazo de entrega
        PUT
    • Open Delivery
    • Deliveries
      • Generate Code Delivery
        GET

    Webhook de pedidos

    Configurando o webhook dos pedidos#

    Acessar o painel Amo e selecionar o estabelecimento desejado
    No menu lateral, selecionar a aba de "Configurações" e navegar até "Preferências"
    Nas preferências, selecionar a aba de "Mais opções" e clicar no botão "Editar"
    Navegar até a configuração "POST Webhook dos pedidos"
    Adicionar uma URL válida de API com método POST e salvar

    Recebendo eventos#

    Será feito um POST no endpoint configurado enviando o evento do pedido. Os eventos recebidos correspondem aos status dos pedidos no sistema AMO. Os possíveis status são:
    new: pedido novo
    confirmed: pedido confirmado
    sent: pedido enviado
    completed: pedido concluído
    canceled: pedido cancelado

    Exemplo de requisição#

    {
        method: POST,
        path: $seu_endpoint,
        body: {
          "_id": "string",
          "order": "number",
          "order_day": "number",
          "payment_order": "number",
          "user_id": "string",
          "individual_sale": "boolean",
          "in_production": "boolean",
          "comission": "number",
          "user_name": "string",
          "user_phone": "string",
          "user_email": "string",
          "payment_changes": "number",
          "last_event_name": "string",
          "last_event_at": "string",
          "user": {
            "_id": "string",
            "name": "string",
            "email": "string",
            "phone": "string",
            "document": "string | null",
            "birthday": "string",
            "created_at": "string",
            "next_flash_offer_at": "string"
          },
          "establishment_id": "string",
          "establishment_name": "string",
          "establishment_address": {
            "neighborhood": "string",
            "city": "string",
            "street": "string",
            "number": "number",
            "state": "string",
            "country": "string",
            "complement": "string",
            "zip_code": "string",
            "lng_lat": [
              "number",
              "number"
            ]
          },
          "delivery_type": "string",
          "ignore_delivery_tax": "boolean",
          "deadline": [
            "number"
          ],
          "products": [
            {
              "_id": "string",
              "qnt": "number",
              "use_control_stock": "boolean",
              "name": "string",
              "ref": "string",
              "desc": "string | null",
              "price": "number",
              "normal_price": "number",
              "image": "string | null",
              "promo": "boolean",
              "amo_offers": "boolean",
              "cover_image": "string",
              "free_delivery": "boolean",
              "no_local_payment_method": "boolean",
              "packing_quantity": "number",
              "price_with_variations": "number",
              "price_only_variations": "number",
              "categories": [
                "string"
              ],
              "only_admin": "boolean",
              "flash_offer": "boolean",
              "quantity_total": "number",
              "type": "string"
            }
          ],
          "tax_id": "string | null",
          "tax_receipt": "boolean",
          "transactions": [],
          "note": "string | null",
          "scheduling_date": "string | null",
          "scheduled_at": "string | null",
          "idempotent_key": "string",
          "payment_type": "string",
          "is_amo_go_qualified": "boolean",
          "changes": [
            {
              "payment_status": "string",
              "status": "string",
              "pix_id": "string",
              "user": {
                "_id": "string",
                "name": "string",
                "email": "string",
                "phone": "string",
                "document": "string | null",
                "birthday": "string",
                "created_at": "string"
              }
            }
          ]
        }
    }
    Modificado em 2025-06-10 20:31:33
    Página anterior
    Criando token de autenticação
    Próxima página
    Orders
    Built with