Customers

📄️List Customers

Returns a paginated list of customers.

Create a new customer. Automatically creates a default shipping address from the root address fields. Optionally provide a separate billing address.

Bulk delete customers by IDs or by applying to all filtered results.

Returns a single customer with addresses and default sales rep.

Update an existing customer. All fields are optional. Default settings (pricing tier, store, shipping methods, warehouse) can only be set on update.

Delete a customer. Returns 400 if the customer is linked to sales orders or other records.

Retrieve all addresses associated with a customer including default shipping, billing, and other addresses.

Add a new address to a customer. Address deduplication is applied.

Set a specific address as the customer's default shipping address.

Set a specific address as the customer's default billing address.

Bulk archive customers by IDs or by applying to all filtered results.

Bulk unarchive customers by IDs or by applying to all filtered results.

Check which nominal codes can be deleted. A code cannot be deleted if it is linked to sales order lines or used in nominal code mapping settings.

Archive a single customer.

Unarchive a previously archived customer.

Previews an import file for financial alerts before committing. Returns a summary of what will be imported and any errors.

Import customers from a CSV file.

Find customer matches based on name, ZIP code, and address. Uses approximate matching (90% match on address1).

Get all open (un-fully-allocated) sales credits for a customer.

Get all unpaid sales orders for a customer.

Allocate an open sales credit to one or more sales orders.

Submit pending orders to Starshipit shipping integration.

Update an existing order in Starshipit from a sales order fulfillment.

View the Starshipit order for a sales order fulfillment.