To access the API, use the API token from your profile (Profile → General profile settings → Generate API token).
The API helps you:
- optimize your work with Catuik;
- get up-to-date information about commissions, products, deals, and sources;
- manage product promotion efficiently and increase your earnings.
How the API works
You send an HTTP GET request from your server to our API to retrieve the required information from your account. We receive and process the request, then send a JSON response back to your server. For authentication, the request must include the unique token from your profile.
Request Methods
For "Get products list with links", "Get promotions list", and "Get promotion products requests", you must specify your source ID. You can get the source ID using the Get source list API request.
Get commissions list
Returns information about commissions.
Request URL—https://api.catuik.com/v2/publisher/commission/
Request Parameters
| Name | Allowed value |
|---|---|
| id | Commission ID |
| subid | Any identifier you can use for additional traffic categorization and tracking |
| status |
Commission status: pending approved declined |
| payment_type |
Pricing model: cpa—pay per order cpc—pay per click with sales adjustment (Sales-adjusted CPC) cpmc—pay per click from a storefront to a product (Storefront CPC); hcpa—pay for sales plus a flat bonus after reaching the click threshold (Hybrid CPA) |
| created_at_from | Commission creation date: period start |
| created_at_to | Commission creation date: period end |
| updated_at_from | Commission status update date: period start |
| updated_at_to | Commission status update date: period end |
| page | Page number |
| limit | Number of records per page (default: 50; allowed range: 1–1,000) |
Example request using curl -H "Host: api.catuik.com" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.catuik.com/v2/publisher/commission/?... \ --compressed
Example API server response in JSON format
{
"total_count": 1000,
"page": 1,
"limit": 50,
"items": [
{
"id": "string",
"payment_type": "cpa",
"status": "pending",
"commission_date": "2021-01-01",
"source": {
"id": 0,
"title": "string",
"status": "verification",
"source_type": {
"id": 0,
"type": "social_network",
"title": "string",
"slug": "string"
},
"source_url": "string",
"created_at": "2019-08-24T14:15:22Z"
},
"order_product": {
"id": 0,
"title": "string",
"sku": "string"
},
"click_product": {
"id": 0,
"title": "string",
"sku": "string"
},
"subid": "string",
"marketplace": "AliExpress",
"commission_amount": 0.1,
"cart_amount": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
API response fields for Get commissions list
| Field | Description |
|---|---|
| id | Unique commission identifier |
| payment_type | Commission pricing model |
| status | Current commission status |
| commission_date | Commission registration date |
| source | Source |
| order_product | Information about the ordered product, if any |
| click_product | Product that was clicked and led to the order |
| subid | Additional identifier for tracking the traffic source, if you specified it when generating the link |
| marketplace | Marketplace name |
| commission_amount | Commission amount |
| cart_amount | Order amount |
| created_at | Order date and time |
| updated_at | Date and time of the latest order status update |
Get products list with links
Returns information about products with affiliate links.
Request URL—https://api.catuik.com/v2/publisher/product/
Request parameters
| Name | Allowed value |
|---|---|
| source_id | Source ID (you can get your source ID using the Get source list API request) |
| subid | Any identifier you can use for additional traffic categorization and tracking. |
| marketplace | Marketplace name: “AliExpress” |
| category_id | Numeric product category ID (to match a numeric code to a product category name, use the Get product categories list request) |
| favorite | Favorites (you can add a product to Favorites or remove it only in your account) |
| payment_type |
Pricing model: cpa—pay per order cpc—pay per click with sales adjustment (Sales-adjusted CPC) cpmc—pay per click from a storefront to a product (Storefront CPC); hcpa—pay for sales plus a flat bonus after reaching the click threshold (Hybrid CPA) |
| page | Page number |
| limit | Number of records per page (default: 50; allowed range: 1–1,000) |
Example request using curl -H "Host: api.catuik.com" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.catuik.com/v2/publisher/product/?sou... \ --compressed
Example API server response in JSON format
{
"total_count": 1000,
"page": 1,
"limit": 50,
"items": [
{
"id": "string",
"product_id": 0,
"title": "string",
"image_url": "string",
"price": 0.1,
"commission": 0.1,
"product_category": "string",
"marketplace_title": "string",
"store_title": "string",
"external_link": "string",
"favorite": true,
"payment_type": "cpa",
"tracking_link": "string",
"legal_text": "string"
}
]
}
API response fields for Get products list with links
| Field | Description |
|---|---|
| id | Unique product identifier |
| product_id | Unique product identifier on the marketplace |
| product_sku | Unique product identifier—SKU (manufacturer's item number) |
| title | Product name |
| image_url | Image link |
| price | Product price |
| commission | Promotion commission |
| product_category | Product category (to match category names to their numeric codes, use the Get product categories list request) |
| marketplace_title | Marketplace name |
| store_title | Store name |
| external_link | Direct link to the product on the marketplace |
| favorite | Favorites |
| payment_type | Pricing model |
| tracking_link | Affiliate link to the product |
Get product categories list
Returns information about product categories available for promotion.
Request URL—https://catuik.com/v2/publisher/product-category/
Product categories are represented by numbers or names. Get product categories list lets you match a numeric category code to its name.
Request parameters
| Name | Allowed value |
|---|---|
| product-category | Product category |
Example request using curl -H "Host: api.catuik.com" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.catuik.com/v2/publisher/product-cate... \ --compressed
Example API server response in JSON format
{
"items": [
{
"id": 0,
"title": "string"
}
]
}
API Response fields for Get product categories list
| Field | Description |
|---|---|
| id | Unique category identifier |
| title | Product category name |
Get promotions list
Returns information about active deals and promo codes.
Request URL—https://api.catuik.com/v2/publisher/promotion/
Request parameters
| Name | Allowed value |
|---|---|
| source_id | Source ID (you can get your source ID using the Get source list API request) |
| promotion_id | Deal/promo code ID |
| marketplace | Marketplace name: “AliExpress” |
| promotion_type |
Deal/promo code type: global_sale—global marketplace deals and sales sale—seller deals coupon—seller promo codes |
| favorite | Favorites (you can add a product to Favorites or remove it only in your account) |
| page | Page number |
| limit | Number of records per page (default: 50; allowed range: 1–1,000) |
Example request using curl -H "Host: api.catuik.com" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.catuik.com/v2/publisher/promotion/?s... \ --compressed
Example API server response in JSON format
{
"total_count": 1000,
"page": 1,
"limit": 50,
"items": [
{
"id": 0,
"title": "string",
"promotion_type": "global_sale",
"marketplace_title": "string",
"store_title": "string",
"discount_type": "fixed",
"discount_value": 0,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z",
"coupon": "string",
"landing_link": "string",
"legal_text": "string"
}
]
}
Get promotion products
Returns information about products participating in deals.
Request URL—https://api.catuik.com/v2/publisher/promotion/product/
Request parameters
| Name | Allowed value |
|---|---|
| source_id | Source ID (you can get your source ID using the Get source list API request) |
| subid | Any identifier you can use for additional traffic categorization and tracking. |
| marketplace | Marketplace name: “AliExpress” |
| category_id | Product category ID (to match a numeric code to a product category name, use the Get product categories list request) |
| favorite | Favorites (you can add a product to Favorites or remove it only in your account) |
| promotion_id | Deal/promo code ID (you can get it using the Get promotion list request) |
| page | Page number |
| limit | Number of records per page (default: 50; allowed range: 1–1,000) |
Example request using curl -H "Host: api.catuik.com" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.catuik.com/v2/publisher/promotion/pr... \ --compressed
Example API server response in JSON format
{
"total_count": 1000,
"page": 1,
"limit": 50,
"items": [
{
"id": "string",
"product_id": 0,
"title": "string",
"image_url": "string",
"price": 0.1,
"price_discount": 0.1,
"discount_percent": 0.1,
"commission": 0.1,
"product_category": "string",
"marketplace_title": "string",
"store_title": "string",
"promotion_id": 0,
"favorite": true,
"tracking_link": "string",
"legal_text": "string"
}
]
}
Get source list
Returns information about source statuses.
Request URL—https://api.catuik.com/v2/publisher/source/
The source ID returned in the response is used in the following API requests: Get products list with links, Get promotions list, and Get promotion products.
Request parameters
| Name | Allowed value |
|---|---|
| status | Source status: verification—under review; approved—verified; declined—rejected |
Example request using curl -H "Host: api.catuik.com" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.catuik.com/v2/publisher/source/?stat... \ --compressed
Example API server response in JSON format
{
"items": [
{
"id": 0,
"title": "string",
"status": "verification",
"source_type": {
"id": 0,
"type": "social_network",
"title": "string",
"slug": "string"
},
"source_url": "string",
"created_at": "2019-08-24T14:15:22Z"
}
]
}
API response fields for Get source list
| Field | Description |
|---|---|
| id | Unique source identifier |
| title | Source name |
| status | Source status |
| source_type | Source type |
| source_url | Source URL |
| created_at | Source creation date |