chore(docs): Generated API Reference (#3211)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
9997485c55
commit
14b2de94e2
@@ -2,45 +2,51 @@ title: Customer Group
|
||||
description: Represents a customer group
|
||||
type: object
|
||||
required:
|
||||
- created_at
|
||||
- deleted_at
|
||||
- id
|
||||
- metadata
|
||||
- name
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The customer group's ID
|
||||
type: string
|
||||
example: cgrp_01G8ZH853Y6TFXWPG5EYE81X63
|
||||
name:
|
||||
type: string
|
||||
description: The name of the customer group
|
||||
type: string
|
||||
example: VIP
|
||||
customers:
|
||||
type: array
|
||||
description: >-
|
||||
The customers that belong to the customer group. Available if the relation
|
||||
`customers` is expanded.
|
||||
items:
|
||||
type: object
|
||||
description: A customer object.
|
||||
price_lists:
|
||||
type: array
|
||||
items:
|
||||
$ref: ./Customer.yaml
|
||||
price_lists:
|
||||
description: >-
|
||||
The price lists that are associated with the customer group. Available if
|
||||
the relation `price_lists` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./PriceList.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was updated.
|
||||
type: string
|
||||
format: date-time
|
||||
deleted_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was deleted.
|
||||
nullable: true
|
||||
type: string
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
nullable: true
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
|
||||
Reference in New Issue
Block a user