{"id":26756,"date":"2025-01-16T14:51:10","date_gmt":"2025-01-16T14:51:10","guid":{"rendered":"https:\/\/ecommerce.folio3.com\/blog\/?p=26756"},"modified":"2025-01-16T15:01:44","modified_gmt":"2025-01-16T15:01:44","slug":"bigcommerce-announces-changes-to-v2-orders-api-consignment-response","status":"publish","type":"post","link":"https:\/\/ecommerce.folio3.com\/blog\/bigcommerce-announces-changes-to-v2-orders-api-consignment-response\/","title":{"rendered":"BigCommerce Announces Changes to v2 Orders API Consignment Response"},"content":{"rendered":"

Attention BigCommerce Developers!<\/span><\/h2>\n

Change is coming to the v2 Orders API, and it\u2019s one you can\u2019t afford to overlook.\u00a0<\/span><\/p>\n

Imagine your integrations breaking overnight simply because they\u2019re not updated to match the new structure. That\u2019s exactly what could happen if you rely on consignments or consignments.line_items and don\u2019t act before August 17, 2025!<\/span><\/p>\n

BigCommerce has announced a significant update to the <\/span>v2 Orders API<\/b>, set to take effect on <\/span>August 17, 2025<\/b>.\u00a0<\/span><\/p>\n

This change introduces a new structure for side-loadable consignment resources, transitioning from an array format to an object format.\u00a0<\/span><\/p>\n

Developers using <\/span>consignments<\/span> or <\/span>consignments.line_items<\/span> in their API integrations should prepare for this update to avoid disruptions.<\/span><\/p>\n

Read Also:<\/strong> BigCommerce Presents The Next Big Thing \u2013 Experience Commerce Without Compromise<\/a><\/p>\n

What Is Changing?<\/span><\/h2>\n

Currently, the API returns <\/span>consignments<\/span> as an <\/span>array<\/b> when requests include <\/span>include=consignments<\/span> or <\/span>include=consignments.line_items<\/span>.<\/span><\/p>\n

Current Response Format:<\/b><\/p>\n

{<\/span>\r\n\r\n\u00a0\u00a0\"consignments\": [<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0{<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"pickups\": [...],<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"shipping\": [...],<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"downloads\": [...],<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"email\": {...}<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0}<\/span>\r\n\r\n\u00a0\u00a0]<\/span>\r\n\r\n}<\/span><\/pre>\n
Starting August 17, 2025, <\/span>consignments<\/span> will instead be returned as an <\/span>object<\/b>:<\/span><\/p>\n
New Response Format:<\/span><\/h2>\n
{<\/span>\r\n\r\n\u00a0\u00a0\"consignments\": {<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"pickups\": [...],<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"shipping\": [...],<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"downloads\": [...],<\/span>\r\n\r\n\u00a0\u00a0\u00a0\u00a0\"email\": {...}<\/span>\r\n\r\n\u00a0\u00a0}<\/span>\r\n\r\n}<\/span><\/pre>\n
Impact on Developers<\/span><\/h2>\n
If your integration assumes <\/span>consignments<\/span> 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.<\/span><\/p>\n
Reasons for the Update<\/span><\/h2>\n
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.<\/span><\/p>\n
How to Prepare<\/span><\/h2>\n
1. Review Your Code<\/span>
\n<\/span><\/h3>\n