> ## Documentation Index
> Fetch the complete documentation index at: https://developers.papelship.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List conversions

> Needs the affiliate programme (`FEATURE_NOT_ENABLED` otherwise). 25 per page, cursor based.

**Permission:** `affiliates:read`



## OpenAPI

````yaml /api-reference/openapi/user-api.yaml get /affiliates/conversions
openapi: 3.0.3
info:
  title: PapelShip Store API
  version: 1.0.0
  description: >-
    Manage your PapelShip store from your own systems: create orders, sync
    products and stock, ship physical orders, answer support tickets and react
    to events.


    Every request needs your API key in `x-api-key` and your store ID in
    `x-store-hash`. Amounts are integers in minor units (`2999` = 29.99). Dates
    are ISO 8601 in UTC.
  contact:
    name: PapelShip Support
    email: support@papelship.com
    url: https://papelship.com
servers:
  - url: https://app.papelship.com/api/v1
    description: Production
security:
  - ApiKey: []
    StoreHash: []
tags:
  - name: Account
    description: Your key, store and payment methods.
  - name: Orders
    description: Create orders, take manual payments, cancel, refund and read deliveries.
  - name: Products
    description: Products and their settings.
  - name: Variants & stock
    description: Variants, physical stock and license keys.
  - name: Product content
    description: Media, SEO, payment methods, files and stock alerts.
  - name: Categories
    description: Organise products.
  - name: Groups
    description: Collections of products.
  - name: Coupons
    description: Discount codes.
  - name: Customers
    description: Buyers and their history.
  - name: Blocklist
    description: Emails and IPs that can't place orders.
  - name: Reviews
    description: Customer reviews.
  - name: Support
    description: Support tickets.
  - name: Subscriptions
    description: Recurring products and auto-renewals.
  - name: Fulfillment
    description: Ship physical orders.
  - name: Returns
    description: Return requests.
  - name: Shipping settings
    description: Zones, rates and locations.
  - name: Webhooks
    description: Endpoints, deliveries and event types.
  - name: Affiliates
    description: Partner programme.
  - name: Analytics
    description: Sales summary.
paths:
  /affiliates/conversions:
    get:
      tags:
        - Affiliates
      summary: List conversions
      description: >-
        Needs the affiliate programme (`FEATURE_NOT_ENABLED` otherwise). 25 per
        page, cursor based.


        **Permission:** `affiliates:read`
      operationId: listAffiliateConversions
      parameters:
        - in: query
          name: status
          schema:
            type: string
            enum:
              - all
              - valid
              - flagged
              - rejected
        - in: query
          name: partner
          schema:
            type: string
          description: Partner ID.
        - in: query
          name: cursor
          schema:
            type: integer
          description: '`next_cursor` from the previous page.'
      responses:
        '200':
          description: A page
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  conversions:
                    type: array
                    items:
                      $ref: '#/components/schemas/AffiliateConversion'
                  next_cursor:
                    type: integer
                    nullable: true
                  counts:
                    type: object
                    properties: {}
                    description: Records per status.
                    additionalProperties:
                      type: integer
                required:
                  - success
components:
  schemas:
    AffiliateConversion:
      type: object
      properties:
        invoice_id:
          type: string
        captured_at:
          type: string
          format: date-time
          example: '2026-10-04T12:00:00.000Z'
        paid_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-10-04T12:00:00.000Z'
        source:
          type: string
          enum:
            - link
            - coupon
            - api
            - renewal
        status:
          type: string
          enum:
            - valid
            - flagged
            - rejected
        flags:
          type: array
          items:
            type: string
            enum:
              - self_referral
              - other_coupon
              - high_fraud_score
              - velocity
        order_total:
          type: integer
        order_currency:
          type: string
        invoice_status:
          type: string
        refund_status:
          type: string
          nullable: true
        partner:
          type: object
          properties:
            id:
              type: string
              example: 7fKq2LmN9xPa3RtB
            email:
              type: string
            name:
              type: string
              nullable: true
        link_code:
          type: string
          nullable: true
        commission:
          type: integer
          description: Net, minor units.
        commission_currency:
          type: string
        commission_state:
          type: string
          enum:
            - none
            - unpaid
            - held
            - pending
            - available
        available_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-10-04T12:00:00.000Z'
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your Store API key (`pk_live_...`). Create it in **Developers › API
        keys**.
    StoreHash:
      type: apiKey
      in: header
      name: x-store-hash
      description: >-
        The ID of the store the request is for. Shown in **Developers › API
        keys**.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.