Edit Open Collaboration Settings

POST

/affiliate_seller/202405/open_collaboration_settings

This API is used to edit a Seller’s open collaboration settings. It allows you to enroll your existing product catalog and all future products into an open collaboration plan. It also allows you to turn this setting off at any point. By default, this option is turned off for all Sellers.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Request Body

Media typeapplication/json

object

auto_add_product

An object with properties to automatically add products to affiliate open collaboration plans.

object

enable

required

Set to true if products are automatically added to affiliate open collaboration plans. The seller can add existing non-affiliate products to open collaboration at one time, and future products are added automatically. Set to false if otherwise.

boolean

commission_rate

required

The commission rate in hundredths of a percent. For example, 3587 is a commission rate of 35.87%. This value must a minimum of 100 and a maximum of 8000. Not that setting the enable property to false overrides this property.

integer format: int64

Example

{
  "auto_add_product": {
    "enable": true,
    "commission_rate": 1000
  }
}

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

Example

{
  "code": 0,
  "data": {},
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}