Merchants
API
Release notes

Release Notes 🚀

Welcome to the release notes for Merchant API. Here you'll find a summary of changes, improvements, and fixes in each version.

Order Invoice Files Support

Endpoints: /v1/orders/{orderId}/invoices, /v2/orders/{orderReference}/invoices, /orders/{...} Versions: v1, v2 Date: 2026-04-27 Status: ✅ Released

Description 📄

Merchants can now manage invoice files directly through the Merchant API.

This release adds support for:

  • Uploading invoice files for a merchant-owned order
  • Soft-deleting previously uploaded invoice files
  • Returning merchant-uploaded invoice URLs in the single-order response

Details

  • POST invoice upload Merchants can upload invoice files using a JSON payload with required filename and contentBase64 fields. The filename extension is used for file type validation.

  • DELETE invoice removal Merchants can soft-delete invoice files associated with their own orders.

  • GET order response Merchant-uploaded invoice files are now returned under the invoices field in the order details response.

Notes

  • In v1, invoice operations use the legacy numeric orderId.
  • In v2, invoice operations use the merchant order reference.
  • A hard limit of 3 invoice files per order is enforced.
  • Supported invoice file extensions are pdf, png, jpeg, and jpg.
  • The maximum decoded invoice file size is 4 MB.
  • Uploaded or deleted invoice files are reflected immediately in the order response.

Shipments Endpoint Update

ID: 23125 Endpoint: /shipments Date: 2025-01-23 Status: ✅ Released

Description 📄

Merchants now have visibility into the shipping method (Box Now, CleverPoint). These properties have been added to both v1 and v2 endpoints.

APIAuthentication