Product types | API reference

Basic information

GET /{shopId}/producttypes

Returns a list of all product types.

Authorisation

OAuth 2.0 Token required with scopes:

products_read

URI parameters

Name	Type	Description
`shopId`	string	The unique identifier of the shop. Required: `true` Example: `DemoShop`

Query parameters

Name	Type	Description
`locale`	string	Represents the language code according to ISO 639-1 and the country code according to ISO 3166-1. If not provided, the shop’s default language is used. We recommend to always send this parameter with your request. If the default language had been changed in the administration, it might take up to 1 day until this change affects the shop. Required: `false` Example: `en_US`
`page`	integer	Represents the current page. Required: `false` Default: `1` Minimum: `1`
`resultsPerPage`	integer	Specifies the maximum number of results per page. Required: `false` Default: `10` Maximum: `100`

Response attributes

Name	Type	Description
`results`	integer	The existing product types, e.g. connectivity.
`page`	integer	The page number on which the product type appears.
`resultsPerPage`	integer	The number of product types returned per page.
`items`	array of productType	A list of all available product types.

Response

HTTP 200

Media type application/json

{
  "page": 1,
  "items": [
    {
      "name": "Headphones",
      "productTypeId": "64180BCB-5AEF-4E69-4A92-AC150003B611",
      "attributes": [
        {
          "visible": true,
          "name": "Connectivity",
          "values": [
            {
              "value": "Bluetooth",
              "name": "Bluetooth"
            },
            {
              "value": "Wired",
              "name": "Wired"
            }
          ],
          "preDefAttribute": true
        },
        {
          "visible": true,
          "name": "Type",
          "values": [
            {
              "value": "In-ear",
              "name": "In-ear"
            },
            {
              "value": "On-ear",
              "name": "On-ear"
            }
          ],
          "preDefAttribute": true
        }
      ],
      "alias": "Headphones"
    }
  ],
  "resultsPerPage": 10,
  "results": 1
}