UpPromote Marketplace API
    UpPromote Marketplace API
    • Get offers
      GET
    • Get affiliate links
      GET
    • Get referral orders
      GET
    • Get payments
      GET

      Get referral orders

      GET
      /api/v1/referral
      Retrieve a list of referral orders, or view detailed info for a specific referral, including the associated order, offer, and commission.
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --request GET '/api/v1/referral?page=1&per_page=10&start_date=2024-01-11&end_date=2024-02-11&id=12345&shop_id=56789&referral_id=10262521'
      Response Response Example
      200 - Example 1
      {
    "per_page": 10,
    "current_page": 1,
    "next_page_url": "string",
    "prev_page_url": "string",
    "from": 1,
    "to": 10,
    "data": [
        {
            "id": 0,
            "shop_id": 0,
            "offer_name": "Demo Store",
            "website": "https://demostore.myshopify.com",
            "referral_id": 0,
            "order_number": "6267135590722",
            "total_sales": "100.00",
            "commission_amount": "10.00",
            "currency": "USD",
            "created_at": "2023-01-11T18:06:03.000000Z",
            "sub_id1": "string",
            "sub_id2": "string",
            "sub_id3": "string",
            "status": "PENDING"
        }
    ]
}

      Request

      Authorization
      Provide your bearer token in the
      Authorization
      header when making requests to protected resources.
      Example:
      Authorization: Bearer ********************
      Query Params
      page
      integer 
      optional
      Return the specified page of results. Default is page 1.
      Example:
      1
      per_page
      integer 
      optional
      Number of records per page (max: 100). Default is 10.
      Example:
      10
      start_date
      string <date-time>
      optional
      Start time, a date-only value in the ISO 8601 format.
      Example:
      2024-01-11
      end_date
      string <date-time>
      optional
      End time, a date-only value in the ISO 8601 format.
      Example:
      2024-02-11
      id
      integer 
      optional
      The marketplace listing ID of the offer.
      Example:
      12345
      shop_id
      integer 
      optional
      The UpPromote ID for the brand associated to the offer.
      Example:
      56789
      referral_id
      integer 
      optional
      The UpPromote ID of the referral order for which to show details.
      Example:
      10262521

      Responses

      🟢200Success
      application/json
      Body
      per_page
      integer 
      optional
      The number of referral orders returned per page.
      Default:
      10
      Example:
      10
      current_page
      integer 
      optional
      The current page number being returned in the response.
      Default:
      1
      Example:
      1
      next_page_url
      string 
      optional
      Link to the next page after the current one.
      prev_page_url
      string 
      optional
      Link to the previous page.
      from
      integer 
      optional
      The index of the first referral shown on this page.
      Example:
      1
      to
      integer 
      optional
      The index of the last referral on this page.
      Example:
      10
      data
      array [object {14}] 
      required
      id
      integer 
      optional
      The marketplace listing ID of the offer.
      shop_id
      integer 
      optional
      The UpPromote ID for the brand associated to the offer.
      offer_name
      string 
      optional
      The brand name of the offer.
      Example:
      Demo Store
      website
      string 
      optional
      The website URL of the brand.
      Example:
      https://demostore.myshopify.com
      referral_id
      integer 
      optional
      UpPromote's unique ID for a referral order.
      order_number
      string 
      optional
      The Shopify order number of the referral order.
      Example:
      6267135590722
      total_sales
      string 
      optional
      The total sales of the referral order.
      Example:
      100.00
      commission_amount
      string 
      optional
      The commission amount of the referral order.
      Example:
      10.00
      currency
      string 
      optional
      ISO 3 character currency code.
      <= 3 characters
      Example:
      USD
      created_at
      string <date-time>
      optional
      The date and time when the referral order was created on UpPromote, following the ISO 8601 format.
      Example:
      2023-01-11T18:06:03.000000Z
      sub_id1
      string 
      optional
      sub_id2
      string 
      optional
      sub_id3
      string 
      optional
      status
      enum<string> 
      optional
      The status of this referral order on UpPromote.
      Allowed values:
      PENDINGAPPROVEDDENIEDPAID
      🟠401Unauthorized
      🟠422Parameter Error
      🔴500Server Error
      Modified at 2025-07-04 07:14:47
      Previous
      Get affiliate links
      Next
      Get payments
      Built with