Eventos

Lo que cambió en la tienda en los últimos 30 días, con el registro tal como está ahora. Los mismos eventos van a los endpoints de webhooks.

Cargando el índice de búsqueda…

Eventos

Objetos

Event

  • idintegerobligatorio

    ID del evento; las entregas lo envían como webhook-id. Los eventos se guardan 30 días.

  • typestringobligatorio

    Tipo de evento: order.created, order.updated, order.status_changed, order.paid, order.cancelled; payment.created, payment.succeeded, payment.status_changed, payment.updated; refund.created, refund.completed, refund.status_changed, refund.updated; product.created, product.updated, product.deleted; inventory_level.updated; customer.created, customer.updated, customer.deleted; fiscal_document.created, fiscal_document.updated, fiscal_document.issued, fiscal_document.failed, fiscal_document.annulled; tax_period.status_changed; bulk_operation.finished.

    Valores:
    order.createdorder.updatedorder.status_changedorder.paidorder.cancelledpayment.createdpayment.succeededpayment.status_changedpayment.updatedrefund.createdrefund.completedrefund.status_changedrefund.updatedfiscal_document.createdfiscal_document.updatedfiscal_document.issuedfiscal_document.failedfiscal_document.annulledtax_period.status_changedmoney_transaction.createdmoney_transaction.updatedmoney_transaction.deletedpos_shift.openedpos_shift.closedpos_shift.updatedpos_cash_movement.createdgift_card.createdgift_card.updatedgift_card_transaction.createdcustomer_account.createdcustomer_account.updatedcustomer_account_entry.createdcustomer_account_entry.updatedsupplier.createdsupplier.updatedsupplier.deletedsupplier_bill.createdsupplier_bill.updatedsupplier_bill.postedsupplier_bill.voidedsupplier_bill.deletedsupplier_bill_payment.createdsupplier_bill_payment.updatedsupplier_bill_payment.deletedsettlement_agreement.createdsettlement_agreement.updatedsettlement_agreement.deletedsettlement_offset.createdsettlement_offset.updatedsettlement_offset.voidedpurchase_order.createdpurchase_order.updatedpurchase_order.status_changedpurchase_order.deletedgoods_receipt.createdgoods_receipt.updatedgoods_receipt.voidedsupplier_return.createdsupplier_return.updatedsupplier_return.status_changedsupplier_return.deletedconsignment_settlement.createdconsignment_settlement.updatedconsignment_settlement.postedconsignment_settlement.voidedtax_withholding.createdtax_withholding.updatedtax_withholding.annulledtax_withholding.deletedproduct.createdproduct.updatedproduct.deletedinventory_level.updatedstock_movement.createdstock_movement.updatedlot.createdlot.updatedlot.deletedlocation_transfer.createdlocation_transfer.updatedstocktake.createdstocktake.status_changedstocktake.updatedcustomer.createdcustomer.updatedcustomer.deletedcustomer_group.createdcustomer_group.updatedcustomer_group.deletedprice_list.createdprice_list.updatedprice_list.deletedbulk_operation.finished
  • created_atstring (date-time)obligatorio

    Cuándo ocurrió el cambio.

  • actorobjectobligatorio

    Quién hizo el cambio.

    Campos · 2
    • typestringobligatorio

      integration_app — una aplicación (actor.id es su id de /v1/me); operator — un miembro del personal; customer — un cliente; courier — un cadete; device — una caja u otro dispositivo de la tienda; supplier — un proveedor; system — un proceso automático.

      Valores:
      integration_appoperatorcustomercourierdevicesuppliersystem
    • idinteger o nullobligatorio

      ID del autor entre los de su tipo; null en system.

  • request_idstring o nullobligatorio

    ID de la solicitud de esta aplicación que hizo el cambio (X-Request-Id): con él la aplicación reconoce sus propios cambios. null si el cambio no lo hizo ella.

  • dataobjectobligatorio

    De qué trata el evento.

    Campos · 3

Endpoints

Listar los eventos de la tienda de los últimos 30 días: qué cambió en pedidos, pagos, devoluciones, comprobantes fiscales, períodos fiscales, productos, stock y clientes, con el registro tal como está ahora

get/events

Scope: webhooks:read

Parámetros

Query

  • limitinteger

    Tamaño de página: hasta 250 registros; 50 por defecto.

    Mínimo:
    1
    Máximo:
    250
  • cursorstring

    Cursor opaco: next_cursor de la página anterior, o sync_cursor de la última página guardado por la sincronización anterior. El listado va en orden de confirmación, así que el cursor de sincronización devuelve luego solo lo que cambió después de él.

    Largo máximo:
    4096
  • typestring

    Solo los eventos de este tipo, como order.paid.

    Valores:
    order.createdorder.updatedorder.status_changedorder.paidorder.cancelledpayment.createdpayment.succeededpayment.status_changedpayment.updatedrefund.createdrefund.completedrefund.status_changedrefund.updatedfiscal_document.createdfiscal_document.updatedfiscal_document.issuedfiscal_document.failedfiscal_document.annulledtax_period.status_changedmoney_transaction.createdmoney_transaction.updatedmoney_transaction.deletedpos_shift.openedpos_shift.closedpos_shift.updatedpos_cash_movement.createdgift_card.createdgift_card.updatedgift_card_transaction.createdcustomer_account.createdcustomer_account.updatedcustomer_account_entry.createdcustomer_account_entry.updatedsupplier.createdsupplier.updatedsupplier.deletedsupplier_bill.createdsupplier_bill.updatedsupplier_bill.postedsupplier_bill.voidedsupplier_bill.deletedsupplier_bill_payment.createdsupplier_bill_payment.updatedsupplier_bill_payment.deletedsettlement_agreement.createdsettlement_agreement.updatedsettlement_agreement.deletedsettlement_offset.createdsettlement_offset.updatedsettlement_offset.voidedpurchase_order.createdpurchase_order.updatedpurchase_order.status_changedpurchase_order.deletedgoods_receipt.createdgoods_receipt.updatedgoods_receipt.voidedsupplier_return.createdsupplier_return.updatedsupplier_return.status_changedsupplier_return.deletedconsignment_settlement.createdconsignment_settlement.updatedconsignment_settlement.postedconsignment_settlement.voidedtax_withholding.createdtax_withholding.updatedtax_withholding.annulledtax_withholding.deletedproduct.createdproduct.updatedproduct.deletedinventory_level.updatedstock_movement.createdstock_movement.updatedlot.createdlot.updatedlot.deletedlocation_transfer.createdlocation_transfer.updatedstocktake.createdstocktake.status_changedstocktake.updatedcustomer.createdcustomer.updatedcustomer.deletedcustomer_group.createdcustomer_group.updatedcustomer_group.deletedprice_list.createdprice_list.updatedprice_list.deletedbulk_operation.finished
  • created_sincestring (date-time)

    Solo los eventos creados después de este momento.

    Patrón:
    ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$

Respuestas

200Éxito

application/json

  • dataarray de Eventobligatorio

    Registros de la página.

  • deletedarray de objectobligatorio

    Registros borrados de la base desde el cursor, como marcas de eliminación: solo con include_deleted=true en la continuación por el cursor de sincronización.

    Campos · 2
    • idintegerobligatorio

      ID del registro borrado.

    • deleted_atstring (date-time)obligatorio

      Cuándo se borró el registro.

  • next_cursorstring o nullobligatorio

    Cursor de la página siguiente; null en la última.

  • has_morebooleanobligatorio

    true si hay una página siguiente.

  • sync_cursorstring o nullobligatorio

    En la última página — el cursor desde el que continuar más tarde: con él llega solo lo que cambió después de esta página. null en las demás.

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

410El cursor de sincronización supera el plazo de conservación de eliminaciones o se emitió antes de restaurar la base de datos

application/problem+json

Devuelve Problem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Errores de este endpoint

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl "https://api.saleya.app/v1/events" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "data": [
    {
      "id": 0,
      "type": "order.created",
      "created_at": "2026-01-15T12:00:00Z",
      "actor": {
        "type": "integration_app",
        "id": 0
      },
      "request_id": "string",
      "data": {
        "id": 0,
        "object": {
          "id": 0,
          "number": "string",
          "channel": "web",
          "app_id": 0,
          "location_id": 0,
          "legal_entity_id": 0,
          "status": "string",
          "status_group": "pos_open",
          "payment_status": "unpaid",
          "sale_type": "retail",
          "currency": "string",
          "items_total": 0,
          "discount": 0,
          "applied_discounts": [
            {
              "id": 0,
              "source": "promocode",
              "kind": "promo",
              "name": {},
              "code": "string",
              "reason": "string",
              "order_item_id": 0,
              "amount": 0
            }
          ],
          "delivery_cost": 0,
          "delivery_discount": 0,
          "delivery_discounts": [
            {
              "id": 0,
              "source": "promocode",
              "kind": "promo",
              "name": {},
              "code": "string",
              "amount": 0
            }
          ],
          "delivery_tax_lines": [
            {
              "regime": "vat",
              "kind": "taxed",
              "rate_bps": 0,
              "base": 0,
              "amount": 0,
              "jurisdiction": "string"
            }
          ],
          "platform_discount": 0,
          "platform_service_fee": 0,
          "platform_delivery_fee": 0,
          "total": 0,
          "tax_lines": [
            {
              "regime": "vat",
              "kind": "taxed",
              "rate_bps": 0,
              "base": 0,
              "amount": 0,
              "jurisdiction": "string"
            }
          ],
          "gift_card_issue_amount": 0,
          "reservation_deposit_amount": 0,
          "account_payment_amount": 0,
          "service_package_issue_amount": 0,
          "payment_method": "cash",
          "manual_payment_method_id": 0,
          "delivery_method_id": 0,
          "fulfilment_type": "self_pickup",
          "delivery_slots": [
            {
              "from": "string",
              "to": "string"
            }
          ],
          "shipment": {
            "carrier": "andreani",
            "carrier_name": "string",
            "tracking_number": "string",
            "tracking_url": "string",
            "status": "accepted",
            "status_at": "2026-01-15T12:00:00Z",
            "events": [
              {
                "status": "accepted",
                "description": "string",
                "occurred_at": "2026-01-15T12:00:00Z"
              }
            ],
            "label_available": true
          },
          "previous_shipments": [
            {
              "carrier": "andreani",
              "carrier_name": "string",
              "tracking_number": "string",
              "tracking_url": "string",
              "status": "accepted",
              "status_at": "2026-01-15T12:00:00Z",
              "events": [
                {
                  "status": "accepted",
                  "description": "string",
                  "occurred_at": "2026-01-15T12:00:00Z"
                }
              ]
            }
          ],
          "shipment_attempt": {
            "state": "queued",
            "started_at": "2026-01-15T12:00:00Z",
            "error": {
              "code": "no_carrier",
              "message": "string"
            }
          },
          "merged_into_order_id": 0,
          "cancel_reason": "payment_init_failed",
          "items": [
            {
              "id": 0,
              "variant_id": 0,
              "product_id": 0,
              "product_name": {
                "key": "string"
              },
              "variant_name": {
                "key": "string"
              },
              "quantity": "string",
              "unit": "pcs",
              "unit_price": 0,
              "total": 0,
              "discount": 0,
              "discount_allocations": [
                {
                  "applied_discount_id": 0,
                  "amount": 0
                }
              ],
              "is_gift": true,
              "tax_lines": [
                {
                  "regime": "vat",
                  "kind": "taxed",
                  "rate_bps": 0,
                  "base": 0,
                  "amount": 0,
                  "jurisdiction": "string"
                }
              ],
              "cost_amount": 0,
              "cost_basis": "variant"
            }
          ],
          "customer": {
            "id": 0,
            "name": "string",
            "phone": "string",
            "email": "string"
          },
          "delivery_address": {
            "kind": "address",
            "recipient": "string",
            "phone": "string",
            "street": "string",
            "house": "string",
            "apartment": "string",
            "floor": "string",
            "entrance": "string",
            "district": "string",
            "city": "string",
            "province": "string",
            "postal_code": "string",
            "address_line": "string",
            "comment": "string",
            "location": {
              "lat": 0,
              "lng": 0
            },
            "branch": {
              "external_id": "string",
              "name": "string"
            }
          },
          "customer_comment": "string",
          "fiscal_receptor": {
            "id_type": "tax_id",
            "id_number": "string",
            "name": "string",
            "tax_status": "registered",
            "address": "string"
          },
          "external_fiscal_document": {
            "issuer": "string",
            "status": "pending",
            "number": "string"
          },
          "placed_at": "2026-01-15T12:00:00Z",
          "confirmed_at": "2026-01-15T12:00:00Z",
          "completed_at": "2026-01-15T12:00:00Z",
          "cancelled_at": "2026-01-15T12:00:00Z",
          "refunded_at": "2026-01-15T12:00:00Z",
          "created_at": "2026-01-15T12:00:00Z",
          "updated_at": "2026-01-15T12:00:00Z"
        },
        "previous_attributes": {
          "status": "string"
        }
      }
    }
  ],
  "deleted": [
    {
      "id": 0,
      "deleted_at": "2026-01-15T12:00:00Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true,
  "sync_cursor": "string"
}