54 lines
1.2 KiB
YAML
54 lines
1.2 KiB
YAML
title: Address Fields
|
|
description: Address fields used when creating/updating an address.
|
|
x-resourceId: address
|
|
properties:
|
|
company:
|
|
type: string
|
|
description: Company name
|
|
example: Acme
|
|
first_name:
|
|
type: string
|
|
description: First name
|
|
example: Arno
|
|
last_name:
|
|
type: string
|
|
description: Last name
|
|
example: Willms
|
|
address_1:
|
|
type: string
|
|
description: Address line 1
|
|
example: 14433 Kemmer Court
|
|
address_2:
|
|
type: string
|
|
description: Address line 2
|
|
example: Suite 369
|
|
city:
|
|
type: string
|
|
description: City
|
|
example: South Geoffreyview
|
|
country_code:
|
|
type: string
|
|
description: The 2 character ISO code of the country in lower case
|
|
externalDocs:
|
|
url: >-
|
|
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
|
|
description: See a list of codes.
|
|
example: st
|
|
province:
|
|
type: string
|
|
description: Province
|
|
example: Kentucky
|
|
postal_code:
|
|
type: string
|
|
description: Postal Code
|
|
example: 72093
|
|
phone:
|
|
type: string
|
|
description: Phone Number
|
|
example: 16128234334802
|
|
metadata:
|
|
type: object
|
|
description: An optional key-value map with additional details
|
|
example:
|
|
car: white
|