From v2021-01-01 to v2022-03-03
This guide will walk you through migrating from API version 2021-01-01 to API version 2022-03-03
1. Update Version Header
Update all your Convictional requests with the new version header.
Accept: application/vnd.convictional.2022-03-03
2. Confirm Breaking Changes
Do you use any of the following Seller API endpoints? If so, then continue on to step 3. If not, then you're done!
- List orders -
GET /orders - Get order -
GET /orders/{orderId} - Update order -
PATCH /orders/{orderId} - Cancel order -
POST /orders/{orderId}/cancel
Unlisted changes
Some unlisted endpoints have had breaking changes. If you use any unlisted endpoints please contact support for details.
3. Update Order Resource
In version 2022-03-03 we removed the following response fields from the Order resource. Locate all references to each removed field and replace it with the replacement field. If you already do not use any of the removed fields, then you're done!
| Removed Field | Replacement Field | Notes |
|---|---|---|
order.addresses | order.shippingAddress and order.billingAddress | order.addresses did not actually contain any addresses as it was always null. |
order.charge | order.invoice | order.invoice has a different structure than order.charge.For example, charge.raw.paid should be replaced with invoice.paid. Refer to the Order Resource for details. Be aware that order.invoice may be null.The order.charge field is unused by orders created after Feb 2020. |
order.code | order.buyerOrderCode | Exact match. |
order.companyId | order.sellerCompanyId | Exact match. For even better future-proofing, migrate to use order.sellerCompanyObjectId instead (not an exact match). |
order.date | order.buyerCreatedDate | Exact match. |
order.email | order.buyerEmail | Exact match. |
order.invoiceId | order.invoice._id | Exact match. Be aware that order.invoice may be null. |
order.parentCode | order.sellerOrderCode | Exact match. |
order.partner | order.buyerCompanyId | Exact match. For even better future-proofing, migrate to use order.buyerCompanyObjectId instead (not an exact match). |
order.tags | None | order.tags was always "". |
Updated about 2 years ago