Skip to main content
POST
/
entities
/
{entity_id}
/
migration
/
cutover
/
freeze
Freeze entity for migration cutover
curl --request POST \
  --url https://api.arcuserp.com/v1/entities/{entity_id}/migration/cutover/freeze \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "WSS cutover Sat 7/12"
}
'
import requests

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

payload = { "reason": "WSS cutover Sat 7/12" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: 'WSS cutover Sat 7/12'})
};

fetch('https://api.arcuserp.com/v1/entities/{entity_id}/migration/cutover/freeze', 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/cutover/freeze",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'reason' => 'WSS cutover Sat 7/12'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

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

payload := strings.NewReader("{\n \"reason\": \"WSS cutover Sat 7/12\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/entities/{entity_id}/migration/cutover/freeze")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"WSS cutover Sat 7/12\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"WSS cutover Sat 7/12\"\n}"

response = http.request(request)
puts response.read_body
{
  "object": "entity_freeze_status",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "frozen": true,
  "freeze_token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "frozen_at": "2023-11-07T05:31:56Z",
  "frozen_by": {
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "reason": "<string>",
  "idempotent": true,
  "unfrozen_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"
}

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

Body

application/json
reason
string

Human-readable reason for the freeze (shown in audit log).

Example:

"WSS cutover Sat 7/12"

Response

Entity frozen (or already frozen)

Current freeze state of an entity.

object
enum<string>
Available options:
entity_freeze_status
entity_id
string<uuid>
frozen
boolean
freeze_token
string<uuid> | null

Present when frozen=true. Supply as X-Freeze-Token for migration:write bypass.

frozen_at
string<date-time> | null
frozen_by
object | null
reason
string | null
idempotent
boolean

True if entity was already frozen (idempotent re-call).

unfrozen_at
string<date-time> | null

Present in unfreeze response only.