ProductExport

Start Product Export

Queues a new product export job. Exports are processed asynchronously — the response body contains a token you use to poll for status and retrieve the download URL.

Request body (optional): Send a text/plain body containing a comma-separated list of field names to include in the export. If the body is omitted or empty, all available fields are exported.

Field name examples: id, sku, title, totalquantity, attr:size, attr:color

Output format: The exported file is tab-delimited.

Note: Do not send a JSON body to this endpoint — the Content-Type must be text/plain if a body is provided. Sending application/json will cause unexpected failures.

post/v1/ProductExport

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/ProductExport
  • Auth: OAuth 2 (authorization code, authorization URL https://api.channeladvisor.com/oauth2/authorize, token URL https://api.channeladvisor.com/oauth2/token; implicit, authorization URL https://api.channeladvisor.com/oauth2/authorize, scopes: orders, inventory) and HTTP bearer

Query parameters

$filterstring

OData-style filter expression to select which products to export (e.g. $filter=ProfileID eq 12345).

profileIdinteger

Optional profile ID. If omitted, uses the profile associated with the access token.

Response

Export job accepted. Response body contains the export token. Use GET /v1/ProductExport?token={token} to poll for status.

string required

Export token string.

Changes

No recorded changes to this operation across all 1 revision of this API.