Stores to eCommerce Address Object Conversion Table
The eCommerce APIs use a different address object to the one used in the Stores APIs. Notably, fields related to contact information have been moved
to an adjacent contactDetails object (for example, in order.shippingInfo).
To help with conversion and migration, refer to the table below to check which fields have changed and how.
Fields that remain with the same name, in the same location, and with no changes in behavior are marked with an asterisk (*).
Note: In the eCommerce APIs, the buyer's email is only held in the
buyerInfofield in the order object.
| Previous Address Object | New Field Location | Change |
|---|---|---|
address.city * | address.city | |
address.email | buyerInfo.email | Moved to buyerInfo object |
address.zipCode | address.postalCode | Field name |
address.country * | address.country | |
address.addressLine1 * | address.addressLine1 | |
address.addressLine2 * | address.addressLine2 | |
address.street | address.streetAddress | Field name |
address.subdivision * | address.subdivision | |
address.fullName.firstName | contactDetails.firstName | Moved to contactDetails object |
address.fullName.lastName | contactDetails.lastName | Moved to contactDetails object |
address.phone | contactDetails.phone | Moved to contactDetails object |
address.company | contactDetails.company | Moved to contactDetails object |
address.vatId | contactDetails.vatId | Moved to contactDetails object |
Was this helpful?