Skip to main content
GET
/
entities
/
{entity_id}
/
migration
/
jobs
/
{job_id}
Get a single migration job by ID
curl --request GET \
  --url https://api.arcuserp.com/v1/entities/{entity_id}/migration/jobs/{job_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.arcuserp.com/v1/entities/{entity_id}/migration/jobs/{job_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/entities/{entity_id}/migration/jobs/{job_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcuserp.com/v1/entities/{entity_id}/migration/jobs/{job_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.arcuserp.com/v1/entities/{entity_id}/migration/jobs/{job_id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/entities/{entity_id}/migration/jobs/{job_id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/entities/{entity_id}/migration/jobs/{job_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "migration_job",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource": "<string>",
  "dry_run": true,
  "conflict_mode": "skip",
  "external_source": "<string>",
  "total_records": 123,
  "processed_records": 123,
  "succeeded_records": 123,
  "failed_records": 123,
  "errors": [
    {
      "index": 123,
      "external_id": "<string>",
      "error": "<string>",
      "code": "<string>"
    }
  ],
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

entity_id
string<uuid>
required
job_id
string<uuid>
required

Response

Migration job

Async bulk import job status record

id
string<uuid>
object
enum<string>
Available options:
migration_job
entity_id
string<uuid>
resource
string

Resource type (accounts, products, orders, journal-entries, vendor-bills, ap-payments, product-categories, product-variants, product-pricing-policies, product-vendors, product-prepackaged-presets, customer-payments, inventory-balances-opening-stock, inventory-balances-set-opening-stock, inventory-transactions, inventory-movements, order-tax-lines, account-addresses, account-contacts, purchase-orders, returns, vendor-credits)

status
enum<string>
Available options:
pending,
running,
completed,
failed,
partial
dry_run
boolean
conflict_mode
enum<string>
default:skip

How to handle a record whose (external_source, external_id) already exists in Arcus.

  • skip: leave the existing record unchanged, count as success
  • update: call the canonical UPDATE handler with the incoming payload
  • replace: NULL out the existing record's provenance UNIQUE, then INSERT new record
  • error: abort the entire batch on the first collision (default if not specified: skip)
Available options:
skip,
update,
replace,
error
external_source
string

Source system identifier (e.g. "versa", "shopify", "quickbooks")

total_records
integer
processed_records
integer
succeeded_records
integer
failed_records
integer
errors
object[]
started_at
string<date-time> | null
completed_at
string<date-time> | null
created_at
string<date-time>