Customers
List Customers
Returns a paginated list of customers.
Show Customer
Returns a single customer.
List Customers
List all customers with DataTable support. Supports filtering, sorting, pagination, and column inclusion/exclusion.
Create Customer
Create a new customer. Automatically creates a default shipping address from the root address fields. Optionally provide a separate billing address.
Bulk Delete Customers
Bulk delete customers by IDs or by applying to all filtered results.
Get Customer
Get a single customer with all related data including addresses, billing/shipping addresses, default settings, and lifetime value.
Update Customer
Update an existing customer. All fields are optional. Default settings (pricing tier, store, shipping methods, warehouse) can only be set on update.
Delete Customer
Delete a customer. Returns 400 if the customer is linked to sales orders or other records.
Get Customer Addresses
Retrieve all addresses associated with a customer including default shipping, billing, and other addresses.
Add Customer Address
Add a new address to a customer. Address deduplication is applied.
Set Default Shipping Address
Set a specific address as the customer's default shipping address.
Set Default Billing Address
Set a specific address as the customer's default billing address.
Bulk Archive Customers
Bulk archive customers by IDs or by applying to all filtered results.
Bulk Unarchive Customers
Bulk unarchive customers by IDs or by applying to all filtered results.
Check Deletable
Check which customers can be deleted. Returns deletability status for each customer.
Archive Customer
Archive a single customer.
Unarchive Customer
Unarchive a previously archived customer.
Preview Import
Preview a customer import from a CSV file before committing.
Import Customers
Import customers from a CSV file.
Find Customer Match
Find customer matches based on name, ZIP code, and address. Uses approximate matching (90% match on address1).
Get Open Sales Credits
Get all open (un-fully-allocated) sales credits for a customer.
Get Unpaid Orders
Get all unpaid sales orders for a customer.
Allocate Sales Credit to Orders
Allocate an open sales credit to one or more sales orders.
Unallocate Sales Credit from Order
Reverse a single sales credit allocation. Deletes the allocation row, reverses the corresponding Credit-type Payment recorded against the sales order, and recalculates the credit's payment_status (paid → partially_paid or open).
Submit Orders to Starshipit
Submit pending orders to Starshipit shipping integration.
Update Starshipit Order from Fulfillment
Update an existing order in Starshipit from a sales order fulfillment.
View Starshipit Order
View the Starshipit order for a sales order fulfillment.
List SKU Mappings
Return a paginated list of SKU mappings for the specified customer. Each mapping links a customer-facing SKU code to an internal product.
Create / Upsert SKU Mapping
Create a new SKU mapping or update an existing one (upsert) for the given customer. If a mapping for customer_sku already exists, it is updated with the new product_id.
Delete SKU Mapping
Delete a specific SKU mapping by ID for the given customer.
Import SKU Mappings from CSV
Bulk-import SKU mappings for a customer from a CSV file. The CSV must have a header row with columns customer_sku and product_id. Existing mappings for the same customer_sku are updated (upsert behaviour).
Export SKU Mappings as CSV
Export all SKU mappings for a customer as a CSV file download. The response is a CSV with columns customer_sku and product_id. Use this as a template for the import endpoint.
List Customers
Get a paginated list of WooCommerce customers for a specific integration instance.
Sync Customers
Sync customers from WooCommerce for the integration instance.