Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 3.76 KB

File metadata and controls

40 lines (31 loc) · 3.76 KB

ToAddressV2

The complete address of the Recipient or Department (in case if the address is not pointed to any individual recipient).

Properties

Name Type Description Notes
name str The name of the Recipient. <br /> `Max length = 30`
address_line1 str The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Recipient. <br /> `Max length = 35`.
city_town str The name of the city or town the Recipient belongs to. <br /> `Max length = 30`.
state_province str The name of the State or Province the Sender belongs to. It is the `2-letter` State or Province Code for US or Canadian address(es). <br /> Below is the hyperlink for CA country that will navigate to its Province/State Codes page. Similarly, respective country users can check for their country- State/Province codes. <br /> Please switch to the `Search` tab, select `Country codes` radio button, enter the required country name or country code, and then click `SEARCH` button . <br /> `Max length = 2`
postal_code str The Postal Code or ZIP Code of the address.<br /> For CA addresses, use a `six-character` alphanumeric string Postal Code in this format: 'A1A 1A1'.<br /> While for US addresses, use either the `5-digit` or `9-digit` ZIP Code in one of the following formats: '12345' or '12345-6789'.<br /> `Max length = 30`
country_code str The country in which the recipient's address is located. The value will be the two-character ISO Code of the country from the ISO country list. <br /> Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines. <br /> Below is the hyperlink, please select `Country codes` and then click `SEARCH` button. <br /> `Max length = 10`
company str The name of the company, in case if the recipient address is not residential. <br /> `Max length = 30`. [optional]
phone str This is Recipient's phone number. Enter the digits with or without spaces or hyphens. <br /> `Max length = 15`.
email str This must be recipient's valid email. Email is required if the customer is using GoFor Carrier. <br /> `Max length = 30` [optional]
residential bool The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'. [optional]
is_po_box bool Checks if the specified address has the PO Box. In case if Yes, the boolean value will be 'true', else it will take 'false'. [optional]

Example

from shipping.models.to_address_v2 import ToAddressV2

# TODO update the JSON string below
json = "{}"
# create an instance of ToAddressV2 from a JSON string
to_address_v2_instance = ToAddressV2.from_json(json)
# print the JSON string representation of the object
print(ToAddressV2.to_json())

# convert the object into a dict
to_address_v2_dict = to_address_v2_instance.to_dict()
# create an instance of ToAddressV2 from a dict
to_address_v2_from_dict = ToAddressV2.from_dict(to_address_v2_dict)

[Back to Model list] [Back to API list] [Back to README]