Skip to content

Get Affiliate Campaign Creator Product Sample Status

GET
/affiliate_partner/202508/campaigns/{campaign_id}/products/{product_id}/creator/{creator_temp_id}/content/statistics/sample/status

Retrieves delivery and tracking details for a creator’s product sample in an affiliate campaign. The creator must have applied for a sample of the specified product before calling this API.

campaign_id
required
string

The campaign identifier.

product_id
required
string

The product identifier.

creator_temp_id
required
string

Creator Open ID. More details

category_asset_cipher
required
string

The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API.

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
sample_status

The creator’s sample status

object
shipping_provider_name

The name of the shipping provider

string
delivery_option

The delivery option:

  • ECONOMY_SHIPPING
  • PREMIUM_SHIPPING
string
estimated_earliest_delivery_date

The earliest estimated delivery date in Unix epoch format.

string
estimated_latest_delivery_date

The latest estimated delivery date in Unix epoch format.

string
quantity

The quantity of products delivered.

integer format: int64
tracking_results

A list of objects representing tracking events.

Array<object>
object
tracking_event_update_date

The date at which the tracking event was last updated, in Unix epoch format.

string
tracking_event_description

The title of the tracking event.

  • THE_PACKAGE_HAS_BEEN_DELIVERED
  • OUT_FOR_DELIVERY
  • ORDER_PACKED_AND_READY_FOR_DROP_OFF_AT_CARRIERS_FACILITY
  • ORDER_PLACED
string
tracking_event_description_extended

More information about the tracking event

string
Example
{
"code": 0,
"data": {
"sample_status": {
"shipping_provider_name": "USPS",
"delivery_option": "PREMIUM_SHIPPING",
"estimated_earliest_delivery_date": "1712941200",
"estimated_latest_delivery_date": "1712941200",
"quantity": 1,
"tracking_results": [
{
"tracking_event_update_date": "1712941200",
"tracking_event_description": "THE_PACKAGE_HAS_BEEN_DELIVERED",
"tracking_event_description_extended": "delivering"
}
]
}
},
"message": "Success",
"request_id": "202203070749000101890810281E8C70B7"
}