Retraced Product / Style Types API
The Product / Style Types API from Retraced — 1 operation(s) for product / style types.
OpenAPI Specification
openapi: 3.0.3
info:
title: Public API Reference Certificates Product / Style Types API
description: 'The retraced API comprises all publicly enabled options to make
machine-to-machine changes in the retraced platform. The retraced dashboard uses the
same endpoints, but also in addition more. If you wish to use the API of the dashboard,
it is possible but not versioned cleanly like the public API.
## Authentication
The authentication procedure is passwordless and uses an API key in the header. To get
an API key log into the Retraced Platform and navigate to **Developers HQ > API Keys**
then click **Create**. Be sure to copy the key somewhere safe, as you won''t be able to
view it again. If you don''t see Developers HQ in the sidebar contact your Customer
Success Manager to enable this for you. You can now set the key directly in request
headers. To authenticate using an API key, set the header key `companyapikey` to the
value of your API key.
## Getting Started
Retraced has 2 environments against which you can send your requests and receive the
expected response: staging (for development and testing) and production. Your API key
is scoped for both environments. The staging Base URL is
https://publicapi.staging.retraced.com. Staging copies production data once daily, and
all changes made on staging will be deleted.
Find detailed guides on how to use the endpoints and how we recommend building an
integration given your use case in our
[guides](https://publicapi.retraced.com/api/v2/guides). A history of public API
changes is available in the
[release notes](https://publicapi.retraced.com/api/v2/release-notes).'
version: 2.938.1
servers: []
tags:
- name: Product / Style Types
paths:
/api/v2/style-types/:
get:
tags:
- Product / Style Types
description: Returns a paginated list of style types configured for the account. Style types define the taxonomy used to classify styles — for example TSHIRTS, JEANS, OUTDOOR_JACKETS — and are organised in a hierarchy via parentId and hierarchyLevel. The id returned for each style type is the value to pass in the styleTypeId field when creating or updating a style via POST /api/v2/styles/. Use this endpoint to discover valid styleTypeId values before creating styles, as passing an unrecognised value will result in an error. Filter by hierarchyLevel to retrieve only top-level categories or leaf nodes, or by parentId to retrieve the children of a specific type.
parameters:
- schema:
default: 1
type: integer
minimum: 1
maximum: 9007199254740991
in: query
name: page
required: false
- schema:
default: 20
type: integer
minimum: 1
maximum: 100
in: query
name: limit
required: false
- schema:
default: name
type: string
enum:
- name
- createdAt
- updatedAt
in: query
name: sort
required: false
- schema:
default: asc
type: string
enum:
- asc
- desc
- ASC
- DESC
in: query
name: order
required: false
- schema:
type: string
in: query
name: name
required: false
- schema:
type: number
in: query
name: hierarchyLevel
required: false
- schema:
anyOf:
- type: string
- type: 'null'
in: query
name: parentId
required: false
- schema:
anyOf:
- type: string
- type: boolean
in: query
name: hasParentId
required: false
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
metadata:
type: object
properties:
success:
default: true
type: boolean
pagination:
type: object
properties:
page:
default: 1
type: number
limit:
default: 10
type: number
total:
default: 0
type: number
totalPages:
default: 0
type: number
required:
- page
- limit
- total
- totalPages
additionalProperties: false
required:
- success
additionalProperties: false
data:
type: array
items:
type: object
properties:
id:
type: string
minLength: 1
name:
type: string
maxLength: 255
parentId:
anyOf:
- type: string
- type: 'null'
quantityUnits:
anyOf:
- type: array
items:
type: string
- type: 'null'
weightUnits:
anyOf:
- type: array
items:
type: string
- type: 'null'
isWeightAvailable:
anyOf:
- type: boolean
- type: 'null'
assetId:
anyOf:
- type: string
- type: 'null'
assetType:
anyOf:
- type: string
maxLength: 4000
- type: 'null'
hierarchyLevel:
anyOf:
- type: number
- type: 'null'
createdAt:
anyOf:
- type: string
format: date-time
- type: 'null'
createdByUserId:
anyOf:
- type: string
maxLength: 36
- type: 'null'
createdByCompanyId:
anyOf:
- type: string
maxLength: 36
- type: 'null'
updatedAt:
anyOf:
- type: string
format: date-time
- type: 'null'
updatedByUserId:
anyOf:
- type: string
maxLength: 36
- type: 'null'
updatedByCompanyId:
anyOf:
- type: string
maxLength: 36
- type: 'null'
required:
- id
- name
- parentId
- quantityUnits
- weightUnits
- isWeightAvailable
- assetId
- assetType
- hierarchyLevel
additionalProperties: false
required:
- metadata
- data
additionalProperties: false