Zoey REST API reference ยท Interactive version: apidocs.zoey.com

Catalog

Catalog: Index

Mode

Get

GET https://container-url.zoeysite.com/api/rest/catalog/index/mode

Example response (Get), HTTP 200:

[
    {
        "indexerCode": "catalog_product_attribute",
        "indexerMode": "real_time"
    },
    {
        "indexerCode": "catalog_product_price",
        "indexerMode": "real_time"
    },
    {
        "indexerCode": "catalog_url",
        "indexerMode": "real_time"
    },
    {
        "indexerCode": "catalog_category_product",
        "indexerMode": "real_time"
    },
    {
        "indexerCode": "cataloginventory_stock",
        "indexerMode": "real_time"
    }
]

Update

PUT https://container-url.zoeysite.com/api/rest/catalog/index/mode

Name Type Required Description
indexerCode required string Must be one of the following:cataloginventory_stock, catalog_category_product, catalog_url, catalog_product_price, catalog_product_attribute
indexerMode required string Must be either manual or real_time.

Example request body:

{
    "indexerCode": "catalog_product_attribute",
    "indexerMode": "real_time"
}

Schedule

GET https://container-url.zoeysite.com/api/rest/catalog/index/schedule

Example response (Success), HTTP 200:

"1000"

Example response (Reindex Is Alreadty Scheduled), HTTP 200:

"2000"