Class StockLocations

Returns a list of Stock Locations. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

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

Creates a new Stock Location 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.stockLocations.create({
  bearer_token: '7381273269536713689562374856',
  stock_location: {
    name: 'Warehouse 3',
    default: true,
    address1: 'South St. 8',
    address2: 'South St. 109',
    country_id: '2',
    state_id: '4',
    city: 'Los Angeles',
    state_name: 'California',
    zipcode: '90005',
    phone: '23333456',
    active: true,
    backorderable_default: true,
    propagate_all_variants: true,
    admin_name: 'string'
  }
})

Update selected Stock Location. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.stockLocations.update({
  bearer_token: '7381273269536713689562374856',
  id: '1',
  stock_location: {
    name: 'Warehouse 3',
    default: true,
    address1: 'South St. 8',
    address2: 'South St. 109',
    country_id: '2',
    state_id: '4',
    city: 'Los Angeles',
    state_name: 'California',
    zipcode: '90005',
    phone: '23333456',
    active: true,
    backorderable_default: true,
    propagate_all_variants: true,
    admin_name: 'string'
  }
})

This endpoint removes the specified Stock Location. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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