By making use of the Punchmark POS Categories feature, it allows clients to map the categories named in their POS/Inventory Systems to the categories in their websites. Often category names differ between a POS/Inventory System and a client’s website. The job of this API is to maintain a list of the categories in the POS System. Once the category list exists, the client will be able to go into SiteManager and map each POS category to the corresponding website category.

...

Once categories are mapped, requests to the Product Import API can specify POS/Inventory System category names, and imported products will automatically be categorized into the appropriate website categories.

The basic functionality of the POS categories Category API is “delete all”, “recreate all”, and “insert”. The job of this API is to maintain a list of the categories in the POS System. Once the category list exists, the client will be able to go in to SiteManager and map each POS category to the corresponding website category“delete”, “get”, and “insert”.

Endpoints

All endpoints for this API follow this format:

...

https://{DOMAIN}/api/async.php?t=sitemanager&m=pos_cats&a=get_all_pos_cats&authKey={AUTHKEY}

Return Values

The API will return JSON in the format
{
”success”:true|false,
”error”:true|false
}

SUCCESS

The return value for success will contain true in the success property.

Example

{
    "success": true,
    "error": false,
    "msg": "4 rows created",
    "rowsCreated": 4
}

ERRORS

If the “error” property is true, a msg property will be included with clues as to what the error is.

Example

{
    "success": false,
    "error": true,
    "msg": "Missing parameter."
}