Files
medusa-store/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts
Shahed Nasser 97daa5a41c docs: clarify ISO format for province codes (#12282)
* docs: clarify ISO format for province codes

* regenerate
2025-04-24 15:44:35 +03:00

81 lines
2.0 KiB
TypeScript

/**
* @schema BaseOrderAddress
* type: object
* description: An order address.
* x-schemaName: BaseOrderAddress
* required:
* - id
* - metadata
* - created_at
* - updated_at
* properties:
* id:
* type: string
* title: id
* description: The address's ID.
* customer_id:
* type: string
* title: customer_id
* description: The ID of the customer this address belongs to.
* 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.
* phone:
* type: string
* title: phone
* description: The address's phone.
* company:
* type: string
* title: company
* description: The address's company.
* 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 lower-case ISO 3166-2 province code.
* 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.
* metadata:
* type: object
* description: The address's metadata, can hold custom key-value pairs.
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The date the address was created.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The date the address was updated.
*
*/