Skip to content

Channels

Publish products and inspect their publication state by channel.

Fields

idstringUnique identifier of the resource.
statusenumdraft · publishing · active · failed · unpublished · suspended · syncError · needsAttention
pricenumber
stateenumpublished · sending · notPublished · needsData · withWarnings · error · pausedByChannel · pausedByStock · paused
listingTypeenumsalesChannel · source
externalUrlstring
compareAtPricenumber
syncInventoryboolean
See all 24 fields
lastSyncAtstring
lastSyncErrorstring
lastSyncErrorCodestring
readinessStatusenumunknown · ready · notReady
readinessIssuesarray<object>
publishableboolean
readinessUpdatedAtstring
createdOnstringTimestamp when the resource was created, in ISO 8601.
updatedOnstringTimestamp when the resource was last modified, in ISO 8601.
fieldOverridesarray<object>
issueobject
priceDiscountobject
channelIdstring
productIdstring
externalIdstring
sellerIdstring

Operations

Import & export

MethodEndpointOperation
POST/v1/channels/{channelId}/exportsQueue the spreadsheet of a channel's prices, stock and states
POST/v1/channels/{channelId}/importsReview or apply a channel spreadsheet

Listings

MethodEndpointOperation
POST/v1/channels/listingsCreate listing
GET/v1/channels/listingsList listings
GET/v1/channels/{channelId}/listingsList channel listings
GET/v1/channels/listings/{id}Get listing by ID
POST/v1/channels/listings/{id}/adopt-publicationLink existing publication
POST/v1/channels/listings/{id}/closeClose the publication in the channel and unlink it from the listing
POST/v1/channels/listings/{id}/primary-sourceMake a source the primary source of its product
POST/v1/channels/listings/{id}/publish-againPublish again after confirming that an uncertain creation is not in the channel
GET/v1/channels/{channelId}/listings/requirementsList listing requirements
GET/v1/channels/listings/{id}/remote-matchesSearch the channel account by SKU after an uncertain creation
GET/v1/channels/listings/{id}/requirementsGet the channel requirements for a listing
GET/v1/channels/listings/{id}/size-chartsList listing size charts
PUT/v1/channels/{channelId}/listings/requirementsSet listing requirements
PUT/v1/channels/{channelId}/listings/size-chartsChoose the channel size chart of many products
PUT/v1/channels/listings/{id}/overridesSet listing overrides
POST/v1/channels/{channelId}/listings/requirements/previewEvaluate unsaved channel requirements of products without saving or publishing
POST/v1/channels/{id}/listings/{listingId}/validateValidate listing
POST/v1/channels/listings/{id}/attempts/{attemptId}/reviewRecord a user's verification of an uncertain update or deletion in the provider
GET/v1/channels/listings/{id}/size-charts/{chartId}/rowsList size chart rows

Products

MethodEndpointOperation
GET/v1/channels/products/publicationsList product publications
GET/v1/channels/products/{productId}/publicationsList product publications
GET/v1/channels/{channelId}/products/{productId}/size-chartsList size charts for a product's draft category
GET/v1/channels/{channelId}/products/{productId}/size-charts/{chartId}/rowsList chart rows for a product's draft category

Publications

MethodEndpointOperation
POST/v1/channels/publicationsChange publications
GET/v1/channels/publicationsList publication status
POST/v1/channels/{channelId}/publications/previewPreview which products are ready to publish on a sales channel

Requirements

MethodEndpointOperation
POST/v1/channels/{channelId}/requirements/completePreview or complete one channel requirement for many listings
GET/v1/channels/{channelId}/requirements/summarySummarize what a channel still needs, by data

Variant Settings

MethodEndpointOperation
POST/v1/channels/{channelId}/variant-settingsFix or clear channel price and stock values for variants
GET/v1/channels/{channelId}/variant-settings/batchesList the batches of channel price and stock values
POST/v1/channels/{channelId}/variant-settings/batches/{batchId}/undoUndo a batch of channel price and stock values

Last updated: