Class Taxons

Returns a list of Taxons. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

Returns a single Taxon 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.taxons.show({
  bearer_token: '7381273269536713689562374856'
  id: '1'
})

Creates a new Taxon 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.taxons.create({
  bearer_token: '7381273269536713689562374856',
  taxon: {
    taxonomy_id: 'string',
    parent_id: 'string',
    name: 'string',
    public_metadata: {
      ability_to_recycle: '90'
    },
    private_metadata: {
      profitability: 2
    }
  }
})

Update selected Taxon. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.taxons.update({
  bearer_token: '7381273269536713689562374856',
  id: '1',
  taxon: {
    taxonomy_id: 'string',
    parent_id: 'string',
    name: 'string',
    public_metadata: {},
    private_metadata: {}
  }
})

This endpoint removes the specified Taxon. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

Reposition selected Taxon. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.taxons.reposition({
  bearer_token: '7381273269536713689562374856',
  id: '1',
  taxon: {
    new_parent_id: 1,
    new_position_idx: 1
  }
})