Class ShippingCategories

Returns a list of Shipping Categories. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

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

Creates a new Shipping Category 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.shippingCategories.create({
  bearer_token: '7381273269536713689562374856',
  shipping_category: {
    name: 'Another Category'
  }
})

Update selected Shipping Category for the signed in User. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.shippingCategories.update({
  bearer_token: '7381273269536713689562374856',
  id: '1',
  shipping_category: {
    name: 'Another Category'
  }
})

This endpoint removes the specified Shipping Category. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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