Class ShippingMethods

Returns a list of Shipping Methods. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

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

Creates a new Shipping Method 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.shippingMethods.create({
  bearer_token: '7381273269536713689562374856',
  shipping_method: {
    name: 'DHL Express',
    admin_name: 'DHL Area Code D',
    code: 'DHL-A-D',
    tracking_url: 'dhlexpress.com?tracking=',
    display_on: 'both',
    tax_category_id: '1',
    shipping_category_ids: ['2'],
    calculator_attributes: {
      type: 'Spree::Calculator::Shipping::FlatPercentItemTotal'
    },
    public_metadata: {},
    private_metadata: {}
  }
})

Update selected Shipping Method. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.shippingMethods.update({
  bearer_token: '7381273269536713689562374856',
  id: '1',
  shipping_method: {
    name: 'DHL Express',
    admin_name: 'DHL Area Code D',
    code: 'DHL-A-D',
    tracking_url: 'dhlexpress.com?tracking=',
    display_on: 'both',
    tax_category_id: '1',
    shipping_category_ids: ['2'],
    calculator_attributes: {
      type: 'Spree::Calculator::Shipping::FlatPercentItemTotal'
    },
    public_metadata: {},
    private_metadata: {}
  }
})

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

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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