Class StockItems

Returns a list of Stock Items. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

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

Creates a new Stock Item 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.stockItems.create({
  bearer_token: '7381273269536713689562374856',
  stock_item: {
    variant_id: '2',
    stock_location_id: '2',
    count_on_hand: 200,
    backorderable: false
  }
})

Update selected Stock Item. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.stockItems.update({
  bearer_token: '7381273269536713689562374856',
  id: '1',
  stock_item: {
    variant_id: '2',
    stock_location_id: '2',
    count_on_hand: 200,
    backorderable: false
  }
})

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

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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