2024-07
Released 2024-07-01Active
Migration Effort
Low
Estimated Hours
~4h
Primary risk if skipped: Data inconsistencies in inventory reporting or failed customer group updates.
Breaking Changes2
fieldMediumInventory
InventoryLevel.quantity.unit
The `unit` field within the `quantity` object for InventoryLevel has been deprecated. This change impacts how inventory quantities are represented, requiring adjustments to access quantity values directly.
Before
`InventoryLevel.quantity.unit`
After
Direct access to quantity value (e.g., `InventoryLevel.quantity.amount`)
→
Update inventory queries to access quantity amount directly, removing references to `unit`.
endpointLowCustomers
PUT /admin/api/2024-07/customer_groups/{id}.json
The API now returns a `422 Unprocessable Entity` error for invalid input during customer group updates. Previously, some invalid inputs might have been silently ignored or resulted in less specific errors.
Before
Potentially less specific error or silent failure for invalid updates.
After
`422 Unprocessable Entity` error for invalid input.
→
Implement robust input validation for customer group update requests to handle `422` errors gracefully.
Migration Checklist
Full interactive checklist →- 1Review all inventory level queries and updates for usage of `InventoryLevel.quantity.unit` and refactor to use direct quantity amount.
- 2Implement error handling for `422 Unprocessable Entity` errors in customer group update operations.
- 3Test inventory level updates thoroughly in a staging environment after code changes.
- 4Verify that customer group updates function correctly and that `422` errors are handled as expected.
- 5Deploy updated code to production environment.
- 6Monitor inventory and customer group update operations post-deployment for any unexpected behavior.
Never get blindsided by an API change again
Deprecatr AI monitors 150+ providers, maps changes to your codebase, and delivers migration checklists before your team hits a breaking change.
Join the Waitlist