Admin API/Product TypesProduct 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
Limit the number of product types returned.
The number of product types to skip when retrieving the product types.
A product type field to sort-order the retrieved product types by.
discount_condition_id
string
Filter by the ID of a discount condition. Only product types that this discount condition is applied to will be retrieved.
Filter by product type IDs.
term to search product types' values.
filter by dates less than this date
filter by dates greater than this date
filter by dates less than or equal to this date
filter by dates greater than or equal to this date
Request samples
curl --location --request GET '/admin/product-types'
Responses
application/json The total number of items available
The number of product types skipped when retrieving the product types.
The number of items per page
product_types
array[object (Product Type) {6}]
An array of product types details.
Example:ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
The value that the Product Type represents.
created_at
string <date-time>
The date with timezone at which the resource was created.
updated_at
string <date-time>
The date with timezone at which the resource was updated.
deleted_at
string <date-time> | null
The date with timezone at which the resource was deleted.
An optional key-value map with additional details
{
"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"
}
}
]
}
Modified at 2024-05-23 07:10:14
