Class OptionTypes

Returns a list of all Option Types. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.optionTypes.list({
  bearer_token: '7381273269536713689562374856'
})

Returns a single Option Type by its ID. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.optionTypes.show({
  bearer_token: '7381273269536713689562374856'
  id: '1'
})

Creates a new Option Type and returns its attributes. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.optionTypes.create({
  bearer_token: '7381273269536713689562374856',
  option_type: {
    name": 'color',
    presentation": 'Color',
    public_metadata": {},
    private_metadata": {}
  }
})

Update selected Option Type. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.optionTypes.update({
  bearer_token: '7381273269536713689562374856',
  id: '1',
  option_type: {
    name: 'color',
    presentation: 'Color',
    public_metadata: {},
    private_metadata: {}
  }
})

This endpoint removes the specified Option Type. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.optionTypes.remove({
  bearer_token: '7381273269536713689562374856',
  id: '1'
})