Attention BigCommerce Developers!
Change is coming to the v2 Orders API, and it’s one you can’t afford to overlook.
Imagine your integrations breaking overnight simply because they’re not updated to match the new structure. That’s exactly what could happen if you rely on consignments or consignments.line_items and don’t act before August 17, 2025!
BigCommerce has announced a significant update to the v2 Orders API, set to take effect on August 17, 2025.
This change introduces a new structure for side-loadable consignment resources, transitioning from an array format to an object format.
Developers using consignments or consignments.line_items in their API integrations should prepare for this update to avoid disruptions.
Read Also: BigCommerce Presents The Next Big Thing – Experience Commerce Without Compromise
What Is Changing?
Currently, the API returns consignments as an array when requests include include=consignments or include=consignments.line_items.
Current Response Format:
{ "consignments": [ { "pickups": [...], "shipping": [...], "downloads": [...], "email": {...} } ] }
Starting August 17, 2025, consignments will instead be returned as an object:
New Response Format:
{ "consignments": { "pickups": [...], "shipping": [...], "downloads": [...], "email": {...} } }
Impact on Developers
If your integration assumes consignments is an array, this change will break your functionality. Developers must update their logic and mappings to handle the new object-based structure to ensure seamless operation after the update.
Reasons for the Update
BigCommerce is making this change as part of its ongoing efforts to improve API consistency and usability. Transitioning to an object-based structure simplifies integration processes and provides developers with a predictable data format.
How to Prepare
1. Review Your Code
- Check your API integrations for any use of include=consignments or include=consignments.line_items.
- Update your logic to accommodate the new object-based structure.
2. Test the New Structure Early
- To test your integration before the deadline, include the following flag in your requests: consignment_structure=object
- This allows you to validate your integration with the updated response.
3. Consult Documentation
- Detailed technical specifications and examples are available in the BigCommerce Developer Documentation to guide you through the transition.
Supporting Both Approaches for Now
BigCommerce has confirmed that for the time being, both the legacy array format and the new object format will be supported. However, after the deadline, only the updated structure will be available.
Take Action Now
To ensure uninterrupted performance, BigCommerce strongly recommends developers review and update their integrations well before the August 2025 deadline.
Early testing using the new object-based response structure will be critical to identify and resolve potential issues proactively.
At Folio3, we specialize in smooth BigCommerce integrations and API updates. Our expert team is ready to help you adapt to these changes and ensure your systems remain optimized.
For technical guidance or support, connect with the BigCommerce Developer Support Team or reach out to Folio3 for customized solutions.
Stay prepared, update your integrations, and use this change to make your workflows more efficient. Let’s work together to build better solutions.
Read Also: BigCommerce Holdings Inc (BIGC) Stock Price Performance
