chore(docs): Generated API Reference (#3262)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
co-authored by
olivermrbl
parent
67f9429293
commit
4fb22e8ba5
@@ -2,11 +2,17 @@ title: Sales Channel
|
||||
description: A Sales Channel
|
||||
type: object
|
||||
required:
|
||||
- created_at
|
||||
- deleted_at
|
||||
- description
|
||||
- id
|
||||
- is_disabled
|
||||
- name
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The sales channel's ID
|
||||
type: string
|
||||
example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A
|
||||
name:
|
||||
description: The name of the sales channel.
|
||||
@@ -14,21 +20,30 @@ properties:
|
||||
example: Market
|
||||
description:
|
||||
description: The description of the sales channel.
|
||||
nullable: true
|
||||
type: string
|
||||
example: Multi-vendor market
|
||||
is_disabled:
|
||||
description: Specify if the sales channel is enabled or disabled.
|
||||
type: boolean
|
||||
default: false
|
||||
locations:
|
||||
description: >-
|
||||
The Stock Locations related to the sales channel. Available if the
|
||||
relation `locations` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./SalesChannelLocation.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
|
||||
|
||||
Reference in New Issue
Block a user