API Reference

Product Categories

Organize products into categories.

5 endpoints· Auth: API Key
get/api/v1/store/integrations/categories API Key

Get categories

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/categories" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com
Set credentials in the “Authorize” menu
post/api/v1/store/integrations/categories API Key

Create categories

Request body

application/json
{
  "Name": "string",
  "ParentCategoryId": "00000000-0000-0000-0000-000000000000",
  "Description": "string",
  "Image": "string",
  "SortOrder": 0
}
Name
string
—
ParentCategoryId
string (uuid)
—
Description
string
—
Image
string (binary)
—
SortOrder
integer (int32)
—

Responses

200Success
cURL
curl -X POST "https://stagging-api.sendyiq.com/api/v1/store/integrations/categories" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -d '{
  "Name": "string",
  "ParentCategoryId": "00000000-0000-0000-0000-000000000000",
  "Description": "string",
  "Image": "string",
  "SortOrder": 0
}'
Try itagainst staging · https://stagging-api.sendyiq.com

Request body (JSON)

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/categories/{id} API Key

Get id

Path parameters

idrequired
string (uuid)
—

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/categories/{id}" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu
put/api/v1/store/integrations/categories/{id} API Key

Update id

Path parameters

idrequired
string (uuid)
—

Request body

application/json
{
  "Name": "string",
  "Description": "string",
  "Image": "string",
  "SortOrder": 0,
  "IsActive": false
}
Name
string
—
Description
string
—
Image
string (binary)
—
SortOrder
integer (int32)
—
IsActive
boolean
—

Responses

200Success
cURL
curl -X PUT "https://stagging-api.sendyiq.com/api/v1/store/integrations/categories/{id}" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -d '{
  "Name": "string",
  "Description": "string",
  "Image": "string",
  "SortOrder": 0,
  "IsActive": false
}'
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Request body (JSON)

Set credentials in the “Authorize” menu
delete/api/v1/store/integrations/categories/{id} API Key

Delete id

Path parameters

idrequired
string (uuid)
—

Responses

200Success
cURL
curl -X DELETE "https://stagging-api.sendyiq.com/api/v1/store/integrations/categories/{id}" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu