Class Addresses

Returns a list of addresses. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

Returns a single address. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

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

Creates new address 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.addresses.create({
  bearer_token: '7381273269536713689562374856',
  address: {
    country_id: '224',
    state_id: '516',
    state_name: 'New York',
    address1: '775 Old Georgetown Road',
    address2: '3rd Floor',
    city: 'Qethesda',
    phone: '3488545445002',
    alternative_phone: 'string',
    zipcode: '90210',
    firstname: 'Mark',
    lastname: 'Winterburn',
    label: 'Work'
    company: 'Paper Street Soap Co.',
    user_id: 'string'
  }
})

Update selected Address 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.addresses.update({
  bearer_token: '7381273269536713689562374856',
  id: '1',
  address: {
    country_id: '224',
    state_id: '516',
    state_name: 'New York',
    address1: '775 Old Georgetown Road',
    address2: '3rd Floor',
    city: 'Qethesda',
    phone: '3488545445002',
    alternative_phone: 'string',
    zipcode: '90210',
    firstname: 'Mark',
    lastname: 'Winterburn',
    label: 'Work'
    company: 'Paper Street Soap Co.',
    user_id: 'string'
  }
})

This endpoint removes the specified address 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.addresses.remove({
  bearer_token: '7381273269536713689562374856',
  id: '1'
})