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:
committed by
GitHub
parent
a63f6910d0
commit
56ee4d6aad
@@ -0,0 +1,73 @@
|
||||
type: object
|
||||
description: The customer's details.
|
||||
x-schemaName: BaseCustomer
|
||||
required:
|
||||
- id
|
||||
- email
|
||||
- default_billing_address_id
|
||||
- default_shipping_address_id
|
||||
- company_name
|
||||
- first_name
|
||||
- last_name
|
||||
- addresses
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The customer's ID.
|
||||
email:
|
||||
type: string
|
||||
title: email
|
||||
description: The customer's email.
|
||||
format: email
|
||||
default_billing_address_id:
|
||||
type: string
|
||||
title: default_billing_address_id
|
||||
description: The ID of the address used as the default billing address.
|
||||
default_shipping_address_id:
|
||||
type: string
|
||||
title: default_shipping_address_id
|
||||
description: The ID of the address used as the default shipping address.
|
||||
company_name:
|
||||
type: string
|
||||
title: company_name
|
||||
description: The customer's company name.
|
||||
first_name:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The customer's first name.
|
||||
last_name:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The customer's last name.
|
||||
addresses:
|
||||
type: array
|
||||
description: The customer's addresses.
|
||||
items:
|
||||
$ref: ./BaseCustomerAddress.yaml
|
||||
phone:
|
||||
type: string
|
||||
title: phone
|
||||
description: The customer's phone.
|
||||
metadata:
|
||||
type: object
|
||||
description: The customer's metadata, used to store custom key-value pairs.
|
||||
created_by:
|
||||
type: string
|
||||
title: created_by
|
||||
description: The ID of the user that created this customer, if available.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The customer's creation date.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The customer's update date.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The customer's deletion date.
|
||||
Reference in New Issue
Block a user