Get sync job by id

GET

/v2/sync/jobs/{id}

curl --request GET \
  --url https://api.orderfast.com.ar/v2/sync/jobs/example \
  --header 'Authorization: Bearer <token>'

• Production
• Testing
• Local

Authorizations

• api-key

Parameters

Path Parameters

id

required

string

Responses

200

Successful response

Media typeapplication/json

object

data

required

object

job_id

required

string

type

required

string

Allowed values: products stock catalog

status

required

string

Allowed values: queued processing completed failed

mode

string

total_items

required

number

success_items

required

number

failed_items

required

number

errors

Array<object>

object

index

required

number

message

required

string

created_at

required

string

updated_at

required

string

completed_at

string

Examples

Examplesuccess

Successful response

{
  "data": {
    "job_id": "sync_123",
    "type": "products",
    "status": "completed",
    "mode": "upsert",
    "total_items": 10,
    "success_items": 9,
    "failed_items": 1,
    "errors": [
      {
        "index": 3,
        "message": "Product not found for external_id erp-x"
      }
    ],
    "created_at": "2026-07-07T12:00:00.000Z",
    "updated_at": "2026-07-07T12:00:05.000Z",
    "completed_at": "2026-07-07T12:00:05.000Z"
  }
}

401

Unauthorized — missing or invalid API key

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error

message

required

string

request_id

required

string

Examples

Exampleunauthorized

Invalid API key

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key",
    "request_id": "req_01J..."
  }
}

403

Permission denied

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error

message

required

string

request_id

required

string

Examples

Examplepermission_denied

Missing permission

{
  "error": {
    "code": "permission_denied",
    "message": "The API key does not have the required permission",
    "request_id": "req_01J..."
  }
}

404

Resource not found

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error

message

required

string

request_id

required

string

Examples

Exampleresource_not_found

Not found

{
  "error": {
    "code": "resource_not_found",
    "message": "Sync job not found",
    "request_id": "req_01J..."
  }
}

422

Validation error

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error

message

required

string

request_id

required

string

Examples

Examplevalidation_error

Invalid body or query

{
  "error": {
    "code": "validation_error",
    "message": "One or more fields failed validation",
    "request_id": "req_01J..."
  }
}

500

Internal server error

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error

message

required

string

request_id

required

string

Examples

Exampleinternal_error

Unexpected failure

{
  "error": {
    "code": "internal_error",
    "message": "An unexpected error occurred",
    "request_id": "req_01J..."
  }
}