Skip to content

Update the status of exporting to Shopify

Request

Update a ShopifyExportJob. Primarily used to stop a job.

Security
bearerToken
Path
idstringrequired

The unique ID of the ShopifyExportJob

Bodyapplication/jsonrequired
statusstring or nullrequired

The status of the job

Enum:"STARTED""STOPPED"
curl -i -X PATCH \
  'https://api-v2.dash.app/shopify-export-jobs/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "STARTED"
  }'

Responses

Success

Bodyapplication/json
resultanyrequired
permittedActionsArray of objectsrequired
Response
{
  "result": {
    "id": "be161977-d44e-4888-af3c-66522e223963",
    "accountId": "cfb665ca-ce35-4418-b9d5-70ee815db4bd",
    "creatorId": "google-oauth2|110955770826801837334",
    "type": "IN_PROGRESS",
    "progress": { … },
    "status": "PENDING"
  },
  "permittedActions": [
    { … }
  ]
}