List async migration jobs for this entity

curl --request GET \
  --url https://api.arcuserp.com/v1/entities/{entity_id}/migration/jobs \
  --header 'Authorization: Bearer <token>'

import requests

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

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', 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",
  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"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "object": "list",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "migration_job",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource": "<string>",
      "status": "pending",
      "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"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

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

GET

entities

{entity_id}

migration

jobs

List async migration jobs for this entity

curl --request GET \
  --url https://api.arcuserp.com/v1/entities/{entity_id}/migration/jobs \
  --header 'Authorization: Bearer <token>'

import requests

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

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', 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",
  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"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "object": "list",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "migration_job",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource": "<string>",
      "status": "pending",
      "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"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

{
  "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

Query Parameters

resource

enum<string>

Available options:

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

created_after

string<date-time>

Return jobs created after this ISO 8601 timestamp

limit

integer

default:20

Required range: 1 <= x <= 100

starting_after

string<uuid>

Cursor for pagination (job_id of last record from previous page)

Response

Paginated list of migration jobs

object

enum<string>

Available options:

list

data

object[]

Show child attributes

has_more

boolean

next_cursor

string | null

Overview

All Endpoints

List async migration jobs for this entity

Authorizations

Path Parameters

Query Parameters

Response