Upgrading from v20161025 to v20180208

If you have already integrated with the Shippo API v20161025 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

Orders

Resource Deprecated fields from v20161025 ◎ 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

Batches

Resource Deprecated fields from v20161025 ◎ Fields added in v20180208 ◉
Batches object_status status

Carrier Accounts

Resource Deprecated fields from v20161025 ◎ Fields added in v20180208 ◉
Carrier Accounts carrier_images
carrier_images.300
carrier_images.425
carrier_name

Manifests

Resource Deprecated fields from v20161025 ◎ Fields added in v20180208 ◉
Manifests is_test
object_status status
submission_date
shipment_date

Refund

Resource Deprecated fields from v20161025 ◎ Fields added in v20180208 ◉
Refund object_status status

Customs Declarations

Resource Deprecated fields from v20161025 ◎ 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 v20161025 ◎ Fields added in v20180208 ◉
Customs Items eccn_ear9

Tracks

Resource Deprecated fields from v20161025 ◎ Fields added in v20180208 ◉
Tracks tracking_status.substatus
substatus.text
substatus.code
substatus.action_required
description

Transactions

Resource Deprecated fields from v20161025 ◎ Fields added in v20180208 ◉
Transactions customs_note
notification_email_from
notification_email_other
notification_email_to
object_status status
pickup_date
submission_note
tracking_history
was_test test
billing.payments
billing
qr_code_url

Rates

Resource Deprecated fields from v20161025 ◎ Fields added in v20180208 ◉
Rates available_shippo
days estimated_days
delivery_attempts
inbound_endpoint
insurance
insurance_amount
insurance_amount_local
insurance_currency
insurance_currency_local
object_purpose
object_state
object_updated
outbound_endpoint
servicelevel_name servicelevel.name
servicelevel_terms servicelevel.terms
servicelevel_token servicelevel.token
trackable
servicelevel.extended_token
servicelevel.parent_servicelevel
included_insurance_price
servicelevel

Shipments

Resource Deprecated fields from v20161025 ◎ Fields added in v20180208 ◉
Shipments insurance_amount
insurance_currency
object_purpose
object_state
object_status
parcel
rates_list
rates_url
reference_1
reference_2
return_of
submission_date
submission_type
address_from.is_complete
address_from.validation_results
address_from.name
address_from.street3
address_from.zip
address_from.city
address_from.state
address_from.test
address_from.object_id
status
address_to.is_complete
address_from.company
address_from.is_residential
address_from.email
address_from.country
address_from.phone
address_from.street2
address_from.street1
address_from.street_no
address_to.object_id
address_return.city
address_return.company
address_return.country
address_return.email
address_return.is_complete
address_return.is_residential
address_return.name
address_return.object_id
address_return.phone
address_return.state
address_return.street1
address_return.street2
address_return.street3
address_return.street_no
address_return.test
address_return.validation_results
address_return.zip
address_to.city
address_to.company
address_to.country
address_to.email
address_to.is_residential
address_to.name
address_to.phone
address_to.state
address_to.street1
address_to.street2
address_to.street3
address_to.street_no
address_to.test
address_to.validation_results
address_to.zip
alternate_address_to
rates
parcels
shipment_date

Addresses

Resource Deprecated fields from v20161025 ◎ Fields added in v20180208 ◉
Addresses ip
messages
object_purpose
object_source
object_state
is_complete
validation_results

Updated fields ◐

The following object fields have changed type in v20180208 since v20161025:

Resource Field Field type in v20161025 Field type changed to in v20180208
Orders weight int decimal
Transactions tracking_status obj str
Shipments address_from str Obj or address object id as a str
address_to str Obj or address object id as a str
address_return str Obj or address object id as a str