SalesBinder API v3

Use the SalesBinder API to securely connect your applications to the data and workflows in your SalesBinder account.

Getting startedMake your first authenticated API request.AuthenticationCreate an API key and authenticate with Bearer tokens.API conventionsUnderstand JSON responses, pagination, errors, rate limits, and request IDs.Rate limitsHandle request allowances and temporary throttling.CustomersCreate, retrieve, update, delete, and list customers.ProspectsCreate, retrieve, update, delete, and list prospects.SuppliersCreate, retrieve, update, delete, and list suppliers.ContactsCreate, retrieve, update, and list contacts linked to customers, prospects, and suppliers.Inventory itemsCreate, retrieve, update, delete eligible variations, adjust, archive, and list inventory items and their variations.Item categoriesDiscover account-owned quantity and unique-item categories for inventory requests.Inventory locationsDiscover active inventory locations and their zones for location-aware API requests.Kits and bundlesRead kit definitions and history, manually assemble kits, and reverse stored assemblies.Stock transfersList, retrieve, create, edit, send, receive, and delete stock transfers between inventory locations.InvoicesCreate, update, delete, list, and retrieve invoices, record manual payments and refunds, and read payment history.EstimatesCreate, update, convert to invoices or sales orders, delete, list, and retrieve estimates and their line items.Purchase ordersCreate, update, send, receive, delete, list, and retrieve purchase orders, manage manual payments, and read payment history.Sales ordersCreate, invoice, pack, manually ship, update, delete, list, and retrieve sales orders, fulfillment history, progress, and current line items.

OpenAPI description

Download the OpenAPI 3.1 JSON description to import the API contract into compatible documentation, client-generation, testing, and API-development tools. The resource guides remain the source for workflow explanations and operational guidance.

Base URL

API v3 requests use your SalesBinder account address and the /api/v3 prefix:

https://yourbusiness.salesbinder.com/api/v3

Replace yourbusiness with your account's SalesBinder subdomain.

Available resources

Customer, prospect, supplier, contact, invoice, estimate, and guarded sales-order, purchase-order, inventory-item, kit, and stock-transfer operations are available.

Resource	Availability
Customers	Available
Prospects	Available
Suppliers	Available
Contacts	Available (create, retrieve, update, and list)
Inventory items	Available (create, retrieve, update, adjust basic quantity, archive, unarchive, list, and create, read, update, or delete eligible variations and variation-location configuration, attributes, and quantities)
Item categories	Available (list and filter account-owned categories)
Inventory locations	Available (list active locations and list their zones)
Kits and bundles	Available (list and retrieve definitions and history, manually assemble, and disassemble stored builds)
Stock transfers	Available (list, retrieve, create, edit, send, receive, and delete)
Invoices	Available (create, update and delete eligible unpaid invoices, retrieve, list, record manual payments and refunds, and read payment history)
Estimates	Available (create, update, convert eligible estimates to invoices, delete, retrieve, and list)
Purchase orders	Available (create, update, send, receive, and delete eligible purchase orders, retrieve, list, create and delete manual payments, and read payment history)
Sales orders	Available (create, invoice or pack eligible open orders, update, delete eligible untouched orders, retrieve, list, and read fulfillment history)

API versioning

The version is part of every API URL. API v3 is a new API contract and is not a drop-in replacement for the earlier SalesBinder API. Do not assume that authentication, field names, response envelopes, or URL suffixes from an earlier API version apply to v3.