Class Adjustments

Returns a list of adjustments. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

Returns a single adjustment. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

Creates new adjustment 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.adjustments.create({
  bearer_token: '7381273269536713689562374856',
  adjustment: {
    order_id: 'string',
    label: 'Shipping costs',
    adjustable_id: 'string',
    adjustable_type: 'Spree::LineItem',
    source_id: 'string',
    source_type: 'Spree::TaxRate',
    amount: '10.9',
    mandatory: true,
    eligible: true,
    state: 'open',
    included: false
  }
})

Update selected Adjustment 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.adjustments.update({
  bearer_token: '7381273269536713689562374856',
  id: '1',
  adjustment: {
    order_id: string,
    label: Shipping costs',
    adjustable_id: 'string',
    adjustable_type: 'Spree::LineItem',
    source_id: 'string',
    source_type: 'Spree::TaxRate',
    amount: 10.9,
    mandatory: true,
    eligible: true,
    state: 'open',
    included: false
  }
})

This endpoint removes the specified adjustment for the current user. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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