Breaking Change Announcement: Update to v2 Orders API Side-Loadable Consignment Response August 2025

Katie Hoesley

Attention BigCommerce Developers! We are announcing an important update to the v2 Orders API that will introduce a breaking change to the structure of side-loadable consignment resources. This change will take effect on August 17, 2025. If your integrations rely on consignments or consignments.line_items in the Orders API, it is crucial to update your implementation to align with the new response structure.

For the time being, BigCommerce supports both the legacy approach and this updated approach.

What Is Changing?

Currently, when you include include=consignments or include=consignments.line_items in your request parameters, the response structure is as follows:

{

  "consignments": [

    {

      "pickups": [...],

      "shipping": [...],

      "downloads": [...],

      "email": {...}

    }

  ]

}

Starting August 17, 2025, the response will return consignments as an object instead of an array:

{

  "consignments": {

    "pickups": [...],

    "shipping": [...],

    "downloads": [...],

    "email": {...}

  }

}

How Will This Impact My Integrations?

If your code assumes that consignments is an array, this change will break your integration. Any logic or mappings that process consignments data will need to be updated to handle the new object-based structure.

Why Is This Change Happening?

This update is part of our ongoing effort to improve the consistency and usability of the BigCommerce API. By transitioning to an object-based structure, we aim to simplify integration logic and provide a more predictable data format for developers.

What should I do

  1. Review and Update Your Code:

    • Check your API integrations for usage of include=consignments or include=consignments.line_items.

    • Update your logic to handle the new object-based response structure.

  2. Test Early by Opting In:

    • To test your integration against the new structure before the August 17, 2025 deadline, include the following flag in your requests: consignment_structure=object

    • This will allow you to receive the updated response structure immediately and validate your integration.

  3. Refer to the Documentation:

What's next?

Stay ahead of the change—review your integrations today and ensure a seamless transition!

To learn more about this update:

If you have questions, feedback, or issues implementing, please reach out to the BigCommerce DevRel team or join our Developer Community today, or reach out to our support team.