SAsalsify

Start Export Run

post/{org_id}/export_runs

Request

  • Base URL
    https://app.salsify.com/api/orgs
  • URL
    https://app.salsify.com/api/orgs/{org_id}/export_runs
  • Auth
    none required

Path parameters

org_idstring required

The Salsify organization's unique identifier. Visit your Salsify organization and pull from the URL path, immediately following /orgs/

Request body

entity_typestring required

Defines the type of entity you want to export. Allowed Values: all product digital_asset attribute attribute_value

formatstring

Format file is output in. If not specified, default format for all entity_types is xlsx. Note that for entity_type all, the only valid output formats are json and jsonl. Allowed Values: json jsonl csv xlsx

compressboolean

If true is specified, returns a compressed file in gzip format. (.gz)

include_all_columnsboolean

Returns all content properties for product entities, or all custom metadata stored with digital asset entities. Default is true. Use properties to define the scope for false.

include_all_content_localesboolean

If true, the export run will include data for every content locale; otherwise it will include data for the channel's content locale

propertiesstring

For exports where include_all_columns is false, specify property IDs for properties to be included in the export and formatted as a single value of single quote and comma-separated values. ie. "'Property ID 1','Property ID 2',Property ID 3'"

filterstring

Limit the scope of entities included in export file based on filter specifications. Details on how to build filters are available here

sort_orderstring

Sorts results in either ascending or descending order by. Allowed Values: asc desc

Response

201

Changes

No recorded changes to this operation across all 2 revisions of this API.