Start a product export process to retrieve a CSV of exported products.You'll receive in the response the transaction ID of the workflow generating the CSV file. To check the status of the execution, send a GET request to /admin/workflows-executions/export-products/:transaction-id. Once the execution finishes successfully, a notification is created for the export. You can retrieve the notifications using the /admin/notification API route to retrieve the file's download URL.
Request Request Example
JavaScript
Shell
Java
Swift
curl--location-g--request POST '{{BASE_URL}}/admin/products/export'
Response Response Example
202 - Example 1
{"transaction_id":"string"}
Request
Authorization
or
or
or
Query Params
fields
stringÂ
fields
optional
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.
Responses
🟢202Accepted
application/json
OK
Body
The details of the product export.
transaction_id
stringÂ
transaction_id
required
The ID of the workflow execution's transaction. Use it to check the status of the export by sending a GET request to /admin/workflows-executions/export-products/:transaction-id