Property

Type

Details

approver

number

Returns 0 or 1 based on Customers > Accounts > View Customer > Group > Approve Orders.

attemptedPage

​

undefined

cart_count

number

Returns number of items in cart.

company

string

Returns value from Customers > Accounts > View Customer > Company.

cost_center_is_required

number

Returns 0 or 1 based on Customers > Accounts > View Customer > Checkout > Require Cost Center.

currentGroup_id

number

Returns ID of group in Customers > Accounts > View Customer > Group.

defaultBillingProfile

number

Returns ID of default billing profile, or undefined.

defaultShippingProfile

number

Returns ID of default shipping profile, or undefined.

email

string

Returns user email address.

group

string

Returns name of group in Customers > Accounts > View Customer > Group.

group_admin

number

Returns 0 or 1 based on Customers > Accounts > View Customer > Group > Group Admin.

group_id

number

Returns ID of group in Customers > Accounts > View Customer > Group.

group_parent_id

number

Returns ID of parent group in Customers > Accounts > View Customer > Group.

isAuthed

Boolean

Returns true if user has been authenticated.

isGuest

Boolean

Returns true if user hasn't logged in, but done some action to trigger creating a guest account.

last_login

string

Returns timestamp of user's last login.

name

string

Returns user's name.

price_availability

number

Returns 0 or 1 based on Customers > Accounts > View Customer > Punchout > Price Avail.

punchoutOnly

number

Returns 0 or 1 based on Customers > Accounts > View Customer > Punchout Only.

remember

Boolean

Returns true or false based on user checking the "Remember me" checkbox upon login.

Method

Params

Details

​addBillingProfile​

profileForm

Sets a new or existing address in user's billing profiles.

addRma

purch_id notes reason qty

Adds a Return Merchandise Authorization (RMA) to an order.

​addShippingProfile​

profileForm

Sets a new or existing address in user's shipping profiles.

checkout

​

​

​fillInfo​

​

Gets the user's basic information: name, email, id and company name.

forcedResetPassword

​

​

getBanner

​

​

​getProfiles​

order_id

Gets the user's billing and shipping profiles.

​guestLogin​

​

Logs in the user as a guest.

listOrders

​

​

​loadCustomer​

​

Gets the user's information, including cart and shipping methods.

​login​

userData

Logs in the user.

​logout​

​

Logs out the user.

​redirectToAttempted​

​

Redirect user to attempted page after successful login.

​redirectToLogin​

showModal

Redirects user to login page.

​register​

userData

Sets a new user account.

​removeBillingProfile​

profileID

Removes billing profile.

​removeShippingProfile​

profileID

Removes shipping profile.

requestPasswordReset

​

​

resetPassword

​

​

​roles​

​

Gets the user's roles in an array.

sendOrderEmail

​

​

setDefaultProfile

​

​

​updateGroup​

group_id

Sets a user's group.

​updateInfo​

userData

Sets existing user data.

​validatePasswordReset​

code

auth

Validates a user's password reset link.

viewOrder

​

​