Class Shipments

Returns a list of all Shipments. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

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

Creates a new Shipment 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.shipments.create({
  bearer_token: '7381273269536713689562374856',
  shipment: {
    stock_location_id: '101',
    order_id: '101',
    variant_id: '101',
    quantity: 2
  }
})

Update the selected Shipment. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.shipments.update({
  bearer_token: '7381273269536713689562374856',
  id: '1',
  shipment: {
    tracking: 'MY-TRACKING-REF-12324'
  }
})

This endpoint removes the specified Shipment. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

If selected Variant was already added to Order it will increase the quantity of existing Line Item, if not it will create a new Line Item. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.shipments.addItem({
  bearer_token: '7381273269536713689562374856',
  id: '1',
  shipment: {
    variant_id: '101',
    quantity: 2
  }
})

If selected Variant is removed completely and Shipment doesn't include any other Line Items, Shipment itself will be deleted. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.shipments.removeItem({
  bearer_token: '7381273269536713689562374856',
  id: '1',
  shipment: {
    variant_id: '101',
    quantity: 2
  }
})

Marks Shipment as ready to be shipped. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

Marks Shipment as shipped. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

Cancels the Shipment. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

Resumes previously canceled Shipment. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

Moves Shipment back to pending state. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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