Skip to main content
POST
/
v3
/
products
/
{product_id}
/
partners
Add a product partner
curl --request POST \
  --url https://api.myscalev.com/v3/products/{product_id}/partners \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partner_unique_id": "<string>"
}
'
{
  "affiliate_pro_domains": [
    {
      "business_id": 123,
      "full_url": "<string>",
      "id": 123
    }
  ],
  "affiliate_pro_links": [
    {
      "checkout_url": "<string>",
      "domain": "<string>",
      "product_url": "<string>"
    }
  ],
  "affiliate_status": "<string>",
  "approved_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "custom_domains": [
    {
      "business_id": 123,
      "full_url": "<string>",
      "id": 123
    }
  ],
  "id": 123,
  "message_to_product_owner": "<string>",
  "partner": {
    "account_holder": "<string>",
    "email": "jsmith@example.com",
    "id": 123,
    "is_banned": true,
    "logo": "<string>",
    "unique_id": "<string>",
    "username": "<string>"
  },
  "partnership_type": "<string>",
  "rejected_at": "2023-11-07T05:31:56Z",
  "requested_at": "2023-11-07T05:31:56Z",
  "store_id": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

product_id
string
required

Body

application/json

Partner data

partner_unique_id
string
required

Partner Unique ID

Response

Product partner created successfully

A partner associated with a product

affiliate_pro_domains
object[]

Approved affiliate_pro custom domains for this partnership

Affiliate Pro links for partners (product + checkout, includes ap=<store_short_unique_id>)

affiliate_status
string

Status of the partnership (pending, approved, rejected, banned)

approved_at
string<date-time> | null

Timestamp when partnership was approved

created_at
string<date-time>

Timestamp when the product partner was created

custom_domains
object[]

List of custom domains where the product page can be viewed

id
integer

Unique identifier of the product partner

message_to_product_owner
string | null

Message from partner when requesting partnership

partner
BusinessSimple · object
partnership_type
string

Type of partnership (affiliate, affiliate_pro, or reseller)

rejected_at
string<date-time> | null

Timestamp when partnership was rejected

requested_at
string<date-time> | null

Timestamp when partnership was requested

store_id
integer | null

Store ID assigned for affiliate_pro routing