57 lines
1.4 KiB
YAML
57 lines
1.4 KiB
YAML
type: object
|
|
description: The address to create.
|
|
x-schemaName: CreateAddress
|
|
properties:
|
|
customer_id:
|
|
type: string
|
|
title: customer_id
|
|
description: The ID of the customer this address belongs to.
|
|
company:
|
|
type: string
|
|
title: company
|
|
description: The address's company.
|
|
first_name:
|
|
type: string
|
|
title: first_name
|
|
description: The address's first name.
|
|
last_name:
|
|
type: string
|
|
title: last_name
|
|
description: The address's last name.
|
|
address_1:
|
|
type: string
|
|
title: address_1
|
|
description: The address's first line.
|
|
address_2:
|
|
type: string
|
|
title: address_2
|
|
description: The address's second line.
|
|
city:
|
|
type: string
|
|
title: city
|
|
description: The address's city.
|
|
country_code:
|
|
type: string
|
|
title: country_code
|
|
description: The address's country code.
|
|
example: us
|
|
province:
|
|
type: string
|
|
title: province
|
|
description: The address's ISO 3166-2 province code. Must be lower-case.
|
|
example: us-ca
|
|
externalDocs:
|
|
url: https://en.wikipedia.org/wiki/ISO_3166-2
|
|
description: Learn more about ISO 3166-2
|
|
postal_code:
|
|
type: string
|
|
title: postal_code
|
|
description: The address's postal code.
|
|
phone:
|
|
type: string
|
|
title: phone
|
|
description: The address's phone.
|
|
metadata:
|
|
type: object
|
|
description: The address's metadata, can hold custom key-value pairs.
|