93 lines
2.3 KiB
YAML
93 lines
2.3 KiB
YAML
delete:
|
|
operationId: DeleteSalesChannelsSalesChannel
|
|
summary: Delete a sales channel
|
|
description: Deletes the sales channel.
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
description: The ID of the Sales channel.
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- Sales Channel
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the deleted sales channel
|
|
object:
|
|
type: string
|
|
description: The type of the object that was deleted.
|
|
default: sales-channel
|
|
deleted:
|
|
type: boolean
|
|
description: Whether or not the items were deleted.
|
|
default: true
|
|
get:
|
|
operationId: GetSalesChannelsSalesChannel
|
|
summary: Retrieve a sales channel
|
|
description: Retrieves the sales channel.
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
description: The ID of the Sales channel.
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- Sales Channel
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
sales_channel:
|
|
$ref: ../components/schemas/sales_channel.yaml
|
|
post:
|
|
operationId: PostSalesChannelsSalesChannel
|
|
summary: Update a Sales Channel
|
|
description: Updates a Sales Channel.
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
description: The ID of the Sales Channel.
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: Name of the sales channel.
|
|
description:
|
|
type: string
|
|
description: Sales Channel description.
|
|
is_disabled:
|
|
type: boolean
|
|
description: Indication of if the sales channel is active.
|
|
tags:
|
|
- Sales Channel
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
sales_channel:
|
|
$ref: ../components/schemas/sales_channel.yaml
|