Dynamic Content and Data Feeds
Dynamic Content and Data Feeds — 34 operations (GET /v1/apps/{appId}/data-feeds, POST /v1/apps/{appId}/data-feeds, GET /v1/apps/{appId}/data-feeds/{feedId}, …). Generated from the OpenAPI 3.1.0 contract.
Data Feeds (external JSON/CSV sources) and Content Tables: definition, testing and row management; used inside Liquid.
Base URL: https://api.pushizo.com · Tag: dynamic-content · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/data-feeds | List data feeds |
POST | /v1/apps/{appId}/data-feeds | Create a data feed |
GET | /v1/apps/{appId}/data-feeds/{feedId} | Data feed details |
PATCH | /v1/apps/{appId}/data-feeds/{feedId} | Update a data feed |
DELETE | /v1/apps/{appId}/data-feeds/{feedId} | Delete a data feed |
POST | /v1/apps/{appId}/data-feeds/{feedId}/test | Test the data feed with a sample user |
GET | /v1/apps/{appId}/content-tables | Content tables |
POST | /v1/apps/{appId}/content-tables | Create a content table from CSV |
GET | /v1/apps/{appId}/content-tables/{tableId} | Content table details |
PATCH | /v1/apps/{appId}/content-tables/{tableId} | Update the content table description |
DELETE | /v1/apps/{appId}/content-tables/{tableId} | Delete a content table |
GET | /v1/apps/{appId}/content-tables/{tableId}/rows | Content table rows |
PUT | /v1/apps/{appId}/content-tables/{tableId}/rows | Reload the content table (the version is incremented) |
GET | /v1/apps/{appId}/promo-code-lists | Promo code lists |
POST | /v1/apps/{appId}/promo-code-lists | Create a promo code list |
GET | /v1/apps/{appId}/promo-code-lists/{listId} | Promo code list details |
PATCH | /v1/apps/{appId}/promo-code-lists/{listId} | Update a promo code list (description, expiry) |
DELETE | /v1/apps/{appId}/promo-code-lists/{listId} | Delete a promo code list |
GET | /v1/apps/{appId}/promo-code-lists/{listId}/codes | Codes in the list and their assignments |
POST | /v1/apps/{appId}/promo-code-lists/{listId}/codes | Add codes from CSV (existing ones are skipped) |
GET | /v1/apps/{appId}/catalogs | Product catalogs |
POST | /v1/apps/{appId}/catalogs | Create a catalog |
GET | /v1/apps/{appId}/catalogs/{catalogId} | Catalog details |
PATCH | /v1/apps/{appId}/catalogs/{catalogId} | Update a catalog |
DELETE | /v1/apps/{appId}/catalogs/{catalogId} | Delete a catalog |
GET | /v1/apps/{appId}/catalogs/{catalogId}/items | Products |
PUT | /v1/apps/{appId}/catalogs/{catalogId}/items | Add or update products (up to 1000) |
POST | /v1/apps/{appId}/catalogs/{catalogId}/items/upload | Add or update products from CSV |
GET | /v1/apps/{appId}/catalogs/{catalogId}/items/{itemId} | Product details |
DELETE | /v1/apps/{appId}/catalogs/{catalogId}/items/{itemId} | Delete a product |
GET | /v1/apps/{appId}/catalogs/{catalogId}/recommendations | Product recommendations |
GET | /v1/apps/{appId}/catalogs/{catalogId}/recommendations/config | Recommendation model |
PUT | /v1/apps/{appId}/catalogs/{catalogId}/recommendations/config | Configure the recommendation model |
POST | /v1/apps/{appId}/catalogs/{catalogId}/recommendations/compute | Recompute recommendations |
Details
List data feeds
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: DataFeedList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].url_template | string | Yes | |
data[].method | enum | Yes | Values: "GET", "POST" |
data[].body_template | string | null | Yes | |
data[].headers | map<string, string> | Yes | |
data[].secret_header_names | array<string> | Yes | |
data[].cache_ttl_seconds | integer | Yes | |
data[].timeout_ms | integer | Yes | |
data[].enabled | boolean | Yes | |
data[].liquid | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"enabled": true,
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"url_template": "örnek",
"method": "GET",
"body_template": "örnek",
"headers": {
"key": "user_42"
},
"secret_header_names": [
"örnek"
],
"cache_ttl_seconds": 1,
"timeout_ms": 1,
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/data-feeds" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a data feed
The URL template is personalized with Liquid (e.g. https://api.ornek.com/u/{{ user.external_id }}); in templates use {{ feed.<ad>.alan }}.
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateDataFeedDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–64 |
description | string | null | No | |
url_template | string | Yes | Length: 1–2048 |
method | enum | No | Values: "GET", "POST" |
body_template | string | null | No | |
headers | map<string, string> | No | |
secret_headers | map<string, string> | No | |
cache_ttl_seconds | integer | No | Range: 0–86400 |
timeout_ms | integer | No | Range: 100–2000 |
enabled | boolean | No |
Example:
{
"name": "Sipariş bildirimleri",
"url_template": "örnek",
"enabled": true,
"description": "Sipariş durumu güncellemeleri",
"method": "GET",
"body_template": "örnek",
"headers": {
"key": "user_42"
}
}Responses
201 — Success.
Schema: DataFeed
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
url_template | string | Yes | |
method | enum | Yes | Values: "GET", "POST" |
body_template | string | null | Yes | |
headers | map<string, string> | Yes | |
secret_header_names | array<string> | Yes | |
cache_ttl_seconds | integer | Yes | |
timeout_ms | integer | Yes | |
enabled | boolean | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"url_template": "örnek",
"method": "GET",
"body_template": "örnek",
"headers": {
"key": "user_42"
},
"secret_header_names": [
"örnek"
],
"cache_ttl_seconds": 1,
"timeout_ms": 1,
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/data-feeds" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"url_template": "örnek",
"enabled": true,
"description": "Sipariş durumu güncellemeleri",
"method": "GET",
"body_template": "örnek",
"headers": {
"key": "user_42"
}
}'Data feed details
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
feedId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: DataFeed
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
url_template | string | Yes | |
method | enum | Yes | Values: "GET", "POST" |
body_template | string | null | Yes | |
headers | map<string, string> | Yes | |
secret_header_names | array<string> | Yes | |
cache_ttl_seconds | integer | Yes | |
timeout_ms | integer | Yes | |
enabled | boolean | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"url_template": "örnek",
"method": "GET",
"body_template": "örnek",
"headers": {
"key": "user_42"
},
"secret_header_names": [
"örnek"
],
"cache_ttl_seconds": 1,
"timeout_ms": 1,
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/data-feeds/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a data feed
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
feedId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateDataFeedDto
| Field | Type | Required | Description |
|---|---|---|---|
description | string | null | No | |
url_template | string | No | Length: 1–2048 |
method | enum | No | Values: "GET", "POST" |
body_template | string | null | No | |
headers | map<string, string> | No | |
secret_headers | map<string, string> | null | No | |
cache_ttl_seconds | integer | No | Range: 0–86400 |
timeout_ms | integer | No | Range: 100–2000 |
enabled | boolean | No |
Example:
{
"enabled": true,
"description": "Sipariş durumu güncellemeleri",
"url_template": "örnek",
"method": "GET",
"body_template": "örnek"
}Responses
200 — Success.
Schema: DataFeed
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
url_template | string | Yes | |
method | enum | Yes | Values: "GET", "POST" |
body_template | string | null | Yes | |
headers | map<string, string> | Yes | |
secret_header_names | array<string> | Yes | |
cache_ttl_seconds | integer | Yes | |
timeout_ms | integer | Yes | |
enabled | boolean | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"url_template": "örnek",
"method": "GET",
"body_template": "örnek",
"headers": {
"key": "user_42"
},
"secret_header_names": [
"örnek"
],
"cache_ttl_seconds": 1,
"timeout_ms": 1,
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/data-feeds/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"enabled": true,
"description": "Sipariş durumu güncellemeleri",
"url_template": "örnek",
"method": "GET",
"body_template": "örnek"
}'Delete a data feed
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
feedId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Example response:
{
"ok": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/data-feeds/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Test the data feed with a sample user
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
feedId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: TestDataFeedDto
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string | No | Length: 1–256 |
user_id | string | No | Length: 1–64 |
Example:
{
"external_id": "user_42",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}Responses
200 — Success.
Schema: DataFeedTestResult
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | Yes | Values: "ok", "cached", "timeout", "error", "circuit_open", "blocked", "invalid_json", "too_large", "http_error" |
http_status | integer | null | Yes | |
duration_ms | integer | Yes | |
error | string | null | Yes | |
url | string | null | Yes | |
preview | any | Yes | |
truncated | boolean | Yes | |
user | object | null | Yes |
Example response:
{
"url": "https://pushizo.com/orders/1001",
"status": "ok",
"http_status": 1,
"duration_ms": 1,
"error": "örnek",
"preview": "örnek",
"truncated": true,
"user": {
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/data-feeds/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W/test" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"external_id": "user_42",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'Content tables
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ContentTableList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].key_column | string | Yes | |
data[].columns | array<string> | Yes | |
data[].row_count | integer | Yes | |
data[].version | integer | Yes | |
data[].source_file_name | string | null | Yes | |
data[].liquid | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"key_column": "örnek",
"columns": [
"örnek"
],
"row_count": 1,
"version": 1,
"source_file_name": "örnek",
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/content-tables" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a content table from CSV
In templates: {% lookup '<ad>' key: user.tags.<etiket> as satir %}{{ satir.<sütun> }}.
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Content type: multipart/form-data.
| Field | Type | Required | Description |
|---|---|---|---|
file | string (binary) | Yes | UTF-8 CSV; the first row is the header. Up to 100,000 rows, 20 MB. |
name | string | Yes | Liquid table name (lowercase letters, digits, underscores). |
key_column | string | Yes | Key column used to select rows (values must be unique). |
description | string | No |
Example:
{
"name": "Sipariş bildirimleri",
"file": "örnek",
"key_column": "örnek",
"description": "Sipariş durumu güncellemeleri"
}Responses
201 — Success.
Schema: ContentTable
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
key_column | string | Yes | |
columns | array<string> | Yes | |
row_count | integer | Yes | |
version | integer | Yes | |
source_file_name | string | null | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"key_column": "örnek",
"columns": [
"örnek"
],
"row_count": 1,
"version": 1,
"source_file_name": "örnek",
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/content-tables" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-F "name=Sipariş bildirimleri" \
-F "file=@users.csv" \
-F "key_column=örnek" \
-F "description=Sipariş durumu güncellemeleri"Content table details
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
tableId | path | string | Yes | "tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ContentTable
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
key_column | string | Yes | |
columns | array<string> | Yes | |
row_count | integer | Yes | |
version | integer | Yes | |
source_file_name | string | null | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"key_column": "örnek",
"columns": [
"örnek"
],
"row_count": 1,
"version": 1,
"source_file_name": "örnek",
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/content-tables/tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update the content table description
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
tableId | path | string | Yes | "tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateContentTableDto
| Field | Type | Required | Description |
|---|---|---|---|
description | string | null | No |
Example:
{
"description": "Sipariş durumu güncellemeleri"
}Responses
200 — Success.
Schema: ContentTable
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
key_column | string | Yes | |
columns | array<string> | Yes | |
row_count | integer | Yes | |
version | integer | Yes | |
source_file_name | string | null | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"key_column": "örnek",
"columns": [
"örnek"
],
"row_count": 1,
"version": 1,
"source_file_name": "örnek",
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/content-tables/tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"description": "Sipariş durumu güncellemeleri"
}'Delete a content table
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
tableId | path | string | Yes | "tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Example response:
{
"ok": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/content-tables/tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Content table rows
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
tableId | path | string | Yes | "tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
limit | query | integer | No | Range: 1–200 | 50 |
offset | query | integer | No | Range: 0–100000 | 1 |
q | query | string | No | Length: 0–200 | "ayse" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ContentTableRows
| Field | Type | Required | Description |
|---|---|---|---|
columns | array<string> | Yes | |
key_column | string | Yes | |
total | integer | Yes | |
data | array<map<string, string>> | Yes |
Example response:
{
"data": [
{
"order_id": "1001"
}
],
"columns": [
"örnek"
],
"key_column": "örnek",
"total": 1
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/content-tables/tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W/rows?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Reload the content table (the version is incremented)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
tableId | path | string | Yes | "tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Content type: multipart/form-data.
| Field | Type | Required | Description |
|---|---|---|---|
file | string (binary) | Yes | New CSV (all rows of the table are replaced, the version is incremented). |
key_column | string | No | Optional new key column. |
Example:
{
"file": "örnek",
"key_column": "örnek"
}Responses
200 — Success.
Schema: ContentTable
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
key_column | string | Yes | |
columns | array<string> | Yes | |
row_count | integer | Yes | |
version | integer | Yes | |
source_file_name | string | null | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"key_column": "örnek",
"columns": [
"örnek"
],
"row_count": 1,
"version": 1,
"source_file_name": "örnek",
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/content-tables/tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W/rows" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-F "file=@users.csv" \
-F "key_column=örnek"Promo code lists
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: PromoCodeListList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].expires_at | string | null | Yes | |
data[].total_count | integer | Yes | |
data[].assigned_count | integer | Yes | |
data[].available_count | integer | Yes | |
data[].liquid | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"expires_at": "örnek",
"total_count": 1,
"assigned_count": 1,
"available_count": 1,
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/promo-code-lists" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a promo code list
In templates, {% promo_code '<ad>' %} issues a single-use code per delivery. If no codes remain, the delivery fails with the PromoCodeUnavailable error.
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreatePromoCodeListDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–64 |
description | string | No | Length: 0–500 |
expires_at | string (date-time) | null | No |
Example:
{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri",
"expires_at": "2026-10-17T09:00:00Z"
}Responses
201 — Success.
Schema: PromoCodeList
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
expires_at | string | null | Yes | |
total_count | integer | Yes | |
assigned_count | integer | Yes | |
available_count | integer | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"expires_at": "örnek",
"total_count": 1,
"assigned_count": 1,
"available_count": 1,
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/promo-code-lists" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri",
"expires_at": "2026-10-17T09:00:00Z"
}'Promo code list details
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
listId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: PromoCodeList
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
expires_at | string | null | Yes | |
total_count | integer | Yes | |
assigned_count | integer | Yes | |
available_count | integer | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"expires_at": "örnek",
"total_count": 1,
"assigned_count": 1,
"available_count": 1,
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/promo-code-lists/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a promo code list (description, expiry)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
listId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdatePromoCodeListDto
| Field | Type | Required | Description |
|---|---|---|---|
description | string | null | No | |
expires_at | string (date-time) | null | No |
Example:
{
"description": "Sipariş durumu güncellemeleri",
"expires_at": "2026-10-17T09:00:00Z"
}Responses
200 — Success.
Schema: PromoCodeList
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
expires_at | string | null | Yes | |
total_count | integer | Yes | |
assigned_count | integer | Yes | |
available_count | integer | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"expires_at": "örnek",
"total_count": 1,
"assigned_count": 1,
"available_count": 1,
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/promo-code-lists/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"description": "Sipariş durumu güncellemeleri",
"expires_at": "2026-10-17T09:00:00Z"
}'Delete a promo code list
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
listId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Example response:
{
"ok": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/promo-code-lists/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Codes in the list and their assignments
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
listId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
limit | query | integer | No | Range: 1–200 | 50 |
offset | query | integer | No | Range: 0–1000000 | 1 |
q | query | string | No | Length: 0–128 | "ayse" |
status | query | enum | No | Values: "available", "assigned" | "available" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: PromoCodesPage
| Field | Type | Required | Description |
|---|---|---|---|
total | integer | Yes | |
data | array<object> | Yes | |
data[].code | string | Yes | |
data[].delivery_id | string | null | Yes | |
data[].message_id | string | null | Yes | |
data[].assigned_at | string | null | Yes |
Example response:
{
"data": [
{
"code": "örnek",
"delivery_id": "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"assigned_at": "örnek"
}
],
"total": 1
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/promo-code-lists/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W/codes?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Add codes from CSV (existing ones are skipped)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
listId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Content type: multipart/form-data.
| Field | Type | Required | Description |
|---|---|---|---|
file | string (binary) | Yes | UTF-8 CSV; codes in the first column, header optional. Up to 1,000,000 codes, 20 MB. |
Example:
{
"file": "örnek"
}Responses
201 — Success.
Schema: PromoCodeUploadResult
| Field | Type | Required | Description |
|---|---|---|---|
list | object | Yes | |
list.id | string | Yes | |
list.app_id | string | Yes | |
list.name | string | Yes | |
list.description | string | null | Yes | |
list.expires_at | string | null | Yes | |
list.total_count | integer | Yes | |
list.assigned_count | integer | Yes | |
list.available_count | integer | Yes | |
list.liquid | string | Yes | |
list.created_at | string | Yes | |
list.updated_at | string | Yes | |
added | integer | Yes | |
skipped | integer | Yes |
Example response:
{
"list": {
"name": "Sipariş bildirimleri",
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"expires_at": "örnek",
"total_count": 1,
"assigned_count": 1,
"available_count": 1,
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
},
"added": 1,
"skipped": 1
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/promo-code-lists/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W/codes" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-F "file=@users.csv"Product catalogs
Authentication: API key — scope admin or analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CatalogList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].currency | string | Yes | |
data[].item_count | integer | Yes | |
data[].liquid | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"currency": "TRY",
"item_count": 1,
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/catalogs" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a catalog
In templates: {% catalog_item '<ad>' id: custom_data.product_id as urun %}{{ urun.title }}.
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateCatalogDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–64 |
description | string | No | Length: 0–500 |
currency | string | No |
Example:
{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri",
"currency": "TRY"
}Responses
201 — Success.
Schema: Catalog
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
currency | string | Yes | |
item_count | integer | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"currency": "TRY",
"item_count": 1,
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/catalogs" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri",
"currency": "TRY"
}'Catalog details
Authentication: API key — scope admin or analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
catalogId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Catalog
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
currency | string | Yes | |
item_count | integer | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"currency": "TRY",
"item_count": 1,
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/catalogs/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a catalog
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
catalogId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateCatalogDto
| Field | Type | Required | Description |
|---|---|---|---|
description | string | null | No | |
currency | string | No |
Example:
{
"description": "Sipariş durumu güncellemeleri",
"currency": "TRY"
}Responses
200 — Success.
Schema: Catalog
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
currency | string | Yes | |
item_count | integer | Yes | |
liquid | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"currency": "TRY",
"item_count": 1,
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/catalogs/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"description": "Sipariş durumu güncellemeleri",
"currency": "TRY"
}'Delete a catalog
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
catalogId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Example response:
{
"ok": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/catalogs/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Products
Authentication: API key — scope admin or analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
catalogId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
limit | query | integer | No | Range: 1–200 | 50 |
offset | query | integer | No | Range: 0–1000000 | 1 |
q | query | string | No | Length: 0–200 | "ayse" |
category | query | string | No | Length: 0–200 | "örnek" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CatalogItemsPage
| Field | Type | Required | Description |
|---|---|---|---|
total | integer | Yes | |
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].title | string | Yes | |
data[].description | string | null | Yes | |
data[].image_url | string | null | Yes | |
data[].url | string | null | Yes | |
data[].price | number | null | Yes | |
data[].sale_price | number | null | Yes | |
data[].currency | string | Yes | |
data[].category | string | null | Yes | |
data[].brand | string | null | Yes | |
data[].in_stock | boolean | Yes | |
data[].attributes | map<string, string> | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"url": "https://pushizo.com/orders/1001",
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"image_url": "https://pushizo.com/orders/1001",
"price": 149.9,
"sale_price": 149.9,
"currency": "TRY",
"category": "örnek",
"brand": "örnek",
"in_stock": true,
"attributes": {
"key": "user_42"
},
"updated_at": "örnek"
}
],
"total": 1
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/catalogs/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W/items?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Add or update products (up to 1000)
Products not in the list are left untouched. Fields omitted for a listed product are cleared.
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
catalogId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpsertCatalogItemsDto
| Field | Type | Required | Description |
|---|---|---|---|
items | array<object> | Yes | Items: 1–1000 |
items[].id | string | Yes | Length: 1–128 |
items[].title | string | Yes | Length: 1–300 |
items[].description | string | null | No | |
items[].image_url | string (url) | null | No | |
items[].url | string (url) | null | No | |
items[].price | number | null | No | |
items[].sale_price | number | null | No | |
items[].currency | string | No | |
items[].category | string | null | No | |
items[].brand | string | null | No | |
items[].in_stock | boolean | No | |
items[].attributes | map<string, string> | No |
Example:
{
"items": [
{
"id": "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"title": "Siparişiniz yola çıktı",
"url": "https://pushizo.com/orders/1001",
"description": "Sipariş durumu güncellemeleri",
"image_url": "https://pushizo.com/orders/1001"
}
]
}Responses
200 — Success.
Schema: CatalogUpsertResult
| Field | Type | Required | Description |
|---|---|---|---|
catalog | object | Yes | |
catalog.id | string | Yes | |
catalog.app_id | string | Yes | |
catalog.name | string | Yes | |
catalog.description | string | null | Yes | |
catalog.currency | string | Yes | |
catalog.item_count | integer | Yes | |
catalog.liquid | string | Yes | |
catalog.created_at | string | Yes | |
catalog.updated_at | string | Yes | |
upserted | integer | Yes |
Example response:
{
"catalog": {
"name": "Sipariş bildirimleri",
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"currency": "TRY",
"item_count": 1,
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
},
"upserted": 1
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/catalogs/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W/items" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"items": [
{
"id": "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"title": "Siparişiniz yola çıktı",
"url": "https://pushizo.com/orders/1001",
"description": "Sipariş durumu güncellemeleri",
"image_url": "https://pushizo.com/orders/1001"
}
]
}'Add or update products from CSV
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
catalogId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Content type: multipart/form-data.
| Field | Type | Required | Description |
|---|---|---|---|
file | string (binary) | Yes | UTF-8 CSV. Required columns: id, title. Known: description, image_url, url, price, sale_price, currency, category, brand, in_stock. Other columns become attributes. Up to 100,000 rows, 20 MB. |
Example:
{
"file": "örnek"
}Responses
200 — Success.
Schema: CatalogUpsertResult
| Field | Type | Required | Description |
|---|---|---|---|
catalog | object | Yes | |
catalog.id | string | Yes | |
catalog.app_id | string | Yes | |
catalog.name | string | Yes | |
catalog.description | string | null | Yes | |
catalog.currency | string | Yes | |
catalog.item_count | integer | Yes | |
catalog.liquid | string | Yes | |
catalog.created_at | string | Yes | |
catalog.updated_at | string | Yes | |
upserted | integer | Yes |
Example response:
{
"catalog": {
"name": "Sipariş bildirimleri",
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"currency": "TRY",
"item_count": 1,
"liquid": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
},
"upserted": 1
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/catalogs/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W/items/upload" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-F "file=@users.csv"Product details
Authentication: API key — scope admin or analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
catalogId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
itemId | path | string | Yes | "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CatalogItem
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
title | string | Yes | |
description | string | null | Yes | |
image_url | string | null | Yes | |
url | string | null | Yes | |
price | number | null | Yes | |
sale_price | number | null | Yes | |
currency | string | Yes | |
category | string | null | Yes | |
brand | string | null | Yes | |
in_stock | boolean | Yes | |
attributes | map<string, string> | Yes | |
updated_at | string | Yes |
Example response:
{
"url": "https://pushizo.com/orders/1001",
"id": "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"image_url": "https://pushizo.com/orders/1001",
"price": 149.9,
"sale_price": 149.9,
"currency": "TRY",
"category": "örnek",
"brand": "örnek",
"in_stock": true,
"attributes": {
"key": "user_42"
},
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/catalogs/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W/items/inb_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Delete a product
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
catalogId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
itemId | path | string | Yes | "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Example response:
{
"ok": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/catalogs/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W/items/inb_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Product recommendations
Out-of-stock products and products the user has purchased are excluded. If there are not enough results, they are filled from the fallback source.
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
catalogId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
strategy | query | enum | Yes | Values: "personalized", "popular", "trending", "similar", "category", "recently_viewed", "new_arrivals" | "personalized" |
limit | query | integer | No | Range: 1–20 | 50 |
user_id | query | string | No | Length: 0–64 | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
external_id | query | string | No | Length: 0–255 | "user_42" |
item_id | query | string | No | Length: 0–128 | "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
category | query | string | No | Length: 0–200 | "örnek" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Recommendations
| Field | Type | Required | Description |
|---|---|---|---|
strategy | enum | Yes | Values: "personalized", "popular", "trending", "similar", "category", "recently_viewed", "new_arrivals" |
source | enum | null | Yes | |
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].title | string | Yes | |
data[].description | string | null | Yes | |
data[].image_url | string | null | Yes | |
data[].url | string | null | Yes | |
data[].price | number | null | Yes | |
data[].sale_price | number | null | Yes | |
data[].currency | string | Yes | |
data[].category | string | null | Yes | |
data[].brand | string | null | Yes | |
data[].in_stock | boolean | Yes | |
data[].attributes | map<string, string> | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"url": "https://pushizo.com/orders/1001",
"id": "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"image_url": "https://pushizo.com/orders/1001",
"price": 149.9,
"sale_price": 149.9,
"currency": "TRY",
"category": "örnek",
"brand": "örnek",
"in_stock": true,
"attributes": {
"key": "user_42"
},
"updated_at": "örnek"
}
],
"strategy": "personalized",
"source": "personalized"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/catalogs/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W/recommendations?strategy=personalized&limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Recommendation model
/v1/apps/{appId}/catalogs/{catalogId}/recommendations/configTry it (interactive API docs, new tab)Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
catalogId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: RecommendationConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
view_events | array<string> | Yes | |
purchase_events | array<string> | Yes | |
item_property | string | Yes | |
window_days | integer | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_items | integer | Yes | |
scored_users | integer | Yes |
Example response:
{
"enabled": true,
"status": "idle",
"configured": true,
"view_events": [
"örnek"
],
"purchase_events": [
"örnek"
],
"item_property": "örnek",
"window_days": 1,
"last_error": "örnek",
"last_computed_at": "örnek",
"scored_items": 1,
"scored_users": 1
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/catalogs/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W/recommendations/config" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Configure the recommendation model
/v1/apps/{appId}/catalogs/{catalogId}/recommendations/configTry it (interactive API docs, new tab)If the model is enabled, recommendations are recomputed after saving.
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
catalogId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateRecommendationConfigDto
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
view_events | array<string> | No | Items: 0–10 |
purchase_events | array<string> | No | Items: 0–10 |
item_property | string | No | |
window_days | integer | No | Range: 7–365 |
Example:
{
"enabled": true,
"view_events": [
"değer"
],
"purchase_events": [
"değer"
],
"item_property": "değer",
"window_days": 7
}Responses
200 — Success.
Schema: RecommendationConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
view_events | array<string> | Yes | |
purchase_events | array<string> | Yes | |
item_property | string | Yes | |
window_days | integer | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_items | integer | Yes | |
scored_users | integer | Yes |
Example response:
{
"enabled": true,
"status": "idle",
"configured": true,
"view_events": [
"örnek"
],
"purchase_events": [
"örnek"
],
"item_property": "örnek",
"window_days": 1,
"last_error": "örnek",
"last_computed_at": "örnek",
"scored_items": 1,
"scored_users": 1
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/catalogs/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W/recommendations/config" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"enabled": true,
"view_events": [
"değer"
],
"purchase_events": [
"değer"
],
"item_property": "değer",
"window_days": 7
}'Recompute recommendations
/v1/apps/{appId}/catalogs/{catalogId}/recommendations/computeTry it (interactive API docs, new tab)The job is queued; track progress via the status field.
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
catalogId | path | string | Yes | "feed_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
202 — Success.
Schema: RecommendationConfig
| Field | Type | Required | Description |
|---|---|---|---|
configured | boolean | Yes | |
enabled | boolean | Yes | |
view_events | array<string> | Yes | |
purchase_events | array<string> | Yes | |
item_property | string | Yes | |
window_days | integer | Yes | |
status | enum | Yes | Values: "idle", "queued", "running", "failed" |
last_error | string | null | Yes | |
last_computed_at | string | null | Yes | |
scored_items | integer | Yes | |
scored_users | integer | Yes |
Example response:
{
"enabled": true,
"status": "idle",
"configured": true,
"view_events": [
"örnek"
],
"purchase_events": [
"örnek"
],
"item_property": "örnek",
"window_days": 1,
"last_error": "örnek",
"last_computed_at": "örnek",
"scored_items": 1,
"scored_users": 1
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/catalogs/feed_01JD3W5Q7X9K2M4N6P8R0T1V3W/recommendations/compute" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Email deliverability
Email deliverability — 17 operations (GET /v1/apps/{appId}/email-deliverability, PUT /v1/apps/{appId}/email-deliverability, POST /v1/apps/{appId}/email-deliverability/verify-address, …). Generated from the OpenAPI 3.1.0 contract.
Webhooks
Webhooks — 13 operations (GET /v1/apps/{appId}/webhooks/event-types, GET /v1/apps/{appId}/webhooks, POST /v1/apps/{appId}/webhooks, …). Generated from the OpenAPI 3.1.0 contract.