Heartwork Commerce API

ProductCategories

Endpointhttps://api.heart.work

Download schema

Fetches a hierarchy of all product categories, for the provided workspace

GET

https://api.heart.work

/commerce-api/catalog/productcategories/hierarchy

Fetches a hierarchy of all product categories, for the provided workspace › query Parameters

sort_order

string · enum

Enum values:

Asc

Desc

sort_by

string

Fetches a hierarchy of all product categories, for the provided workspace › Responses

200

object[] · required

total

integer · int32 · required

GET/commerce-api/catalog/productcategories/hierarchy

curl --request GET \
  --url https://api.heart.work/commerce-api/catalog/productcategories/hierarchy

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "language": "language",
      "parentId": "parentId",
      "slug": "slug",
      "displayOrder": 0,
      "name": "name",
      "image": "image",
      "children": [
        null
      ]
    }
  ],
  "total": 0
}

plain

Fetches a collection of all product categories, for the provided workspace

GET

https://api.heart.work

/commerce-api/catalog/productcategories

Fetches a collection of all product categories, for the provided workspace › query Parameters

take

integer · int32

skip

integer · int32

sort_order

string · enum

Enum values:

Asc

Desc

sort_by

string · enum

Enum values:

Name

DisplayOrder

q

string

parent_id

string

is_main_category

boolean

Fetches a collection of all product categories, for the provided workspace › Responses

200

object[] · required

total

integer · int32 · required

GET/commerce-api/catalog/productcategories

curl --request GET \
  --url https://api.heart.work/commerce-api/catalog/productcategories

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "name": "name",
      "image": "image",
      "slug": "slug",
      "parent": {
        "id": "id",
        "name": "name",
        "type": "type"
      },
      "active": true,
      "displayOrder": 0,
      "content": {
        "excerpt": "excerpt",
        "description": "description",
        "language": "language",
        "seoMeta": {
          "title": "title",
          "keywords": "keywords",
          "description": "description"
        }
      }
    }
  ],
  "total": 0
}

plain

Fetches a single product category, by id.

GET

https://api.heart.work

/commerce-api/catalog/productcategories/{id}

Fetches a single product category, by id. › path Parameters

id

string · required

Unique id of the product category to fetch.

Fetches a single product category, by id. › Responses

id

string · required

name

string · required

slug

string · required

active

boolean · required

displayOrder

integer · int32 · required

image

string

object

GET/commerce-api/catalog/productcategories/{id}

curl --request GET \
  --url https://api.heart.work/commerce-api/catalog/productcategories/:id

shell

Example Responses

{
  "id": "id",
  "name": "name",
  "image": "image",
  "slug": "slug",
  "parent": {
    "id": "id",
    "name": "name",
    "type": "type"
  },
  "active": true,
  "displayOrder": 0,
  "content": {
    "excerpt": "excerpt",
    "description": "description",
    "language": "language",
    "seoMeta": {
      "title": "title",
      "keywords": "keywords",
      "description": "description"
    }
  }
}

plain

Fetches a single product category, by slug.

GET

https://api.heart.work

/commerce-api/catalog/productcategories/slug/{slug}

Fetches a single product category, by slug. › path Parameters

slug

string · required

Slug of the product category to fetch.

Fetches a single product category, by slug. › Responses

id

string · required

name

string · required

slug

string · required

active

boolean · required

displayOrder

integer · int32 · required

image

string

object

GET/commerce-api/catalog/productcategories/slug/{slug}

curl --request GET \
  --url https://api.heart.work/commerce-api/catalog/productcategories/slug/:slug

shell

Example Responses

{
  "id": "id",
  "name": "name",
  "image": "image",
  "slug": "slug",
  "parent": {
    "id": "id",
    "name": "name",
    "type": "type"
  },
  "active": true,
  "displayOrder": 0,
  "content": {
    "excerpt": "excerpt",
    "description": "description",
    "language": "language",
    "seoMeta": {
      "title": "title",
      "keywords": "keywords",
      "description": "description"
    }
  }
}

plain

PickupLocations Products

Heartwork Commerce API

ProductCategories

Endpointhttps://api.heart.work

Download schema

Fetches a hierarchy of all product categories, for the provided workspace

GET

https://api.heart.work

/commerce-api/catalog/productcategories/hierarchy

Fetches a hierarchy of all product categories, for the provided workspace › query Parameters

sort_order

string · enum

Enum values:

Asc

Desc

sort_by

string

Fetches a hierarchy of all product categories, for the provided workspace › Responses

200

object[] · required

total

integer · int32 · required

GET/commerce-api/catalog/productcategories/hierarchy

curl --request GET \
  --url https://api.heart.work/commerce-api/catalog/productcategories/hierarchy

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "language": "language",
      "parentId": "parentId",
      "slug": "slug",
      "displayOrder": 0,
      "name": "name",
      "image": "image",
      "children": [
        null
      ]
    }
  ],
  "total": 0
}

plain

Fetches a collection of all product categories, for the provided workspace

GET

https://api.heart.work

/commerce-api/catalog/productcategories

Fetches a collection of all product categories, for the provided workspace › query Parameters

take

integer · int32

skip

integer · int32

sort_order

string · enum

Enum values:

Asc

Desc

sort_by

string · enum

Enum values:

Name

DisplayOrder

q

string

parent_id

string

is_main_category

boolean

Fetches a collection of all product categories, for the provided workspace › Responses

200

object[] · required

total

integer · int32 · required

GET/commerce-api/catalog/productcategories

curl --request GET \
  --url https://api.heart.work/commerce-api/catalog/productcategories

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "name": "name",
      "image": "image",
      "slug": "slug",
      "parent": {
        "id": "id",
        "name": "name",
        "type": "type"
      },
      "active": true,
      "displayOrder": 0,
      "content": {
        "excerpt": "excerpt",
        "description": "description",
        "language": "language",
        "seoMeta": {
          "title": "title",
          "keywords": "keywords",
          "description": "description"
        }
      }
    }
  ],
  "total": 0
}

plain

Fetches a single product category, by id.

GET

https://api.heart.work

/commerce-api/catalog/productcategories/{id}

Fetches a single product category, by id. › path Parameters

id

string · required

Unique id of the product category to fetch.

Fetches a single product category, by id. › Responses

id

string · required

name

string · required

slug

string · required

active

boolean · required

displayOrder

integer · int32 · required

image

string

object

GET/commerce-api/catalog/productcategories/{id}

curl --request GET \
  --url https://api.heart.work/commerce-api/catalog/productcategories/:id

shell

Example Responses

{
  "id": "id",
  "name": "name",
  "image": "image",
  "slug": "slug",
  "parent": {
    "id": "id",
    "name": "name",
    "type": "type"
  },
  "active": true,
  "displayOrder": 0,
  "content": {
    "excerpt": "excerpt",
    "description": "description",
    "language": "language",
    "seoMeta": {
      "title": "title",
      "keywords": "keywords",
      "description": "description"
    }
  }
}

plain

Fetches a single product category, by slug.

GET

https://api.heart.work

/commerce-api/catalog/productcategories/slug/{slug}

Fetches a single product category, by slug. › path Parameters

slug

string · required

Slug of the product category to fetch.

Fetches a single product category, by slug. › Responses

id

string · required

name

string · required

slug

string · required

active

boolean · required

displayOrder

integer · int32 · required

image

string

object

GET/commerce-api/catalog/productcategories/slug/{slug}

curl --request GET \
  --url https://api.heart.work/commerce-api/catalog/productcategories/slug/:slug

shell

Example Responses

{
  "id": "id",
  "name": "name",
  "image": "image",
  "slug": "slug",
  "parent": {
    "id": "id",
    "name": "name",
    "type": "type"
  },
  "active": true,
  "displayOrder": 0,
  "content": {
    "excerpt": "excerpt",
    "description": "description",
    "language": "language",
    "seoMeta": {
      "title": "title",
      "keywords": "keywords",
      "description": "description"
    }
  }
}

plain

PickupLocations Products