API V3 - Partial Invoices, Payments, & Fulfillment

We are thrilled to announce the release of Brandboom API V3, designed to give you deeper programmatic control over your post-order workflow. This major update unlocks the ability to manage the entire sales cycle—from invoicing to fulfillment—directly through the API.

Here is what’s new in V3:

‍

1. Advanced Invoice Management

You can now create, update, and send invoices programmatically. Whether you need to generate invoices immediately after an order is placed or modify them as terms change, the new endpoints provide seamless synchronization between Brandboom and your internal ERP.

• Partial Quantity Invoices: The API supports sending partial quantity invoices from your backend to Brandboom. This is ideal for split shipments or backorder scenarios where you need to invoice only for what is currently available.
• One-Way Sync (Single Source of Truth): To ensure data integrity, invoices created via the API are locked for editing within the Brandboom UI. All updates must be synced from your backend system, ensuring your ERP remains the master record.
• Trigger Emails via API: Use the new invoices/send endpoint to trigger the official Brandboom invoice email to your buyer directly from your system once the invoice is finalized.
• Payment Collection: While invoice details are managed via API, you can still send these invoices to customers directly through Brandboom to collect payments using our secure payment processing tools.
• Correction Tools: A new invoices/delete endpoint is available to void or remove erroneous invoices programmatically.

‍

2. Payments and Refunds

Managing financials is now easier. API V3 allows you to:

• Add Payments: Record payments against specific invoices automatically as they clear in your system.
• Issue Refunds: Process and log refunds directly through the API (payments/refund), ensuring your Brandboom records always match your bank status.
• Fix Errors: A new payments/delete endpoint allows you to remove incorrect payment entries (e.g., wrong amount or date) without triggering a refund event, keeping your ledger clean.

‍

3. Fulfillment & Shipment Tracking

Streamline your fulfillment by adding shipments to invoices via the API.

• Flexible Linking: Tie a shipment to an invoice using either the Brandboom invoiceID or your system's externalInvoiceID.
• Tracking Integration: Push tracking numbers and carrier details directly to the invoice (shipments/create), automatically populating tracking links for your buyers.
• Status Updates: Use the shipments/updateStatus endpoint to keep shipment statuses (e.g., "In Transit", "Delivered") in sync without re-uploading the entire shipment object.
• Corrections: If a shipment is created in error, use shipments/delete to remove it instantly.

‍

4. Enhanced Orders Endpoint

We have significantly upgraded the orders resource to allow for direct status manipulation and workflow management:

• Reject Orders: A new orders/reject endpoint allows you to decline orders programmatically, useful for inventory allocation failures or order approval workflows.
• Granular Status Control: Use orders/update to set specific status strings that match your warehouse processes:
  • Order Status: open, processing, complete
  • Payment Status: not_paid, partially_paid, paid
  • Shipping Status: not_shipped, pick_and_pack, partially_pick_and_pack, shipped, partially_shipped
  • Export Status: not_exported, export_ready, exporting, exported

‍

Ready to get started?

‍‍Explore the full documentation and integration guides at the Brandboom Developer Portal.

Need help implementing these changes? Reach out to our support team to help you get started with the new API V3 integration.