chore(docs): Updated API Reference (v2) (#9148)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-09-18 07:13:51 +00:00
committed by GitHub
parent a63f6910d0
commit 56ee4d6aad
254 changed files with 6349 additions and 5461 deletions

View File

@@ -1,5 +1,5 @@
type: object
description: The order's billing address.
description: An order address.
x-schemaName: AdminOrderAddress
required:
- id
@@ -7,66 +7,67 @@ required:
- created_at
- updated_at
properties:
country:
$ref: ./AdminRegionCountry.yaml
id:
type: string
title: id
description: The billing address's ID.
description: The address's ID.
customer_id:
type: string
title: customer_id
description: The billing address's customer id.
description: The ID of the customer this address belongs to.
first_name:
type: string
title: first_name
description: The billing address's first name.
description: The address's first name.
last_name:
type: string
title: last_name
description: The billing address's last name.
description: The address's last name.
phone:
type: string
title: phone
description: The billing address's phone.
description: The address's phone.
company:
type: string
title: company
description: The billing address's company.
description: The address's company.
address_1:
type: string
title: address_1
description: The billing address's address 1.
description: The address's first line.
address_2:
type: string
title: address_2
description: The billing address's address 2.
description: The address's second line.
city:
type: string
title: city
description: The billing address's city.
description: The address's city.
country_code:
type: string
title: country_code
description: The billing address's country code.
description: The address's country code.
example: us
country:
$ref: ./AdminRegionCountry.yaml
province:
type: string
title: province
description: The billing address's province.
description: The address's province.
postal_code:
type: string
title: postal_code
description: The billing address's postal code.
description: The address's postal code.
metadata:
type: object
description: The billing address's metadata.
description: The address's metadata, can hold custom key-value pairs.
created_at:
type: string
format: date-time
title: created_at
description: The billing address's created at.
description: The date the address was created.
updated_at:
type: string
format: date-time
title: updated_at
description: The billing address's updated at.
description: The date the address was updated.