Skip to content

DEVDOCS-5939 [update]: Channel listings, add usage note #312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bc-andreadao merged 6 commits into from
Jun 12, 2024
Merged

DEVDOCS-5939 [update]: Channel listings, add usage note #312

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d105002
add note
Jun 4, 2024
52a638a
abbreviation, preposition
bc-andreadao Jun 10, 2024
ba045bd
abbreviation
bc-andreadao Jun 10, 2024
097eb84
abbreviation
bc-andreadao Jun 10, 2024
5d9db57
abbreviation
bc-andreadao Jun 10, 2024
09209fa
Merge branch 'main' into DEVDOCS-5939-channel-listing
bc-andreadao Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions reference/channels.v3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ paths:
- Listings
summary: Get Channel Listings
operationId: getChannelListings
description: 'Returns a list of all *Channel Listings* for a specific channel. Note that if the *Channel* is not found or there is no listing associated to the *Channel*, it will return a 200 response with empty data.'
description: 'Returns a list of all *Channel Listings* for a specific channel. We recommend using this endpoint for non-storefront channels like marketplaces, marketing channels, and point of sale (POS) channels. Note that if the *Channel* is not found or there is no listing associated with the *Channel*, it will return a 200 response with empty data.'
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/after'
Expand All @@ -394,7 +394,7 @@ paths:
parameters:
- $ref: '#/components/parameters/ContentType'
operationId: createChannelListings
description: Creates one or more *Channel Listings* for a specific channel.
description: Creates one or more *Channel Listings* for a specific channel. We recommend using this endpoint for non-storefront channels like marketplaces, marketing channels, and point of sale (POS) channels.
requestBody:
content:
application/json:
Expand All @@ -419,7 +419,7 @@ paths:
- $ref: '#/components/parameters/ContentType'
operationId: updateChannelListings
description: |-
Updates one or more *Channel Listings* for a specific channel.
Updates one or more *Channel Listings* for a specific channel. We recommend using this endpoint for non-storefront channels like marketplaces, marketing channels, and point of sale (POS) channels.

> #### Note
> * Partial updates are supported. In most cases, if a field that *cannot* be updated is passed in, the API **will not** respond with an error. It returns a 200 response with the object, in which you will see the field(s) were not updated.
Expand Down Expand Up @@ -454,7 +454,7 @@ paths:
- Listings
summary: Get a Channel Listing
operationId: getChannelListing
description: Returns a *Channel Listing* for a specific channel.
description: Returns a *Channel Listing* for a specific channel. We recommend using this endpoint for non-storefront channels like marketplaces, marketing channels, and point of sale (POS) channels.
responses:
'200':
$ref: '#/components/responses/single_listing_resp'
Expand Down