Skip to main content

CustomerAddressModel

Customer address.

Breaking Changes​

No breaking changes.

Examples​

Fill this template out with real values.

{
"country": "String",
"id": "Integer",
"is_active": "Boolean",
"is_billing": "Boolean",
"is_physical": "Boolean",
"is_shipping": "Boolean",
"latitude": "Float",
"line_1": "String",
"line_2": "String",
"line_3": "String",
"line_4": "String",
"locality": "String",
"longitude": "Float",
"postcode": "String",
"region": "String"
}

Fields​

country String, Required

Country code (ISO 3166-1 alpha 2).

  • 2 character country code.

id Integer, Required

Customer address identifier.

is_active Boolean, Required

Records marked inactive are treated as deleted (soft delete).

  • One of 0, 1, True, False (case insensitive).

is_billing Boolean, Required

If true, this is the customer's billing address.

  • One of 0, 1, True, False (case insensitive).

is_physical Boolean, Required

Physical address if true.

  • One of 0, 1, True, False (case insensitive).

is_shipping Boolean, Required

Customer's shipping address if true.

  • One of 0, 1, True, False (case insensitive).

latitude Float, Required

Latitude.

  • Less than or equal to 90.
  • Greater than or equal to -90.

line_1 String, Required

Street address.

  • At least 1 and no more than 256 characters.

line_2 String, Required

Street address line 2.

  • At least 0 and no more than 256 characters.

line_3 String, Required

Street address line 3.

  • At least 0 and no more than 256 characters.

line_4 String, Required

Street address line 4 (doubles as county).

  • At least 0 and no more than 256 characters.

locality String, Required

Address locality (e.g. city).

  • At least 1 and no more than 86 characters.

longitude Float, Required

longitude.

  • Less than or equal to 180.
  • Greater than or equal to -180.

postcode String, Required

Postal code (may include letters and symbols).

  • At least 1 and no more than 86 characters.

region String, Required

Address region (e.g. state).

  • At least 1 and no more than 32 characters.