aress
POST /v1/sync_jobs/{id}/retry

Retry a sync job

Retry a failed or dead sync job.

Retries a sync job that has a status of failed or dead. The job’s status is reset to pending, error fields are cleared, and it is re-enqueued for processing.

Jobs with other statuses (e.g. pending, processing, completed) cannot be retried and will return a 400 error with code sync_job_not_retryable.

An audit log entry (sync_job.retried) is written automatically.

Path parameters

id string REQUIRED

Responses

200

404

Request

curl https://api.example.com/v1/sync_jobs/:id/retry \
  -H "Authorization: Bearer sk_test_..."

Response

200 200 OK
{
  "id": "example_id",
  "resellerStoreId": "example_resellerStoreId",
  "sourceStoreId": "example_sourceStoreId",
  "status": "pending",
  "attempts": 0,
  "externalOrderId": "example_externalOrderId",
  "sourceOrderId": "example_sourceOrderId",
  "errorMessage": "example_errorMessage",
  "completedAt": "example_completedAt",
  "failedAt": "example_failedAt",
  "deadAt": "example_deadAt",
  "createdAt": "example_createdAt",
  "updatedAt": "example_updatedAt",
  "request_id": "example_request_id"
}