Post Shoppable Photos

POST

/affiliate_creator/202610/photos

Use this API to post the shoppable photos with uris and metadata.

Authorizations

• accessToken

Request Body^required

Media typeapplication/json

object

photos_info

required

Photo Info Metadata

Array<object>

object

photo_file_uris

required

Photo file uris, not a file upload. Use [Upload Shoppable Photo File] to upload the image and obtain the photo_file_uri, then pass that URI in this field

string

music_id

Music ID

string

title

Post title:The maximum length is 5000 in UTF-16 runes. If not specified, the ticket post will not have any captions. - You can add relevant hashtags to increase discoverability. The format is simply # followed by the topic name. Multiple hashtags are supported,e.g.,#humor#BFCM

string

link_info

Photo anchor and linking metadata

object

post_type

required

1-LINK_TO_PRODUCT, 2-LINK_TO_SHOP, 3-LINK_TO_ONE_PIC_ONE_PRODUCT

string

shop_info

Shop Info

object

shop_id

Shop ID

string

group_type

1 for shop_home_page, 2 for category, 3 for collection

string

group_id

Category ID/Collection ID. Use [Get Shop Category And Collection] to retrieve a valid category_id or collection_id, then set it in this field

string

links

Photo Anchor List

Array<object>

object

product_id

Product ID

string

link_title

Photo Anchor Title:The title to be shown on the product anchor. Anchor title should be shorter than 30 characters

string

<= 29 characters

is_ai_generated

Field to indicate whether the content was AI generated. Marking this field as true will display a tag indicating this post as an AI generated post.

boolean

Example

{
  "photos_info": [
    {
      "photo_file_uris": "tos-useast5-i-photomode-tx/owBwaPnAIiaYg4Ck6aNcAmLkBA14n8QQQGEgi"
    }
  ],
  "music_id": "7577090708998212365",
  "title": "Post title",
  "link_info": {
    "post_type": "1",
    "shop_info": {
      "shop_id": "7494831143334152261",
      "group_type": "1",
      "group_id": "6"
    },
    "links": [
      {
        "product_id": "74998589993939330",
        "link_title": "product A"
      }
    ]
  },
  "is_ai_generated": false
}

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

photo

Post shoppable photos response

object

photo_post_id

Photo post ID

string

quota

Content posting quota for the creator. Returned on successful publish; included in the error message on failure; omitted if no quota restriction applies.

string

Example

{
  "code": 0,
  "data": {
    "photo": {
      "photo_post_id": "34234234234324342"
    },
    "quota": "3/day"
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}