# Streamlined

> Build on Streamlined: customers, orders, invoices, payments and webhooks for B2B order-to-cash.

- [Introduction](https://docs.streamlinedpayments.com/index.md): Connect your systems to Streamlined to manage customers, orders, invoices and payments for your B2B sales.
- [Quickstart](https://docs.streamlinedpayments.com/quickstart.md): Make your first requests against the Sandbox: list your customers, then create one.
- [Authentication](https://docs.streamlinedpayments.com/authentication.md): Authenticate every request with your App ID and API key.
- [Errors](https://docs.streamlinedpayments.com/errors.md): What each status code means, what the error body looks like, and what to do next.
- [Pagination](https://docs.streamlinedpayments.com/pagination.md): Page through list endpoints with page and per_page.
- [Approve customer applications](https://docs.streamlinedpayments.com/guides/customer-applications.md): List the applications your customers submit, approve them, and optionally export the customer to Shopify in the same request.
- [Webhooks](https://docs.streamlinedpayments.com/guides/webhooks.md): Get an HTTPS POST when something changes, instead of polling for it.
- [List orders](https://docs.streamlinedpayments.com/api-reference/orders/list-orders.md): Lists all orders for a company where invoiced is false.
- [Create order](https://docs.streamlinedpayments.com/api-reference/orders/create-order.md): Creates a new order.
- [Get order details](https://docs.streamlinedpayments.com/api-reference/orders/get-order-details.md): Fetches a specific order by UUID.
- [Update order](https://docs.streamlinedpayments.com/api-reference/orders/update-order.md): Updates an order that has not been invoiced.
- [Delete order](https://docs.streamlinedpayments.com/api-reference/orders/delete-order.md): Deletes an order that has not been invoiced.
- [List scheduled orders](https://docs.streamlinedpayments.com/api-reference/orders/list-scheduled-orders.md): Lists scheduled orders/invoices.
- [Add line item](https://docs.streamlinedpayments.com/api-reference/orders/add-line-item.md): Adds a line item to an order that has not been invoiced.
- [Remove line item](https://docs.streamlinedpayments.com/api-reference/orders/remove-line-item.md): Removes a line item from an order that has not been invoiced.
- [Schedule order](https://docs.streamlinedpayments.com/api-reference/orders/schedule-order.md): Schedules or unschedules an order.
- [List customers](https://docs.streamlinedpayments.com/api-reference/customers/list-customers.md): Retrieves a paginated list of customers.
- [Create customer](https://docs.streamlinedpayments.com/api-reference/customers/create-customer.md): Creates a new customer.
- [Get customer details](https://docs.streamlinedpayments.com/api-reference/customers/get-customer-details.md): Retrieves detailed information about a specific customer.
- [Update customer](https://docs.streamlinedpayments.com/api-reference/customers/update-customer.md): Updates an existing customer. Send net_terms as null (or empty string) to clear and inherit from parent.
- [Delete customer](https://docs.streamlinedpayments.com/api-reference/customers/delete-customer.md): Soft-deletes a customer (sets deleted_at).
- [List customer applications](https://docs.streamlinedpayments.com/api-reference/customer-applications/list-customer-applications.md): Returns applications, newest submitted first.
- [Approve customer application](https://docs.streamlinedpayments.com/api-reference/customer-applications/approve-customer-application.md): Approves a pending application, and optionally sets the customer's net terms and exports the customer to Shopify. Returns the customer, plus the export result if you sent `export.shopify`.
- [List customer groups](https://docs.streamlinedpayments.com/api-reference/customer-groups/list-customer-groups.md)
- [Create customer group](https://docs.streamlinedpayments.com/api-reference/customer-groups/create-customer-group.md)
- [Get customer group](https://docs.streamlinedpayments.com/api-reference/customer-groups/get-customer-group.md)
- [Update customer group](https://docs.streamlinedpayments.com/api-reference/customer-groups/update-customer-group.md): Updates the group. When `net_terms` is included in the request, the new value is also propagated to every member customer's `net_terms` (set to null on the members when cleared). Send an empty string or null to clear and inherit from the merchant default.
- [List group members](https://docs.streamlinedpayments.com/api-reference/customer-groups/list-group-members.md)
- [Add members to group](https://docs.streamlinedpayments.com/api-reference/customer-groups/add-members-to-group.md): **Add-only.** Each customer in `customer_uuids` is added to the group. Customers already in the group are no-ops. Customers in another group are moved into this one. Members not named in the request are NOT touched. All-or-nothing: any unknown or cross-company uuid fails the entire request (no parti…
- [Remove members from group](https://docs.streamlinedpayments.com/api-reference/customer-groups/remove-members-from-group.md): **Remove-only.** Each customer in `customer_uuids` is removed from the group (their `customer_group_id` is cleared). Customers not in the group are no-ops. Members not named in the request are NOT touched.
- [List customer files](https://docs.streamlinedpayments.com/api-reference/customer-files/list-customer-files.md): Retrieves a list of files for a specific customer.
- [Upload customer file](https://docs.streamlinedpayments.com/api-reference/customer-files/upload-customer-file.md): Uploads a new file for a specific customer.
- [Get customer file](https://docs.streamlinedpayments.com/api-reference/customer-files/get-customer-file.md): Retrieves a specific file for a customer.
- [Update customer file](https://docs.streamlinedpayments.com/api-reference/customer-files/update-customer-file.md): Updates a specific file for a customer.
- [Delete customer file](https://docs.streamlinedpayments.com/api-reference/customer-files/delete-customer-file.md): Deletes a specific file for a customer.
- [List customer addresses](https://docs.streamlinedpayments.com/api-reference/customer-addresses/list-customer-addresses.md): Retrieves a list of addresses for a specific customer.
- [Add customer address](https://docs.streamlinedpayments.com/api-reference/customer-addresses/add-customer-address.md): Adds a new address for a specific customer.
- [Get customer address](https://docs.streamlinedpayments.com/api-reference/customer-addresses/get-customer-address.md): Retrieves a specific address for a customer.
- [Update customer address](https://docs.streamlinedpayments.com/api-reference/customer-addresses/update-customer-address.md): Updates a specific address for a customer.
- [Delete customer address](https://docs.streamlinedpayments.com/api-reference/customer-addresses/delete-customer-address.md): Deletes a specific address for a customer.
- [Set address as default billing](https://docs.streamlinedpayments.com/api-reference/customer-addresses/set-address-as-default-billing.md): Sets a specific address as the default billing address for a customer.
- [List payouts](https://docs.streamlinedpayments.com/api-reference/payouts/list-payouts.md): Retrieves a paginated list of all payouts.
- [Get payout details](https://docs.streamlinedpayments.com/api-reference/payouts/get-payout-details.md): Retrieves detailed information about a specific payout.
- [List pending payouts](https://docs.streamlinedpayments.com/api-reference/payouts/list-pending-payouts.md): Retrieves a paginated list of pending payouts (payouts that have not been paid out yet).
- [List invoices](https://docs.streamlinedpayments.com/api-reference/invoices/list-invoices.md): Retrieves a paginated list of invoices based on the provided parameters.
- [Create invoice from order](https://docs.streamlinedpayments.com/api-reference/invoices/create-invoice-from-order.md): Creates a new invoice from an existing order.
- [Get invoice details](https://docs.streamlinedpayments.com/api-reference/invoices/get-invoice-details.md): Retrieves detailed information about a specific invoice.
- [Update invoice](https://docs.streamlinedpayments.com/api-reference/invoices/update-invoice.md): Updates an issued invoice. Every field is optional; only what you send is changed.
- [List transactions](https://docs.streamlinedpayments.com/api-reference/transactions/list-transactions.md): Retrieves a paginated list of transactions based on the provided parameters.
- [Get transaction details](https://docs.streamlinedpayments.com/api-reference/transactions/get-transaction-details.md): Retrieves detailed information about a specific transaction.
- [List products](https://docs.streamlinedpayments.com/api-reference/products/list-products.md): Retrieves a paginated list of products.
- [Create product](https://docs.streamlinedpayments.com/api-reference/products/create-product.md): Creates a new product.
- [Get product details](https://docs.streamlinedpayments.com/api-reference/products/get-product-details.md): Retrieves detailed information about a specific product.
- [Archive product](https://docs.streamlinedpayments.com/api-reference/products/archive-product.md): Archives a product (soft delete).
- [Update product](https://docs.streamlinedpayments.com/api-reference/products/update-product.md): Updates an existing product. Can also be used to archive/unarchive by setting archived to true/false.
- [Bulk update products](https://docs.streamlinedpayments.com/api-reference/products/bulk-update-products.md): Two request shapes share this endpoint.
- [Merge products](https://docs.streamlinedpayments.com/api-reference/products/merge-products.md): Merges multiple products into a primary product. Merged products are archived and their usage counts are combined.
- [Product autocomplete](https://docs.streamlinedpayments.com/api-reference/products/product-autocomplete.md): Returns product suggestions for autocomplete functionality.
- [Bulk import products](https://docs.streamlinedpayments.com/api-reference/products/bulk-import-products.md): Import multiple products at once. Creates new products or updates existing ones.
- [List deposit links](https://docs.streamlinedpayments.com/api-reference/deposit-links/list-deposit-links.md): Retrieves a paginated list of deposit links, newest first.
- [Create deposit link](https://docs.streamlinedpayments.com/api-reference/deposit-links/create-deposit-link.md): Creates a deposit link and returns the payable URL to send the customer.
- [Retrieve deposit link](https://docs.streamlinedpayments.com/api-reference/deposit-links/retrieve-deposit-link.md): Retrieves a single deposit link. One call covers the whole lifecycle: `status` moves `open` to `paid`, then `applied` turns true and `payment.invoice_identifier` fills in once the money is matched to an invoice.
- [Cancel deposit link](https://docs.streamlinedpayments.com/api-reference/deposit-links/cancel-deposit-link.md): Cancels the link. The URL stops working immediately; the record is kept, so a link that has taken money stays auditable. Only an open link can be canceled.
- [Apply deposit to invoice](https://docs.streamlinedpayments.com/api-reference/deposit-links/apply-deposit-to-invoice.md): Puts the deposit against one of your invoices.
- [Unqueue deposit from invoice](https://docs.streamlinedpayments.com/api-reference/deposit-links/unqueue-deposit-from-invoice.md): Takes a queued deposit back off its invoice, so it lands as an unapplied payment instead. Does nothing, and returns `200`, when nothing is queued.
- [List webhook endpoints](https://docs.streamlinedpayments.com/api-reference/webhooks/list-webhook-endpoints.md)
- [Create webhook endpoint](https://docs.streamlinedpayments.com/api-reference/webhooks/create-webhook-endpoint.md): Registers an endpoint. The response carries the endpoint's signing `secret`, which is **only returned here and when you rotate it**. Store it now.
- [List webhook event types](https://docs.streamlinedpayments.com/api-reference/webhooks/list-webhook-event-types.md): The event types an endpoint can subscribe to.
- [Retrieve webhook endpoint](https://docs.streamlinedpayments.com/api-reference/webhooks/retrieve-webhook-endpoint.md): Never includes the secret.
- [Delete webhook endpoint](https://docs.streamlinedpayments.com/api-reference/webhooks/delete-webhook-endpoint.md): Deletes the endpoint and its delivery history. Nothing further is sent to it.
- [Update webhook endpoint](https://docs.streamlinedpayments.com/api-reference/webhooks/update-webhook-endpoint.md): Change the URL, events or description, or switch the endpoint on or off. `status: enabled` turns back on an endpoint that switched itself off after repeated failures, and clears its `disabled_reason`.
- [Rotate webhook secret](https://docs.streamlinedpayments.com/api-reference/webhooks/rotate-webhook-secret.md): Replaces the signing secret and returns the new one, once. It takes effect immediately, for deliveries already queued as well: there is no period in which both secrets verify, so switch your receiver to the new secret as you rotate.
- [Send test event](https://docs.streamlinedpayments.com/api-reference/webhooks/send-test-event.md): Sends a `ping` event to this endpoint only, whatever it subscribes to, so you can check the URL and your signature verification. Queued like any delivery; its outcome appears in the deliveries list.
- [List webhook deliveries](https://docs.streamlinedpayments.com/api-reference/webhooks/list-webhook-deliveries.md): Every delivery to this endpoint, newest first, with the outcome of its latest attempt.
- [Retry webhook delivery](https://docs.streamlinedpayments.com/api-reference/webhooks/retry-webhook-delivery.md): Sends a delivery again, starting a fresh set of retries. For after an outage on your side is fixed.
- [Changelog](https://docs.streamlinedpayments.com/changelog.md): New endpoints and changes to the Streamlined API.

## OpenAPI Specs

- [openapi](/api-reference/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.