Skip to main content
Version: 7.6.x

Profiles

Entry Point: /profiles/{scope}/default

The profiles resource provides access to the currently logged in customer and their details. Using the resource you can retrieve and update a customer’s first name, last name, username, addresses. You can also retrieve the customer’s purchases and paymentmethods through this resource.

Read Default Profile​

Retrieve the customer’s default profile. Retrieve the customer’s first name, last name, username, addresses, and link to the customer’s paymentmethods.

Workflow​

  1. Start with root
  2. GET the link with rel: defaultprofile
  3. Render the response

Response Fields​

Type: profiles.profile​

NameDescriptionType
given-nameCustomer’s first name.string
family-nameCustomer’s last name.string

Read Profile Attributes​

The profiles attributes resource provides access to the currently logged in customer read-only details.

Workflow​

  1. Start with profile
  2. GET the link with rel: attributes
  3. Render the response

Read Purchases From Profile​

Retrieve a list of purchases for the logged in customer.

Workflow​

  1. Start with profile
  2. GET the link with rel: purchases
  3. Render the response

Update Profile​

Update the customer’s profile.

Workflow​

  1. Start with profile
  2. Edit the profile object with new details
  3. Update profile using a PUT request
Last updated on