Upgrading from v20170329 to v20180208
If you have already integrated with the Shippo API v20170329 and are now planning to upgrade to the latest version (v20180208), you can use this guide to identify which objects have changed between versions.
In these tables you will find the fields within each object have that have deprecated. In some cases, you can see a replacement field that has been added in v20180208.
Deprecated ◎ and added ◉ fields
| Resource | Deprecated fields from v20170329 ◎ | Fields added in v20180208 ◉ |
|---|---|---|
| Orders | address_from | from_address |
| created_at | ||
| hidden | ||
| items | ||
| to_address.ip | ||
| to_address.messages | ||
| to_address.object_purpose | ||
| to_address.object_source | ||
| to_address.object_state | ||
| placed_at | ||
| test | ||
| to_address.is_complete | ||
| to_address.validation_results | ||
Carrier Accounts
| Resource | Deprecated fields from v20170329 ◎ | Fields added in v20180208 ◉ |
|---|---|---|
| Carrier Accounts | carrier_images | |
| carrier_images.200 | ||
| carrier_images.75 | ||
| carrier_name | ||
Customs Declarations
| Resource | Deprecated fields from v20170329 ◎ | Fields added in v20180208 ◉ |
|---|---|---|
| Customs Declarations | address_importer | |
| b13a_filing_option | ||
| b13a_number | ||
| duties_payor | ||
| exporter_identification | ||
| invoiced_charges | ||
| is_vat_collected | ||
Customs Items
| Resource | Deprecated fields from v20170329 ◎ | Fields added in v20180208 ◉ |
|---|---|---|
| Customs Items | eccn_ear9 | |
Tracks
| Resource | Deprecated fields from v20170329 ◎ | Fields added in v20180208 ◉ |
|---|---|---|
| Tracks | tracking_status.substatus | |
| substatus.text | ||
| substatus.code | ||
| substatus.action_required | ||
| description | ||
Transactions
| Resource | Deprecated fields from v20170329 ◎ | Fields added in v20180208 ◉ |
|---|---|---|
| Transactions | tracking_history | |
| qr_code_url | ||
Rates
| Resource | Deprecated fields from v20170329 ◎ | Fields added in v20180208 ◉ |
|---|---|---|
| Rates | days | estimated_days |
| included_insurance_price | ||
| servicelevel.extended_token | ||
| servicelevel.parent_servicelevel | ||
Shipments
| Resource | Deprecated fields from v20170329 ◎ | Fields added in v20180208 ◉ |
|---|---|---|
| Shipments | alternate_address_to |
Updated fields ◐
The following object fields have changed type in v20180208 since v20170329:
| Resource | Field | Field type in v20170329 | Field type changed to in v20180208 |
|---|---|---|---|
| Orders | weight | int | decimal |
| Transactions | tracking_status | obj | str |