Return all available Suppliers Product Categories

GET 
/api/v1/supplier_product_categories

Return all available Suppliers Product Categories

Request

Query Parameters

include string

Include associations (delimited with comma). Available associations: sub_categories

sort string
page int32

Default value: 1

Page offset to fetch.

per_page int32

Default value: 10

Number of results to return per page.

Responses

200

Return all available Suppliers Product Categories

application/vnd.api+json

Schema

Schema

data

object[]

required

Array [

id string

type string

attributes

object

name string

name-fr string

name-de string

name-it string

name-es string

name-el string

children

object[]

Array [

id stringrequired

name stringrequired

]

custom-category-id string

parent-category string

parent-name string

delivery-schedule object

ordering-deadline integer

ordering-lead-time integer

]

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "type": "string",
      "attributes": {
        "name": "string",
        "name-fr": "string",
        "name-de": "string",
        "name-it": "string",
        "name-es": "string",
        "name-el": "string",
        "children": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "custom-category-id": "string",
        "parent-category": "string",
        "parent-name": "string",
        "delivery-schedule": {},
        "ordering-deadline": 0,
        "ordering-lead-time": 0
      }
    }
  ]
}

Example

{
  "data": [
    {
      "id": "d0f96dc7-0d07-44c5-984b-8000b5a3b3ad",
      "type": "supplier-product-categories",
      "attributes": {
        "name": "Category Name",
        "parent-category": "fb0a19d1-012b-54da-ae40-ff17c0f12b97",
        "parent-name": "Parent Category",
        "children": [
          {
            "name": "Child Category",
            "id": "c0f68dc7-0f07-43c5-984b-8002b5a7b3ad"
          }
        ],
        "custom-category-id": "A113",
        "ordering-deadline": 57600,
        "ordering-lead-time": 172800
      }
    }
  ],
  "meta": {
    "total-count": 22,
    "total-pages": 3
  }
}

Loading...