ShippingAddress: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
No edit summary
Line 12: Line 12:
{{api_input_table_header}}
{{api_input_table_header}}
|-
|-
| DeliveryMethod || string || * Optional || The delivery method, if applicable.
| DeliveryMethod || string ||  
* Optional  
|| The delivery method, if applicable.
|-
|-
| Country || string ||  
| Country || string ||  
Line 19: Line 21:
|| The recipient's country code in ISO-3166-1 format.
|| The recipient's country code in ISO-3166-1 format.
|-
|-
| City || string || * Optional || The complete name of the city of the recipient address.
| City || string ||  
* Optional  
|| The complete name of the city of the recipient address.
|-
|-
| Region || string ||  
| Region || string ||  
Line 26: Line 30:
|| The region code of the recipient address in ISO-3166-2 format
|| The region code of the recipient address in ISO-3166-2 format
|-
|-
| Zip || string || * Optional || The zip code of the recipient address.
| Zip || string ||  
* Optional  
|| The zip code of the recipient address.
|-
|-
| Street || string || * Optional || The shipping street address with house number and other details.
| Street || string ||  
* Optional  
|| The shipping street address with house number and other details.
|-
|-
| Street2 || string || * Optional || The address, continued.
| Street2 || string ||  
* Optional  
|| The address, continued.
|-
|-
| FullName || string || * Optional || The full civil or official name of the recipient.
| FullName || string ||  
* Optional  
|| The full civil or official name of the recipient.
|-
|-
| Phone || string || * Optional || The phone number of the recipient.
| Phone || string ||  
* Optional  
|| The phone number of the recipient.
|-
|-

Revision as of 19:30, 2 February 2017

Shipping address structure

This structurerepresents a shipping address related to a payment.

API usage

This structure is used by the following API endpoints:

Property list

Property name Property type Limitations and constraints Description
DeliveryMethod string
  • Optional
The delivery method, if applicable.
Country string
  • Optional
  • Exactly 2 characters
The recipient's country code in ISO-3166-1 format.
City string
  • Optional
The complete name of the city of the recipient address.
Region string
  • Optional
  • Exactly 2 characters
The region code of the recipient address in ISO-3166-2 format
Zip string
  • Optional
The zip code of the recipient address.
Street string
  • Optional
The shipping street address with house number and other details.
Street2 string
  • Optional
The address, continued.
FullName string
  • Optional
The full civil or official name of the recipient.
Phone string
  • Optional
The phone number of the recipient.