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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The campaign identifier.
The product identifier.
Creator Open ID. More details
Query Parameters
Section titled “Query Parameters”The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API.
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
The creator’s sample status
object
The name of the shipping provider
The delivery option:
- ECONOMY_SHIPPING
- PREMIUM_SHIPPING
The earliest estimated delivery date in Unix epoch format.
The latest estimated delivery date in Unix epoch format.
The quantity of products delivered.
A list of objects representing tracking events.
object
The date at which the tracking event was last updated, in Unix epoch format.
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
More information about the tracking event
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"}