Getting started

Module

Sales

Fetch Signal-attributed sales with status, product, value and source.

GET/salesScope: readOfficial + BasicRequires Official or Agency plan

List attributed sales.

Use it for financial dashboards, campaign audits and sales reconciliation. Available from the Official plan (below that the API responds 403 upgrade_required).

Path parameters

No additional parameters.

Query parameters
FieldTypeDescription
statusoptionalpending | paid | refunded | chargebackFilters by sale status.
sinceoptionalISO date-timeReturns sales created since this date.
limitoptionalnumberRecords per page. Default 50; maximum 200 on most list endpoints.
offsetoptionalnumberInitial page index. Use pagination.next_offset to fetch the next page.

Body fields

This endpoint does not receive a JSON body.

Ready examples

curl -X GET "https://connect.zyronstack.com/api/v1/sales?status=paid&since=2026-06-01T00:00:00.000Z&limit=20&offset=0" \
  -H "Authorization: Bearer SUA_CHAVE_API"

Responses

200Sales returned.
403upgrade_required: current plan does not include the sales API.

Response example

{
  "data": [
    {
      "id": "91c9fd84-b47f-44ee-9b5e-4e93fc35b912",
      "source": "meta",
      "provider": "kiwify",
      "status": "paid",
      "gross_cents": 19700,
      "fee_cents": 1200,
      "currency": "BRL",
      "product_name": "Produto principal",
      "product_id": "prod_123",
      "conversation_id": "<CONVERSATION_ID>",
      "created_at": "2026-06-15T12:30:00.000Z"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 12,
    "next_offset": null
  }
}