Sales reps

List, create, read, update and delete the sales reps set up in your Exsited organisation settings.

Sales reps are the people you can name as the sales rep on an account or order. This area lists, creates, reads, updates and deletes them under settings. It has 5 endpoints, and every SDK supports all of them.

At a glance

Endpoint	Method	Path	What it does
List sales reps	GET	/settings/sales_reps	Lists the sales reps set up in your organisation, one page at a time.
Create a sales rep	POST	/settings/sales_reps	Creates a sales rep from a first name, last name and email address.
Retrieve a sales rep	GET	/settings/sales_reps/{sales_rep_id}	Returns one sales rep, under sales_rep.
Update a sales rep	PATCH	/settings/sales_reps/{sales_rep_id}	Changes a sales rep’s details, or enables or disables the rep.
Delete a sales rep	DELETE	/settings/sales_reps/{sales_rep_id}	Deletes a sales rep and returns no content.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• Send the body under sales_rep. A new rep takes first_name, last_name and email_address.
• status is active or inactive. Send it in an update to enable or disable a rep.
• A sales rep id starts with sr_. Shipping rules use the same sr_ prefix, so check which kind of record an id names.
• The listing pages by cursor. Send limit, then pass pagination.next_cursor as cursor while pagination.has_more is true.