WarriorPlus API

https://warriorplus.com/api/docs
Admin
WarriorPlus API is a comprehensive REST API for managing sales, purchases, products, offers,...
Tokens:23,252
Snippets:88
Trust Score:9.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Offer Details

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves details for a specific offer by its ID.

```APIDOC
## GET /api/v2/offers/{offer_id}

### Description
Retrieves details for a specific offer by its ID.

### Method
GET

### Endpoint
/api/v2/offers/{offer_id}

### Parameters
#### Path Parameters
- **offer_id** (string) - Required - The unique identifier of the offer.

### Response
#### Success Response (200)
- **success** (integer) - Indicates the success of the operation (1 for success).
- **object** (string) - Type of the returned object, typically 'offer'.
- **id** (string) - The unique identifier of the offer.
- **created** (string) - The date and time the offer was created.
- **name** (string) - The name of the offer.
- **start_date** (string) - The start date of the offer.
- **end_date** (string) - The end date of the offer (null if not set).
- **status** (string) - The current status of the offer (e.g., 'active').
- **sale_cnt** (integer) - The number of sales for the offer.
- **refund_cnt** (integer) - The number of refunds for the offer.
- **aggregate_sales** (string) - The total sales revenue for the offer.
- **offer_meta** (object) - Metadata about the offer.
- **affiliate_program** (object) - Information about the affiliate program for the offer.
- **pages** (object) - Information about the pages associated with the offer.
```

--------------------------------

### Get Page Details

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves details for a specific page within an offer.

```APIDOC
## GET /api/v2/offers/{offer_id}/pages/{page_id}

### Description
Retrieves details for a specific page within an offer.

### Method
GET

### Endpoint
/api/v2/offers/{offer_id}/pages/{page_id}

### Parameters
#### Path Parameters
- **offer_id** (string) - Required - The unique identifier of the offer.
- **page_id** (string) - Required - The unique identifier of the page.

### Response
#### Success Response (200)
- **success** (integer) - Indicates the success of the operation (1 for success).
- **object** (string) - Type of the returned object, typically 'page'.
- **id** (string) - The unique identifier of the page.
- **name** (string) - The name of the page.
- **page_url** (string) - The URL of the page.
- **created** (string) - The date and time the page was created.
- **offer** (string) - The ID of the offer this page belongs to.
- **products** (object) - Information about the products associated with the page.
```

--------------------------------

### Get a Product

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves a single product object based on the provided product ID.

```APIDOC
## GET /products/{productId}

### Description
Returns a single product object for the specified product ID.

### Method
GET

### Endpoint
/products/{productId}

### Parameters
#### Path Parameters
- **productId** (string) - Required - The unique identifier of the product.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the product.
- **name** (string) - The name of the product.
- **price** (number) - The price of the product.

#### Response Example
{
  "id": "prod_123",
  "name": "Example Product",
  "price": 19.99
}
```

--------------------------------

### Get Affiliate Details

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves details for a specific affiliate by its ID.

```APIDOC
## GET /api/v2/affiliates/{affiliate_id}

### Description
Retrieves details for a specific affiliate by its ID.

### Method
GET

### Endpoint
/api/v2/affiliates/{affiliate_id}

### Parameters
#### Path Parameters
- **affiliate_id** (string) - Required - The unique identifier of the affiliate.

### Response
#### Success Response (200)
- **success** (integer) - Indicates the success of the operation (1 for success).
- **object** (string) - Type of the returned object, typically 'affiliate'.
- **id** (string) - The unique identifier of the affiliate.
- **created** (string) - The date and time the affiliate was created.
- **affiliate_username** (string) - The username of the affiliate.
- **affiliate_name** (string) - The display name of the affiliate.
- **cnt_approved** (integer) - Count of approved requests.
- **cnt_pending** (integer) - Count of pending requests.
- **cnt_denied** (integer) - Count of denied requests.
- **sale_cnt** (integer) - Total number of sales generated by the affiliate.
- **sale_revenue** (string) - Total revenue generated by the affiliate.
- **refund_cnt** (integer) - Total number of refunds for the affiliate's sales.
- **affiliate_requests** (object) - Information about affiliate requests made by this affiliate.
```

--------------------------------

### Get an Offer

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves a single offer object based on the provided offer ID.

```APIDOC
## GET /offers/{offerId}

### Description
Returns a single offer object for the specified offer ID.

### Method
GET

### Endpoint
/offers/{offerId}

### Parameters
#### Path Parameters
- **offerId** (string) - Required - The unique identifier of the offer.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the offer.
- **name** (string) - The name of the offer.

#### Response Example
{
  "id": "offer_abc",
  "name": "Example Offer"
}
```

--------------------------------

### Get Product Details

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves detailed information about a specific product. This includes product metadata, sales statistics, and vendor information.

```APIDOC
## GET /api/v2/products/{id}

### Description
Retrieves details for a specific product.

### Method
GET

### Endpoint
/api/v2/products/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the product.

### Response
#### Success Response (200)
- **success** (integer) - Indicates the success of the operation (1 for success).
- **object** (string) - Type of the object, e.g., "product".
- **id** (string) - Unique identifier for the product.
- **created** (string) - Timestamp when the product was created.
- **name** (string) - Name of the product.
- **sale_type** (string) - Type of sale (e.g., "single").
- **support_email** (string) - Support email for the product.
- **support_url** (string) - Support URL for the product.
- **refund_period** (integer) - The refund period in days.
- **status** (string) - The status of the product (e.g., "active").
- **sale_cnt** (integer) - Number of sales for the product.
- **refund_cnt** (integer) - Number of refunds for the product.
- **gross_earnings** (string) - Total gross earnings from the product.
- **product_meta** (object) - Metadata associated with the product.
  - **keywords** (string) - Keywords related to the product.
  - **allow_affiliates** (integer) - Flag indicating if affiliates are allowed (1 for yes, 0 for no).
  - **is_public** (integer) - Flag indicating if the product is public (1 for yes, 0 for no).

### Response Example
```json
{
  "success": 1,
  "object": "product",
  "id": "product_pb9k83",
  "created": "2014-12-01 08:15:00",
  "name": "Product Name",
  "sale_type": "single",
  "support_email": "support@example.com",
  "support_url": "https://example.com/support",
  "refund_period": 30,
  "status": "active",
  "sale_cnt": 12,
  "refund_cnt": 1,
  "gross_earnings": "240.00",
  "product_meta": {
    "keywords": "launch, marketing",
    "allow_affiliates": 1,
    "is_public": 1
  }
}
```
```

--------------------------------

### Get Purchase Details

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves details for a specific purchase transaction.

```APIDOC
## GET /v2/purchases/{id}

### Description
Retrieves details for a specific purchase transaction.

### Method
GET

### Endpoint
/v2/purchases/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the purchase.

### Response
#### Success Response (200)
- **success** (integer) - Indicates if the request was successful (1 for success).
- **object** (string) - Type of the response object ('purchase').
- **id** (string) - The unique identifier of the purchase.
- **access_url** (string) - The URL to access the purchased product.
- **amount** (string) - The purchase amount.
- **created** (string) - The date and time the purchase was created.
- **currency** (string) - The currency of the purchase.
- **refund_date** (string or null) - The date and time of the refund, if applicable.
- **status** (string) - The status of the purchase.
- **product** (object) - Details about the purchased product.
- **recurring** (string or null) - Recurring payment information.
- **payments** (object) - Information about payments for the purchase.

### Response Example
```json
{
  "success": 1,
  "object": "purchase",
  "id": "sale_tk8k4tj3",
  "access_url": "https://warriorplus.com/buy/get/tk8k4tj3",
  "amount": "20.00",
  "created": "2014-12-17 13:05:09",
  "currency": "USD",
  "refund_date": null,
  "status": "Completed",
  "product": {
    "id": "product_pb9k83",
    "name": "Product Name",
    "support_email": "support@example.com",
    "support_url": "https://example.com/support",
    "vendor_name": "Vendor Name",
    "vendor_username": "vendoruser"
  },
  "recurring": null,
  "payments": {
    "object": "list",
    "uri": "/v2/purchases/sale_tk8k4tj3/payments",
    "total_count": 1,
    "has_more": false,
    "data": [
      {
        "object": "payment",
        "id": "pay_pvqkyy6lfpfm9jfk",
        "method": "stripe",
        "txn_id": "ch_15An6k2BmnlhXDCVGKGcfPkh",
        "amount": "20.00",
        "currency": "USD",
        "sale_id": "sale_tk8k4tj3",
        "created": "2014-12-17 13:05:11",
        "status": "COMPLETED"
      }
    ]
  }
}
```
```

--------------------------------

### Get Affiliate Requests for Affiliate

Source: https://warriorplus.com/api/docs

Retrieves affiliate application records associated with a specific affiliate.

```APIDOC
## GET /affiliates/{affiliateId}/affiliate_requests

### Description
Retrieves a list of affiliate application records associated with a specific affiliate.

### Method
GET

### Endpoint
https://warriorplus.com/api/v2/affiliates/{affiliateId}/affiliate_requests

### Parameters
#### Path Parameters
- **affiliateId** (string) - Required - The unique identifier of the affiliate.

### Request Example
```bash
curl -X GET "https://warriorplus.com/api/v2/affiliates/aff_123xyz/affiliate_requests"
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **object** (string) - The type of object returned (e.g., "list").
- **uri** (string) - The URI for the request.
- **has_more** (string) - Indicates if there are more records available ("true" or "false").
- **total_count** (integer) - The total number of records found.
- **data** (array) - An array of affiliate request objects.
```

--------------------------------

### Get Sale Details

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves details for a specific sale transaction.

```APIDOC
## GET /v2/sales/{id}

### Description
Retrieves details for a specific sale transaction.

### Method
GET

### Endpoint
/v2/sales/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the sale.

### Response
#### Success Response (200)
- **success** (integer) - Indicates if the request was successful (1 for success).
- **object** (string) - Type of the response object ('sale').
- **id** (string) - The unique identifier of the sale.
- **created** (string) - The date and time the sale was created.
- **product_id** (string) - The ID of the product sold.
- **amount** (string) - The sale amount.
- **currency** (string) - The currency of the sale.
- **status** (string) - The status of the sale.
- **refund_date** (string or null) - The date and time of the refund, if applicable.
- **receiver_email** (string or null) - The email of the receiver.
- **sid** (string) - The sale ID string.
- **hop_tid** (string or null) - The hop transaction ID.
- **hop_sid** (string or null) - The hop sale ID.
- **meta** (object) - Additional metadata for the sale.
- **customer** (object) - Details of the customer.
- **affiliate** (string or null) - Affiliate information.
- **recurring** (string or null) - Recurring payment information.
- **partners** (object) - Information about partners involved in the sale.
- **payments** (object) - Information about payments for the sale.

### Response Example
```json
{
  "success": 1,
  "object": "sale",
  "id": "sale_tk8k4tj3",
  "created": "2014-12-17 13:05:09",
  "product_id": "product_pb9k83",
  "amount": "20.00",
  "currency": "USD",
  "status": "Completed",
  "refund_date": null,
  "receiver_email": null,
  "sid": "sidstring",
  "hop_tid": "hoptidstring",
  "hop_sid": "hopsidstring",
  "meta": {},
  "customer": {
    "object": "customer",
    "id": "cus_u0f2b6100b56030e",
    "email": "warriorplus@gmail.com",
    "name": "Jane Buyer",
    "country": "US"
  },
  "affiliate": null,
  "recurring": null,
  "partners": {
    "object": "list",
    "uri": "/v2/sales/sale_tk8k4tj3/partners",
    "total_count": 0,
    "has_more": false,
    "data": []
  },
  "payments": {
    "object": "list",
    "uri": "/v2/sales/sale_tk8k4tj3/payments",
    "total_count": 1,
    "has_more": false,
    "data": [
      {
        "object": "payment",
        "id": "pay_pvqkyy6lfpfm9jfk",
        "method": "stripe",
        "txn_id": "ch_15An6k2BmnlhXDCVGKGcfPkh",
        "amount": "20.00",
        "currency": "USD",
        "sale_id": "sale_tk8k4tj3",
        "created": "2014-12-17 13:05:11",
        "status": "COMPLETED"
      }
    ]
  }
}
```
```

--------------------------------

### Get Offer Details

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves detailed information about a specific offer. This includes offer metadata, sales statistics, affiliate program details, and associated pages.

```APIDOC
## GET /api/v2/offers/{id}

### Description
Retrieves details for a specific offer.

### Method
GET

### Endpoint
/api/v2/offers/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the offer.

### Response
#### Success Response (200)
- **success** (integer) - Indicates the success of the operation (1 for success).
- **object** (string) - Type of the object, e.g., "offer".
- **id** (string) - Unique identifier for the offer.
- **created** (string) - Timestamp when the offer was created.
- **name** (string) - Name of the offer.
- **start_date** (string) - The start date of the offer.
- **end_date** (string) - The end date of the offer, if applicable.
- **status** (string) - The status of the offer (e.g., "active").
- **sale_cnt** (integer) - Number of sales for the offer.
- **refund_cnt** (integer) - Number of refunds for the offer.
- **aggregate_sales** (string) - Total aggregate sales for the offer.
- **offer_meta** (object) - Metadata associated with the offer.
  - **allow_affiliates** (integer) - Flag indicating if affiliates are allowed.
  - **allow_public** (integer) - Flag indicating if the offer is public.
  - **is_public** (integer) - Flag indicating if the offer is public.
  - **approval_status** (string) - Approval status of the offer.
- **affiliate_program** (object) - Details about the affiliate program.
  - **allow_affiliates** (integer) - Flag indicating if affiliates are allowed.
  - **detail_url** (string) - URL to view affiliate program details.
  - **signup_url** (string) - URL to sign up for the affiliate program.
- **pages** (object) - Information about pages associated with the offer.
  - **object** (string) - Type of the object, e.g., "list".
  - **uri** (string) - URI to fetch offer pages.
  - **total_count** (integer) - Total number of pages.
  - **has_more** (boolean) - Indicates if there are more pages.
  - **data** (array) - List of page objects.
    - **object** (string) - Type of the object, e.g., "page".
    - **id** (string) - Unique identifier for the page.
    - **name** (string) - Name of the page.
    - **page_url** (string) - The URL of the page.
    - **created** (string) - Timestamp when the page was created.
    - **offer** (string) - The offer ID associated with the page.
    - **products** (object) - Information about products associated with the page.
      - **object** (string) - Type of the object, e.g., "list".
      - **uri** (string) - URI to fetch products for this page.
      - **total_count** (integer) - Total number of products.
      - **has_more** (boolean) - Indicates if there are more products.
      - **data** (array) - List of product objects (details similar to Product object).

### Response Example
```json
{
  "success": 1,
  "object": "offer",
  "id": "offer_jkkla93",
  "created": "2024-01-05 12:00:00",
  "name": "Main Launch Offer",
  "start_date": "2024-02-01 00:00:00",
  "end_date": null,
  "status": "active",
  "sale_cnt": 34,
  "refund_cnt": 2,
  "aggregate_sales": "680.00",
  "offer_meta": {
    "allow_affiliates": 1,
    "allow_public": 1,
    "is_public": 1,
    "approval_status": "auto"
  },
  "affiliate_program": {
    "allow_affiliates": 1,
    "detail_url": "https://warriorplus.com/o2/a/jkkla93/0",
    "signup_url": "https://warriorplus.com/o2/a/jkkla93/0/signup"
  },
  "pages": {
    "object": "list",
    "uri": "/api/v2/offers/offer_jkkla93/pages",
    "total_count": 1,
    "has_more": false,
    "data": [
      {
        "object": "page",
        "id": "page_a81k2j",
        "name": "Front-End Page",
        "page_url": "https://warriorplus.com/o2/a/example/0",
        "created": "2024-01-10 14:30:00",
        "offer": "offer_jkkla93",
        "products": {
          "object": "list",
          "uri": "/api/v2/offers/offer_jkkla93/pages/page_a81k2j/products",
          "total_count": 1,
          "has_more": false,
          "data": [
            {
              "object": "product",
              "id": "product_pb9k83",
              "created": "2014-12-01 08:15:00",
              "name": "Product Name",
              "sale_type": "single",
              "support_email": "support@example.com",
              "support_url": "https://example.com/support",
              "refund_period": 30,
              "status": "active",
              "sale_cnt": 12,
              "refund_cnt": 1,
              "gross_earnings": "240.00",
              "product_meta": {
                "keywords": "launch, marketing",
                "allow_affiliates": 1,
                "is_public": 1
              }
            }
          ]
        }
      }
    ]
  }
}
```
```

--------------------------------

### Get an offer page

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves a single page object for a specified offer page. This endpoint is useful for fetching details of a specific page within an offer.

```APIDOC
## GET /offers/{offerId}/pages/{pageId}

### Description
Returns a single page object for the specified offer page.

### Method
GET

### Endpoint
/offers/{offerId}/pages/{pageId}

### Parameters
#### Path Parameters
- **offerId** (string) - Required - The ID of the offer.
- **pageId** (string) - Required - The ID of the page.

### Responses
#### Success Response (200)
- **Page object** (object) - Schema reference: #/components/schemas/PageResponse

#### Error Responses
- **400** - InvalidRequest
- **401** - Unauthorized
- **402** - NoData
- **429** - TooManyRequests
- **500** - ApiError
```

--------------------------------

### Get Customer

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves the details of a specific customer using their unique customer ID.

```APIDOC
## GET /customers/{customerId}

### Description
Returns a single customer object for the specified customer ID.

### Method
GET

### Endpoint
/customers/{customerId}

### Parameters
#### Path Parameters
- **customerId** (string) - Required - The unique identifier of the customer.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the customer.
- **email** (string) - The email address of the customer.
- **name** (string) - The name of the customer.
- **created_at** (string) - The timestamp when the customer was created.
```

--------------------------------

### Get Affiliate Request by ID

Source: https://warriorplus.com/api/docs

Retrieves a specific affiliate application record by its unique ID.

```APIDOC
## GET /affiliate_requests/{affiliateRequestId}

### Description
Retrieves a specific affiliate application record using its unique identifier.

### Method
GET

### Endpoint
https://warriorplus.com/api/v2/affiliate_requests/{affiliateRequestId}

### Parameters
#### Path Parameters
- **affiliateRequestId** (string) - Required - The unique identifier of the affiliate request.

### Request Example
```bash
curl -X GET "https://warriorplus.com/api/v2/affiliate_requests/affreq_zyx987"
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **object** (string) - The type of object returned (e.g., "affiliate_request").
- **uri** (string) - The URI for the request.
- **data** (object) - The affiliate request object containing detailed information.
```

--------------------------------

### Get Purchases List

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves a list of purchase transactions. Supports pagination and filtering.

```APIDOC
## GET /v2/purchases/

### Description
Retrieves a list of purchase transactions. Supports pagination and filtering.

### Method
GET

### Endpoint
/v2/purchases/

### Query Parameters
- **limit** (integer) - Optional - Number of purchases to return per page.
- **offset** (integer) - Optional - Offset for pagination.

### Response
#### Success Response (200)
- **success** (integer) - Indicates if the request was successful (1 for success).
- **object** (string) - Type of the response object ('list').

### Response Example
```json
{
  "success": 1,
  "object": "list"
}
```
```

--------------------------------

### Get an affiliate

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves a single affiliate object for the specified affiliate ID. This endpoint is useful for fetching detailed information about a specific affiliate.

```APIDOC
## GET /affiliates/{affiliateId}

### Description
Returns a single affiliate object for the specified affiliate ID.

### Method
GET

### Endpoint
/affiliates/{affiliateId}

### Parameters
#### Path Parameters
- **affiliateId** (string) - Required - The ID of the affiliate.

### Responses
#### Success Response (200)
- **Affiliate object** (object) - Schema reference: #/components/schemas/AffiliateResponse

#### Error Responses
- **400** - InvalidRequest
- **401** - Unauthorized
- **402** - NoData
- **429** - TooManyRequests
- **500** - ApiError
```

--------------------------------

### Get Customer Details

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves detailed information about a specific customer, including their contact details, purchase history, and first/last purchase dates.

```APIDOC
## GET /api/v2/customers/{customer_id}

### Description
Retrieves detailed information for a specific customer.

### Method
GET

### Endpoint
/api/v2/customers/{customer_id}

### Parameters
#### Path Parameters
- **customer_id** (string) - Required - The unique identifier of the customer.

### Response
#### Success Response (200)
- **success** (integer) - Indicates the success of the operation (1 for success).
- **object** (string) - The type of object returned ('customer').
- **id** (string) - The unique identifier of the customer.
- **email** (string) - The email address of the customer.
- **firstname** (string) - The first name of the customer.
- **lastname** (string) - The last name of the customer.
- **name** (string) - The full name of the customer.
- **country** (string) - The country of the customer.
- **purchase_cnt** (integer) - The total number of purchases made by the customer.
- **purchase_total** (float) - The total amount spent by the customer.
- **first_purchase_date** (string) - The date of the customer's first purchase.
- **last_purchase_date** (string) - The date of the customer's last purchase.

### Response Example
{
  "success": 1,
  "object": "customer",
  "id": "cus_u0f2b6100b56030e",
  "email": "warriorplus@gmail.com",
  "firstname": "Jane",
  "lastname": "Buyer",
  "name": "Jane Buyer",
  "country": "US",
  "purchase_cnt": 3,
  "purchase_total": 67.5,
  "first_purchase_date": "2023-11-12 09:30:00",
  "last_purchase_date": "2024-01-22 16:45:00"
}
```

--------------------------------

### Get Affiliate Request

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves a specific affiliate request object using its unique ID.

```APIDOC
## GET /affiliate_requests/{affiliateRequestId}

### Description
Returns a single affiliate request object for the specified request ID. You can optionally specify `as=affiliate` to view the request from the affiliate's perspective.

### Method
GET

### Endpoint
/affiliate_requests/{affiliateRequestId}

### Parameters
#### Path Parameters
- **affiliateRequestId** (string) - Required - The unique identifier of the affiliate request.

#### Query Parameters
- **as** (string) - Optional - View from the affiliate's perspective (`affiliate`).

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the affiliate request.
- **offer_id** (string) - The ID of the associated offer.
- **affiliate_id** (string) - The ID of the affiliate.
- **status** (string) - The current status of the request.
- **created_at** (string) - The timestamp when the request was created.
- **updated_at** (string) - The timestamp when the request was last updated.
```

--------------------------------

### List products on an offer page

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves a list of product objects associated with a specific page within an offer. This is useful for displaying products available on a particular offer page.

```APIDOC
## GET /offers/{offerId}/pages/{pageId}/products

### Description
Returns the product objects associated with the specified page inside an offer.

### Method
GET

### Endpoint
/offers/{offerId}/pages/{pageId}/products

### Parameters
#### Path Parameters
- **offerId** (string) - Required - The ID of the offer.
- **pageId** (string) - Required - The ID of the page.

#### Query Parameters
- **limit** (integer) - Optional - The maximum number of items to return.
- **starting_after** (string) - Optional - A cursor for use in pagination, specifying the first item to be returned.
- **ending_before** (string) - Optional - A cursor for use in pagination, specifying the last item to be returned.

### Responses
#### Success Response (200)
- **Product list for the page** (object) - Schema reference: #/components/schemas/ProductListResponse

#### Error Responses
- **400** - InvalidRequest
- **401** - Unauthorized
- **402** - NoData
- **429** - TooManyRequests
- **500** - ApiError
```

--------------------------------

### List Products

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves a paginated list of products associated with the authenticated vendor account.

```APIDOC
## GET /products

### Description
Returns a paginated list of products for the authenticated vendor account.

### Method
GET

### Endpoint
/products

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of items to return.
- **starting_after** (string) - Optional - A cursor for use in pagination. Items will be returned starting after this value.
- **ending_before** (string) - Optional - A cursor for use in pagination. Items will be returned ending before this value.

### Response
#### Success Response (200)
- **data** (array) - A list of product objects.
- **has_more** (boolean) - Indicates if there are more results.
- **object** (string) - The type of object returned, typically "list".

#### Response Example
{
  "data": [
    {
      "id": "prod_123",
      "name": "Example Product",
      "price": 19.99
    }
  ],
  "has_more": true,
  "object": "list"
}
```

--------------------------------

### List Affiliate Requests

Source: https://warriorplus.com/api/docs

Retrieves a list of affiliate application records.

```APIDOC
## GET /affiliate_requests

### Description
Lists affiliate application records, either vendor-side or affiliate-side.

### Method
GET

### Endpoint
https://warriorplus.com/api/v2/affiliate_requests

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The number of records to return per request. Maximum is 100.
- **starting_after** (string) - Optional - Returns records created after this cursor ID.
- **ending_before** (string) - Optional - Returns records created before this cursor ID.

### Request Example
```bash
curl -X GET "https://warriorplus.com/api/v2/affiliate_requests?limit=50"
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **object** (string) - The type of object returned (e.g., "list").
- **uri** (string) - The URI for the request.
- **has_more** (string) - Indicates if there are more records available ("true" or "false").
- **total_count** (integer) - The total number of records found.
- **data** (array) - An array of affiliate request objects.
```

--------------------------------

### List Offers

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves a paginated list of offers for the authenticated vendor account.

```APIDOC
## GET /offers

### Description
Returns a paginated list of offers for the authenticated vendor account.

### Method
GET

### Endpoint
/offers

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of items to return.
- **starting_after** (string) - Optional - A cursor for use in pagination. Items will be returned starting after this value.
- **ending_before** (string) - Optional - A cursor for use in pagination. Items will be returned ending before this value.

### Response
#### Success Response (200)
- **data** (array) - A list of offer objects.
- **has_more** (boolean) - Indicates if there are more results.
- **object** (string) - The type of object returned, typically "list".

#### Response Example
{
  "data": [
    {
      "id": "offer_abc",
      "name": "Example Offer"
    }
  ],
  "has_more": true,
  "object": "list"
}
```

--------------------------------

### Get Customer by ID

Source: https://warriorplus.com/api/docs

Retrieves a specific customer record by its unique ID.

```APIDOC
## GET /customers/{customerId}

### Description
Retrieves a specific customer record using its unique identifier.

### Method
GET

### Endpoint
https://warriorplus.com/api/v2/customers/{customerId}

### Parameters
#### Path Parameters
- **customerId** (string) - Required - The unique identifier of the customer.

### Request Example
```bash
curl -X GET "https://warriorplus.com/api/v2/customers/cus_789ghi"
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **object** (string) - The type of object returned (e.g., "customer").
- **uri** (string) - The URI for the request.
- **data** (object) - The customer object containing detailed information.
```

--------------------------------

### Get a Sale

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves a single sale object using its unique ID.

```APIDOC
## GET /sales/{saleId}

### Description
Returns a single sale object for the specified sale ID.

### Method
GET

### Endpoint
/sales/{saleId}

### Parameters
#### Path Parameters
- **saleId** (string) - Required - The ID of the sale to retrieve.
```

--------------------------------

### Get a Purchase

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves a single purchase object using its unique ID.

```APIDOC
## GET /purchases/{saleId}

### Description
Returns a single purchase object for the specified purchase ID.

### Method
GET

### Endpoint
/purchases/{saleId}

### Parameters
#### Path Parameters
- **saleId** (string) - Required - The ID of the purchase to retrieve.
```

--------------------------------

### Get Payments for Sale

Source: https://warriorplus.com/api/docs

Retrieves payment records associated with a specific sale.

```APIDOC
## GET /sales/{saleId}/payments

### Description
Retrieves a list of payment records associated with a specific sale.

### Method
GET

### Endpoint
https://warriorplus.com/api/v2/sales/{saleId}/payments

### Parameters
#### Path Parameters
- **saleId** (string) - Required - The unique identifier of the sale.

### Request Example
```bash
curl -X GET "https://warriorplus.com/api/v2/sales/sale_123abc/payments"
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **object** (string) - The type of object returned (e.g., "list").
- **uri** (string) - The URI for the request.
- **has_more** (string) - Indicates if there are more records available ("true" or "false").
- **total_count** (integer) - The total number of records found.
- **data** (array) - An array of payment objects.
```

--------------------------------

### List Affiliate Requests

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves a paginated list of affiliate requests. Supports filtering by offer, affiliate, or status, and provides an affiliate-side view when `as=affiliate` is used.

```APIDOC
## GET /affiliate_requests

### Description
Returns a paginated list of affiliate requests. You can optionally filter by offer, affiliate, or request status. Use `as=affiliate` only when you want the affiliate-side request view.

### Method
GET

### Endpoint
/affiliate_requests

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of results to return.
- **starting_after** (string) - Optional - A cursor for use in pagination. Returns results after this value.
- **ending_before** (string) - Optional - A cursor for use in pagination. Returns results before this value.
- **offer** (string) - Optional - Filter by offer ID.
- **affiliate** (string) - Optional - Filter by affiliate ID.
- **status** (string) - Optional - Filter by request status (e.g., PENDING, APPROVED, DECLINED).
- **as** (string) - Optional - View from the affiliate's perspective (`affiliate`).

### Response
#### Success Response (200)
- **data** (array) - A list of affiliate request objects.
- **has_more** (boolean) - Indicates if there are more results available.
- **next_cursor** (string) - The cursor for the next page of results.
```

--------------------------------

### Get Payment by ID

Source: https://warriorplus.com/api/docs

Retrieves a specific payment record by its unique ID.

```APIDOC
## GET /payments/{paymentId}

### Description
Retrieves a specific payment record using its unique identifier.

### Method
GET

### Endpoint
https://warriorplus.com/api/v2/payments/{paymentId}

### Parameters
#### Path Parameters
- **paymentId** (string) - Required - The unique identifier of the payment.

### Request Example
```bash
curl -X GET "https://warriorplus.com/api/v2/payments/pay_jkl567"
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **object** (string) - The type of object returned (e.g., "payment").
- **uri** (string) - The URI for the request.
- **data** (object) - The payment object containing detailed information.
```

--------------------------------

### List Affiliates

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves a list of affiliates.

```APIDOC
## GET /api/v2/affiliates/

### Description
Retrieves a list of affiliates.

### Method
GET

### Endpoint
/api/v2/affiliates/

### Response
#### Success Response (200)
- **success** (integer) - Indicates the success of the operation (1 for success).
- **object** (string) - Type of the returned object, typically 'list'.
- **uri** (string) - The URI for the affiliate list.
- **has_more** (string) - Indicates if there are more results available ('true' or 'false').
- **total_count** (integer) - The total number of affiliates.
- **data** (array) - An array of Affiliate objects.
```

--------------------------------

### Get Partner by ID

Source: https://warriorplus.com/api/docs

Retrieves a specific partner record by its unique ID.

```APIDOC
## GET /partners/{partnerId}

### Description
Retrieves a specific partner record using its unique identifier.

### Method
GET

### Endpoint
https://warriorplus.com/api/v2/partners/{partnerId}

### Parameters
#### Path Parameters
- **partnerId** (string) - Required - The unique identifier of the partner.

### Request Example
```bash
curl -X GET "https://warriorplus.com/api/v2/partners/partner_456def"
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **object** (string) - The type of object returned (e.g., "partner").
- **uri** (string) - The URI for the request.
- **data** (object) - The partner object containing detailed information.
```

--------------------------------

### Get Sale by ID

Source: https://warriorplus.com/api/docs

Retrieves a specific sale record by its unique ID.

```APIDOC
## GET /sales/{saleId}

### Description
Retrieves a specific sale record using its unique identifier.

### Method
GET

### Endpoint
https://warriorplus.com/api/v2/sales/{saleId}

### Parameters
#### Path Parameters
- **saleId** (string) - Required - The unique identifier of the sale.

### Request Example
```bash
curl -X GET "https://warriorplus.com/api/v2/sales/sale_123abc"
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **object** (string) - The type of object returned (e.g., "sale").
- **uri** (string) - The URI for the request.
- **data** (object) - The sale object containing detailed information.
```

--------------------------------

### Get Partners for Sale

Source: https://warriorplus.com/api/docs

Retrieves partner records associated with a specific sale.

```APIDOC
## GET /sales/{saleId}/partners

### Description
Retrieves a list of partner records associated with a specific sale.

### Method
GET

### Endpoint
https://warriorplus.com/api/v2/sales/{saleId}/partners

### Parameters
#### Path Parameters
- **saleId** (string) - Required - The unique identifier of the sale.

### Request Example
```bash
curl -X GET "https://warriorplus.com/api/v2/sales/sale_123abc/partners"
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **object** (string) - The type of object returned (e.g., "list").
- **uri** (string) - The URI for the request.
- **has_more** (string) - Indicates if there are more records available ("true" or "false").
- **total_count** (integer) - The total number of records found.
- **data** (array) - An array of partner objects.
```

--------------------------------

### Get Partner

Source: https://warriorplus.com/api/docs/openapi.yaml

Retrieves a single partner object using its unique ID.

```APIDOC
## GET /partners/{partnerId}

### Description
Returns a single partner object for the specified partner ID.

### Method
GET

### Endpoint
/partners/{partnerId}

### Parameters
#### Path Parameters
- **partnerId** (string) - Required - The unique identifier of the partner.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the partner.
- **name** (string) - The name of the partner.
- **email** (string) - The email address of the partner.
- **created_at** (string) - The timestamp when the partner was created.
```

--------------------------------

### List Affiliates

Source: https://warriorplus.com/api/docs

Retrieves a list of approved and pending affiliates for the authenticated vendor account.

```APIDOC
## GET /affiliates

### Description
Lists approved and pending affiliates for the authenticated vendor account.

### Method
GET

### Endpoint
https://warriorplus.com/api/v2/affiliates

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The number of records to return per request. Maximum is 100.
- **starting_after** (string) - Optional - Returns records created after this cursor ID.
- **ending_before** (string) - Optional - Returns records created before this cursor ID.

### Request Example
```bash
curl -X GET "https://warriorplus.com/api/v2/affiliates?limit=20"
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **object** (string) - The type of object returned (e.g., "list").
- **uri** (string) - The URI for the request.
- **has_more** (string) - Indicates if there are more records available ("true" or "false").
- **total_count** (integer) - The total number of records found.
- **data** (array) - An array of affiliate objects.
```
Tokens:
Raw