658339767b
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
59 lines
1.7 KiB
YAML
59 lines
1.7 KiB
YAML
get:
|
|
operationId: GetPublishableApiKeySalesChannels
|
|
summary: List Sales Channels
|
|
description: >-
|
|
List the sales channels associated with a publishable API key. The sales
|
|
channels can be filtered by fields such as `q`.
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
description: The ID of the publishable API key.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: q
|
|
description: query to search sales channels' names and descriptions.
|
|
schema:
|
|
type: string
|
|
x-codegen:
|
|
method: listSalesChannels
|
|
queryParams: GetPublishableApiKeySalesChannelsParams
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: >-
|
|
../code_samples/JavaScript/admin_publishable-api-keys_{id}_sales-channels/get.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: >-
|
|
../code_samples/Shell/admin_publishable-api-keys_{id}_sales-channels/get.sh
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Publishable Api Keys
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: >-
|
|
../components/schemas/AdminPublishableApiKeysListSalesChannelsRes.yaml
|
|
'400':
|
|
$ref: ../components/responses/400_error.yaml
|
|
'401':
|
|
$ref: ../components/responses/unauthorized.yaml
|
|
'404':
|
|
$ref: ../components/responses/not_found_error.yaml
|
|
'409':
|
|
$ref: ../components/responses/invalid_state_error.yaml
|
|
'422':
|
|
$ref: ../components/responses/invalid_request_error.yaml
|
|
'500':
|
|
$ref: ../components/responses/500_error.yaml
|