v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Exports

Cancel Export

Cancels an export, setting its status to cancelled. An export that has already completed cannot be cancelled; an already-cancelled export is returned unchanged.

post/v1/exports/{id}/cancel

Path parameters

idstring required
Example:fxprt_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Response

An envelope wrapping a single export object.

Example response

{
  "export": {
    "export_id": "fxprt_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "description": "Premium SPF 50 mineral sunscreen",
    "type": "product",
    "status": "created",
    "created_at": "2026-06-15T14:30:00Z",
    "started_at": "2026-06-15T14:30:00Z",
    "completed_at": "2026-06-15T14:30:00Z",
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "test_mode": false
  }
}