Add Showcase Products

POST

/affiliate_creator/202405/showcases/products/add

This API adds products to the authenticated creator’s showcase. Global Shop users must have at least one selected region before calling this API. A successful API response can still contain errors for products that were not added; when there are no product-level addition errors, errors is omitted.

Authorizations

• accessToken

Request Body^required

Media typeapplication/json

object

add_type

required

Specifies how products are added to the showcase. This an enumerated type with values:

• PRODUCT_ID
• PRODUCT_LINK

string

product_ids

A list of product identifiers included if add_type is set to PRODUCT_ID. The products associated with the identifiers are added to the showcase. Maximum length of the list is 20 product identifiers.

Array<string>

product_link

A product URL to use when add_type is set to PRODUCT_LINK. The product associated with the URL is added to the showcase.

string

Example

{
  "add_type": "PRODUCT_ID",
  "product_ids": [
    "12390753231",
    "7102893481290"
  ],
  "product_link": "https://www.example.com/api/v1/share/AImHx6DlXqP1"
}

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

errors

A list of product showcase addition errors.

Array<object>

object

code

The error code.

integer format: int64

message

A human-readable error message.

string

detail

Additional detail about the product showcase addition error.

object

product_id

The product identifier.

string

Example

{
  "code": 0,
  "data": {
    "errors": [
      {
        "code": 16001001,
        "message": "Encounter network error, please try again.",
        "detail": {
          "product_id": "12390753231"
        }
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}