PushizoDocs
API reference

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

MethodPathOperation
GET/v1/apps/{appId}/data-feedsList data feeds
POST/v1/apps/{appId}/data-feedsCreate 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}/testTest the data feed with a sample user
GET/v1/apps/{appId}/content-tablesContent tables
POST/v1/apps/{appId}/content-tablesCreate 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}/rowsContent table rows
PUT/v1/apps/{appId}/content-tables/{tableId}/rowsReload the content table (the version is incremented)
GET/v1/apps/{appId}/promo-code-listsPromo code lists
POST/v1/apps/{appId}/promo-code-listsCreate 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}/codesCodes in the list and their assignments
POST/v1/apps/{appId}/promo-code-lists/{listId}/codesAdd codes from CSV (existing ones are skipped)
GET/v1/apps/{appId}/catalogsProduct catalogs
POST/v1/apps/{appId}/catalogsCreate 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}/itemsProducts
PUT/v1/apps/{appId}/catalogs/{catalogId}/itemsAdd or update products (up to 1000)
POST/v1/apps/{appId}/catalogs/{catalogId}/items/uploadAdd 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}/recommendationsProduct recommendations
GET/v1/apps/{appId}/catalogs/{catalogId}/recommendations/configRecommendation model
PUT/v1/apps/{appId}/catalogs/{catalogId}/recommendations/configConfigure the recommendation model
POST/v1/apps/{appId}/catalogs/{catalogId}/recommendations/computeRecompute recommendations

Details

List data feeds

GET/v1/apps/{appId}/data-feedsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: DataFeedList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].url_templatestringYes
data[].methodenumYesValues: "GET", "POST"
data[].body_templatestring | nullYes
data[].headersmap<string, string>Yes
data[].secret_header_namesarray<string>Yes
data[].cache_ttl_secondsintegerYes
data[].timeout_msintegerYes
data[].enabledbooleanYes
data[].liquidstringYes
data[].created_atstringYes
data[].updated_atstringYes

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

POST/v1/apps/{appId}/data-feedsTry it (interactive API docs, new tab)

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

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateDataFeedDto

FieldTypeRequiredDescription
namestringYesLength: 1–64
descriptionstring | nullNo
url_templatestringYesLength: 1–2048
methodenumNoValues: "GET", "POST"
body_templatestring | nullNo
headersmap<string, string>No
secret_headersmap<string, string>No
cache_ttl_secondsintegerNoRange: 0–86400
timeout_msintegerNoRange: 100–2000
enabledbooleanNo

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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
url_templatestringYes
methodenumYesValues: "GET", "POST"
body_templatestring | nullYes
headersmap<string, string>Yes
secret_header_namesarray<string>Yes
cache_ttl_secondsintegerYes
timeout_msintegerYes
enabledbooleanYes
liquidstringYes
created_atstringYes
updated_atstringYes

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

GET/v1/apps/{appId}/data-feeds/{feedId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
feedIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: DataFeed

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
url_templatestringYes
methodenumYesValues: "GET", "POST"
body_templatestring | nullYes
headersmap<string, string>Yes
secret_header_namesarray<string>Yes
cache_ttl_secondsintegerYes
timeout_msintegerYes
enabledbooleanYes
liquidstringYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/data-feeds/{feedId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
feedIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateDataFeedDto

FieldTypeRequiredDescription
descriptionstring | nullNo
url_templatestringNoLength: 1–2048
methodenumNoValues: "GET", "POST"
body_templatestring | nullNo
headersmap<string, string>No
secret_headersmap<string, string> | nullNo
cache_ttl_secondsintegerNoRange: 0–86400
timeout_msintegerNoRange: 100–2000
enabledbooleanNo

Example:

{
  "enabled": true,
  "description": "Sipariş durumu güncellemeleri",
  "url_template": "örnek",
  "method": "GET",
  "body_template": "örnek"
}

Responses

200 — Success.

Schema: DataFeed

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
url_templatestringYes
methodenumYesValues: "GET", "POST"
body_templatestring | nullYes
headersmap<string, string>Yes
secret_header_namesarray<string>Yes
cache_ttl_secondsintegerYes
timeout_msintegerYes
enabledbooleanYes
liquidstringYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/data-feeds/{feedId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
feedIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

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

POST/v1/apps/{appId}/data-feeds/{feedId}/testTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
feedIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: TestDataFeedDto

FieldTypeRequiredDescription
external_idstringNoLength: 1–256
user_idstringNoLength: 1–64

Example:

{
  "external_id": "user_42",
  "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}

Responses

200 — Success.

Schema: DataFeedTestResult

FieldTypeRequiredDescription
statusenumYesValues: "ok", "cached", "timeout", "error", "circuit_open", "blocked", "invalid_json", "too_large", "http_error"
http_statusinteger | nullYes
duration_msintegerYes
errorstring | nullYes
urlstring | nullYes
previewanyYes
truncatedbooleanYes
userobject | nullYes

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

GET/v1/apps/{appId}/content-tablesTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ContentTableList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].key_columnstringYes
data[].columnsarray<string>Yes
data[].row_countintegerYes
data[].versionintegerYes
data[].source_file_namestring | nullYes
data[].liquidstringYes
data[].created_atstringYes
data[].updated_atstringYes

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

POST/v1/apps/{appId}/content-tablesTry it (interactive API docs, new tab)

In templates: {% lookup '<ad>' key: user.tags.<etiket> as satir %}{{ satir.<sütun> }}.

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Content type: multipart/form-data.

FieldTypeRequiredDescription
filestring (binary)YesUTF-8 CSV; the first row is the header. Up to 100,000 rows, 20 MB.
namestringYesLiquid table name (lowercase letters, digits, underscores).
key_columnstringYesKey column used to select rows (values must be unique).
descriptionstringNo

Example:

{
  "name": "Sipariş bildirimleri",
  "file": "örnek",
  "key_column": "örnek",
  "description": "Sipariş durumu güncellemeleri"
}

Responses

201 — Success.

Schema: ContentTable

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
key_columnstringYes
columnsarray<string>Yes
row_countintegerYes
versionintegerYes
source_file_namestring | nullYes
liquidstringYes
created_atstringYes
updated_atstringYes

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

GET/v1/apps/{appId}/content-tables/{tableId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
tableIdpathstringYes"tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ContentTable

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
key_columnstringYes
columnsarray<string>Yes
row_countintegerYes
versionintegerYes
source_file_namestring | nullYes
liquidstringYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/content-tables/{tableId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
tableIdpathstringYes"tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateContentTableDto

FieldTypeRequiredDescription
descriptionstring | nullNo

Example:

{
  "description": "Sipariş durumu güncellemeleri"
}

Responses

200 — Success.

Schema: ContentTable

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
key_columnstringYes
columnsarray<string>Yes
row_countintegerYes
versionintegerYes
source_file_namestring | nullYes
liquidstringYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/content-tables/{tableId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
tableIdpathstringYes"tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

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

GET/v1/apps/{appId}/content-tables/{tableId}/rowsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
tableIdpathstringYes"tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoRange: 1–20050
offsetqueryintegerNoRange: 0–1000001
qquerystringNoLength: 0–200"ayse"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ContentTableRows

FieldTypeRequiredDescription
columnsarray<string>Yes
key_columnstringYes
totalintegerYes
dataarray<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)

PUT/v1/apps/{appId}/content-tables/{tableId}/rowsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
tableIdpathstringYes"tbl_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Content type: multipart/form-data.

FieldTypeRequiredDescription
filestring (binary)YesNew CSV (all rows of the table are replaced, the version is incremented).
key_columnstringNoOptional new key column.

Example:

{
  "file": "örnek",
  "key_column": "örnek"
}

Responses

200 — Success.

Schema: ContentTable

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
key_columnstringYes
columnsarray<string>Yes
row_countintegerYes
versionintegerYes
source_file_namestring | nullYes
liquidstringYes
created_atstringYes
updated_atstringYes

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

GET/v1/apps/{appId}/promo-code-listsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: PromoCodeListList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].expires_atstring | nullYes
data[].total_countintegerYes
data[].assigned_countintegerYes
data[].available_countintegerYes
data[].liquidstringYes
data[].created_atstringYes
data[].updated_atstringYes

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

POST/v1/apps/{appId}/promo-code-listsTry it (interactive API docs, new tab)

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

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreatePromoCodeListDto

FieldTypeRequiredDescription
namestringYesLength: 1–64
descriptionstringNoLength: 0–500
expires_atstring (date-time) | nullNo

Example:

{
  "name": "Sipariş bildirimleri",
  "description": "Sipariş durumu güncellemeleri",
  "expires_at": "2026-10-17T09:00:00Z"
}

Responses

201 — Success.

Schema: PromoCodeList

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
expires_atstring | nullYes
total_countintegerYes
assigned_countintegerYes
available_countintegerYes
liquidstringYes
created_atstringYes
updated_atstringYes

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

GET/v1/apps/{appId}/promo-code-lists/{listId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
listIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: PromoCodeList

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
expires_atstring | nullYes
total_countintegerYes
assigned_countintegerYes
available_countintegerYes
liquidstringYes
created_atstringYes
updated_atstringYes

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)

PATCH/v1/apps/{appId}/promo-code-lists/{listId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
listIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdatePromoCodeListDto

FieldTypeRequiredDescription
descriptionstring | nullNo
expires_atstring (date-time) | nullNo

Example:

{
  "description": "Sipariş durumu güncellemeleri",
  "expires_at": "2026-10-17T09:00:00Z"
}

Responses

200 — Success.

Schema: PromoCodeList

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
expires_atstring | nullYes
total_countintegerYes
assigned_countintegerYes
available_countintegerYes
liquidstringYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/promo-code-lists/{listId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
listIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

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

GET/v1/apps/{appId}/promo-code-lists/{listId}/codesTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
listIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoRange: 1–20050
offsetqueryintegerNoRange: 0–10000001
qquerystringNoLength: 0–128"ayse"
statusqueryenumNoValues: "available", "assigned""available"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: PromoCodesPage

FieldTypeRequiredDescription
totalintegerYes
dataarray<object>Yes
data[].codestringYes
data[].delivery_idstring | nullYes
data[].message_idstring | nullYes
data[].assigned_atstring | nullYes

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)

POST/v1/apps/{appId}/promo-code-lists/{listId}/codesTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
listIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Content type: multipart/form-data.

FieldTypeRequiredDescription
filestring (binary)YesUTF-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

FieldTypeRequiredDescription
listobjectYes
list.idstringYes
list.app_idstringYes
list.namestringYes
list.descriptionstring | nullYes
list.expires_atstring | nullYes
list.total_countintegerYes
list.assigned_countintegerYes
list.available_countintegerYes
list.liquidstringYes
list.created_atstringYes
list.updated_atstringYes
addedintegerYes
skippedintegerYes

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

GET/v1/apps/{appId}/catalogsTry it (interactive API docs, new tab)

Authentication: API key — scope admin or analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CatalogList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].currencystringYes
data[].item_countintegerYes
data[].liquidstringYes
data[].created_atstringYes
data[].updated_atstringYes

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

POST/v1/apps/{appId}/catalogsTry it (interactive API docs, new tab)

In templates: {% catalog_item '<ad>' id: custom_data.product_id as urun %}{{ urun.title }}.

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateCatalogDto

FieldTypeRequiredDescription
namestringYesLength: 1–64
descriptionstringNoLength: 0–500
currencystringNo

Example:

{
  "name": "Sipariş bildirimleri",
  "description": "Sipariş durumu güncellemeleri",
  "currency": "TRY"
}

Responses

201 — Success.

Schema: Catalog

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
currencystringYes
item_countintegerYes
liquidstringYes
created_atstringYes
updated_atstringYes

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

GET/v1/apps/{appId}/catalogs/{catalogId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin or analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
catalogIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Catalog

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
currencystringYes
item_countintegerYes
liquidstringYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/catalogs/{catalogId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
catalogIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateCatalogDto

FieldTypeRequiredDescription
descriptionstring | nullNo
currencystringNo

Example:

{
  "description": "Sipariş durumu güncellemeleri",
  "currency": "TRY"
}

Responses

200 — Success.

Schema: Catalog

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
currencystringYes
item_countintegerYes
liquidstringYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/catalogs/{catalogId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
catalogIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

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

GET/v1/apps/{appId}/catalogs/{catalogId}/itemsTry it (interactive API docs, new tab)

Authentication: API key — scope admin or analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
catalogIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoRange: 1–20050
offsetqueryintegerNoRange: 0–10000001
qquerystringNoLength: 0–200"ayse"
categoryquerystringNoLength: 0–200"örnek"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CatalogItemsPage

FieldTypeRequiredDescription
totalintegerYes
dataarray<object>Yes
data[].idstringYes
data[].titlestringYes
data[].descriptionstring | nullYes
data[].image_urlstring | nullYes
data[].urlstring | nullYes
data[].pricenumber | nullYes
data[].sale_pricenumber | nullYes
data[].currencystringYes
data[].categorystring | nullYes
data[].brandstring | nullYes
data[].in_stockbooleanYes
data[].attributesmap<string, string>Yes
data[].updated_atstringYes

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)

PUT/v1/apps/{appId}/catalogs/{catalogId}/itemsTry it (interactive API docs, new tab)

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

NameInTypeRequiredDescriptionExample
catalogIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpsertCatalogItemsDto

FieldTypeRequiredDescription
itemsarray<object>YesItems: 1–1000
items[].idstringYesLength: 1–128
items[].titlestringYesLength: 1–300
items[].descriptionstring | nullNo
items[].image_urlstring (url) | nullNo
items[].urlstring (url) | nullNo
items[].pricenumber | nullNo
items[].sale_pricenumber | nullNo
items[].currencystringNo
items[].categorystring | nullNo
items[].brandstring | nullNo
items[].in_stockbooleanNo
items[].attributesmap<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

FieldTypeRequiredDescription
catalogobjectYes
catalog.idstringYes
catalog.app_idstringYes
catalog.namestringYes
catalog.descriptionstring | nullYes
catalog.currencystringYes
catalog.item_countintegerYes
catalog.liquidstringYes
catalog.created_atstringYes
catalog.updated_atstringYes
upsertedintegerYes

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

POST/v1/apps/{appId}/catalogs/{catalogId}/items/uploadTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
catalogIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Content type: multipart/form-data.

FieldTypeRequiredDescription
filestring (binary)YesUTF-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

FieldTypeRequiredDescription
catalogobjectYes
catalog.idstringYes
catalog.app_idstringYes
catalog.namestringYes
catalog.descriptionstring | nullYes
catalog.currencystringYes
catalog.item_countintegerYes
catalog.liquidstringYes
catalog.created_atstringYes
catalog.updated_atstringYes
upsertedintegerYes

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

GET/v1/apps/{appId}/catalogs/{catalogId}/items/{itemId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin or analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
catalogIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
itemIdpathstringYes"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CatalogItem

FieldTypeRequiredDescription
idstringYes
titlestringYes
descriptionstring | nullYes
image_urlstring | nullYes
urlstring | nullYes
pricenumber | nullYes
sale_pricenumber | nullYes
currencystringYes
categorystring | nullYes
brandstring | nullYes
in_stockbooleanYes
attributesmap<string, string>Yes
updated_atstringYes

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

DELETE/v1/apps/{appId}/catalogs/{catalogId}/items/{itemId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
catalogIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
itemIdpathstringYes"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

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

GET/v1/apps/{appId}/catalogs/{catalogId}/recommendationsTry it (interactive API docs, new tab)

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

NameInTypeRequiredDescriptionExample
catalogIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
strategyqueryenumYesValues: "personalized", "popular", "trending", "similar", "category", "recently_viewed", "new_arrivals""personalized"
limitqueryintegerNoRange: 1–2050
user_idquerystringNoLength: 0–64"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
external_idquerystringNoLength: 0–255"user_42"
item_idquerystringNoLength: 0–128"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
categoryquerystringNoLength: 0–200"örnek"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Recommendations

FieldTypeRequiredDescription
strategyenumYesValues: "personalized", "popular", "trending", "similar", "category", "recently_viewed", "new_arrivals"
sourceenum | nullYes
dataarray<object>Yes
data[].idstringYes
data[].titlestringYes
data[].descriptionstring | nullYes
data[].image_urlstring | nullYes
data[].urlstring | nullYes
data[].pricenumber | nullYes
data[].sale_pricenumber | nullYes
data[].currencystringYes
data[].categorystring | nullYes
data[].brandstring | nullYes
data[].in_stockbooleanYes
data[].attributesmap<string, string>Yes
data[].updated_atstringYes

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

GET/v1/apps/{appId}/catalogs/{catalogId}/recommendations/configTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
catalogIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: RecommendationConfig

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
view_eventsarray<string>Yes
purchase_eventsarray<string>Yes
item_propertystringYes
window_daysintegerYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
last_computed_atstring | nullYes
scored_itemsintegerYes
scored_usersintegerYes

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

PUT/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

NameInTypeRequiredDescriptionExample
catalogIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateRecommendationConfigDto

FieldTypeRequiredDescription
enabledbooleanYes
view_eventsarray<string>NoItems: 0–10
purchase_eventsarray<string>NoItems: 0–10
item_propertystringNo
window_daysintegerNoRange: 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

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
view_eventsarray<string>Yes
purchase_eventsarray<string>Yes
item_propertystringYes
window_daysintegerYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
last_computed_atstring | nullYes
scored_itemsintegerYes
scored_usersintegerYes

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

POST/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

NameInTypeRequiredDescriptionExample
catalogIdpathstringYes"feed_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

202 — Success.

Schema: RecommendationConfig

FieldTypeRequiredDescription
configuredbooleanYes
enabledbooleanYes
view_eventsarray<string>Yes
purchase_eventsarray<string>Yes
item_propertystringYes
window_daysintegerYes
statusenumYesValues: "idle", "queued", "running", "failed"
last_errorstring | nullYes
last_computed_atstring | nullYes
scored_itemsintegerYes
scored_usersintegerYes

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"

On this page