List Product Types

Retrieve a list of product types. The product types can be filtered by fields such as q or value. The product types can also be sorted or paginated.

Request

Query Params

limit

integer

optional

Limit the number of product types returned.

offset

integer

optional

The number of product types to skip when retrieving the product types.

order

string

optional

A product type field to sort-order the retrieved product types by.

discount_condition_id

string

optional

Filter by the ID of a discount condition. Only product types that this discount condition is applied to will be retrieved.

value

array[string]

optional

Filter by value.

array[string]

optional

Filter by product type IDs.

string

optional

term to search product types' values.

array[string]

optional

filter by dates less than this date

Example:

["",""]

array[string]

optional

filter by dates greater than this date

Example:

["",""]

lte

array[string]

optional

filter by dates less than or equal to this date

Example:

["",""]

gte

array[string]

optional

filter by dates greater than or equal to this date

Example:

["",""]

Responses

🟢200OK

application/json

Body

count

integer

required

The total number of items available

offset

integer

required

The number of product types skipped when retrieving the product types.

limit

integer

required

The number of items per page

product_types

array[object (Product Type) {6}]

required

An array of product types details.

string

required

The product type's ID

Example:

ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A

value

string

required

The value that the Product Type represents.

Example:

Clothing

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

Example

{
  "count": 0,
  "offset": 0,
  "limit": 0,
  "product_types": [
    {
      "id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A",
      "value": "Clothing",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "metadata": {
        "car": "white"
      }
    }
  ]
}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

List Product Types

Request

Request samples

Responses