daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2.8 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AddressPayload
internal.AddressPayload
Schema
AddressPayload type: object description: "Address fields used when creating/updating an address." properties: first_name: description: First name type: string example: Arno last_name: description: Last name type: string example: Willms phone: type: string description: Phone Number example: 16128234334802 company: type: string address_1: description: Address line 1 type: string example: 14433 Kemmer Court address_2: description: Address line 2 type: string example: Suite 369 city: description: City type: string example: South Geoffreyview country_code: description: The 2 character ISO code of the country in lower case type: string 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: description: Province type: string example: Kentucky postal_code: description: Postal Code type: string example: 72093 metadata: type: object example: {car: "white"} description: An optional key-value map with additional details
Hierarchy
-
AddressPayload
Properties
address_1
• Optional address_1: string
Defined in
packages/medusa/dist/types/common.d.ts:160
address_2
• Optional address_2: string
Defined in
packages/medusa/dist/types/common.d.ts:161
city
• Optional city: string
Defined in
packages/medusa/dist/types/common.d.ts:162
company
• Optional company: string
Defined in
packages/medusa/dist/types/common.d.ts:159
country_code
• Optional country_code: string
Defined in
packages/medusa/dist/types/common.d.ts:163
first_name
• Optional first_name: string
Defined in
packages/medusa/dist/types/common.d.ts:155
last_name
• Optional last_name: string
Defined in
packages/medusa/dist/types/common.d.ts:156
metadata
• Optional metadata: Record<string, unknown>
Defined in
packages/medusa/dist/types/common.d.ts:158
phone
• Optional phone: string
Defined in
packages/medusa/dist/types/common.d.ts:157
postal_code
• Optional postal_code: string
Defined in
packages/medusa/dist/types/common.d.ts:165
province
• Optional province: string
Defined in
packages/medusa/dist/types/common.d.ts:164