aress
POST /v1/sync_jobs

Create a sync job

Manually enqueue an order sync job.

Manually creates and enqueues a sync job for a specific order and source store. This is useful for re-processing orders or triggering syncs outside of the webhook pipeline.

The operation is idempotent — if a sync job already exists for the same external_order_id and source_store_id combination, the existing job is returned instead of creating a duplicate.

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

Body parameters

source_store_id string REQUIRED
external_order_id string REQUIRED

Numeric Shopify order ID

Responses

201

400

Validation failed

Request

curl -X POST https://api.example.com/v1/sync_jobs \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "source_store_id": "example_source_store_id",
  "external_order_id": "example_external_order_id"
}'

Response

201 201 Created
{
  "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"
}