Transactions

[v3.0] List Transactions

Returns a paginated list of transactions for the authenticated vendor within the specified date range.

Pagination: Use page_size and page_index to paginate through results. Check meta.pagination.has_more to determine if additional pages exist.

Date filtering: Transactions are included if their sale date OR refund date falls within the specified range. This ensures that a transaction refunded in January will appear in a January query even if the original sale was in December.

get/v3.0/transactions

Request

  • Base URL: https://api.jvzoo.com
  • URL: https://api.jvzoo.com/v3.0/transactions
  • Auth: HTTP basic

Query parameters

start_datestring date required

Start date in ISO 8601 format (e.g., 2025-01-01).

end_datestring date required

End date in ISO 8601 format. Must be greater than or equal to start_date.

page_sizeinteger

Number of results per page. Default 50, max 200.

page_indexinteger

Zero-based page index.

Response

Success

Example response

{
  "meta": {
    "status": {
      "http_status_code": 200,
      "code": 2000,
      "message": "Success"
    },
    "results_count": 2,
    "api_version": "3.0",
    "total_count": 150,
    "pagination": {
      "page_size": 50,
      "has_more": true
    }
  },
  "results": [
    {
      "transaction_id": "AP-1234567890ABCDEFG",
      "sale_date": "2025-01-15T14:30:00+00:00",
      "product_id": 123456,
      "product_name": "My Product",
      "amount": "97.00",
      "status": "settled",
      "customer": {
        "email": "larry@smith.com",
        "first_name": "Larry",
        "last_name": "Smith"
      },
      "affiliate": {
        "id": 98765,
        "display_name": "Joe Affiliate"
      },
      "tracking": {
        "vtid": "blackfriday",
        "custom": "source=fb&campaign=42",
        "tid": "fb-campaign-42",
        "utm_source": "facebook",
        "utm_medium": "cpc",
        "utm_campaign": "blackfriday2025",
        "utm_content": "hero-banner",
        "utm_term": "weight-loss",
        "sub_id1": "creative-A",
        "gclid": "Cj0KCQiA...",
        "fbclid": "IwAR1...",
        "other_params": "source=newsletter&ref=jan25"
      },
      "payouts": {
        "seller_earnings": "48.50",
        "affiliate_payout": "38.80",
        "agent_payout": "0.00",
        "jv_payout": "0.00",
        "jvzoo_fee": "9.70"
      },
      "refund": {
        "refund_date": "2025-01-20T14:00:00+00:00",
        "refund_amount": "97.00",
        "seller_refund_impact": "-48.50",
        "affiliate_refund_impact": "-38.80",
        "agent_refund_impact": "0.00",
        "jv_refund_impact": "0.00",
        "jvzoo_fee_adjustment": "-9.70"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.