87 lines
2.2 KiB
YAML
87 lines
2.2 KiB
YAML
type: object
|
|
description: The customer's details.
|
|
x-schemaName: AdminCustomer
|
|
required:
|
|
- has_account
|
|
- addresses
|
|
- id
|
|
- email
|
|
- default_billing_address_id
|
|
- default_shipping_address_id
|
|
- company_name
|
|
- first_name
|
|
- last_name
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: id
|
|
description: The customer's ID.
|
|
has_account:
|
|
type: boolean
|
|
title: has_account
|
|
description: Whether the customer is registered.
|
|
groups:
|
|
type: array
|
|
description: The customer's groups.
|
|
items:
|
|
$ref: ./AdminCustomerGroup.yaml
|
|
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: ./AdminCustomerAddress.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.
|
|
externalDocs:
|
|
url: https://docs.medusajs.com/api/admin#manage-metadata
|
|
description: Learn how to manage metadata
|
|
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.
|