Magento 2 Address Format Requirements
Magento 2 requires address data to be formatted in a certain way when it is being added to the cart. When it is improperly formatted, Magento will return error messages that will prevent Subscribe Pro from successfully placing a recurring order.
| Field | API Field | Description | Required | Notes | Example |
|---|---|---|---|---|---|
| Magento Address ID | magento_address_id | The ID of the address record in the Magento database. | No | This should only be used in our Magento 1 integration. | 14294 |
| First Name | first_name | The first name for the address | Yes | John | |
| Middle Name | middle_name | The middle name for the address | No | Edward | |
| Last Name | last_name | The last name for the address | Yes | Doe | |
| Company | company | The address company name | No | Acme Inc | |
| Street 1 | street_1 | The street address, line 1 | Yes | 20 W. 34th St. | |
| Street 2 | street_2 | The street address, line 2 | No | Ste 300 | |
| City | city | The address city | Yes | New York | |
| Region/State | region | The address region/state abbreviation | Yes | 2-character abbreviation | NY |
| Country | country | The address country abbreviation | Yes | 2-character abbreviation | US |
| Postcode | postcode | The address postcode | Yes | 5-digit zip code | 10001 |
| Phone Number | phone | The address phone number | Yes | No specific format required | 212-736-3100 |
Troubleshooting
If the address data format is incorrect when Subscribe Pro attempts to place a recurring order to a Magento 2 store, you may encounter an error. To find more information about the most common address-related error messages, click here.