Connect an integration
curl --request POST \
--url https://api.arcuserp.com/v1/integrations/{connector_type} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "<string>",
"config": {},
"shop": "<string>",
"ship_from_name": "<string>",
"ship_from_address1": "<string>",
"ship_from_city": "<string>",
"ship_from_state": "<string>",
"ship_from_zip": "<string>",
"seller_id": "<string>",
"bank_account_id": "<string>"
}
'import requests
url = "https://api.arcuserp.com/v1/integrations/{connector_type}"
payload = {
"display_name": "<string>",
"config": {},
"shop": "<string>",
"ship_from_name": "<string>",
"ship_from_address1": "<string>",
"ship_from_city": "<string>",
"ship_from_state": "<string>",
"ship_from_zip": "<string>",
"seller_id": "<string>",
"bank_account_id": "<string>"
}
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({
display_name: '<string>',
config: {},
shop: '<string>',
ship_from_name: '<string>',
ship_from_address1: '<string>',
ship_from_city: '<string>',
ship_from_state: '<string>',
ship_from_zip: '<string>',
seller_id: '<string>',
bank_account_id: '<string>'
})
};
fetch('https://api.arcuserp.com/v1/integrations/{connector_type}', 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/integrations/{connector_type}",
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([
'display_name' => '<string>',
'config' => [
],
'shop' => '<string>',
'ship_from_name' => '<string>',
'ship_from_address1' => '<string>',
'ship_from_city' => '<string>',
'ship_from_state' => '<string>',
'ship_from_zip' => '<string>',
'seller_id' => '<string>',
'bank_account_id' => '<string>'
]),
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/integrations/{connector_type}"
payload := strings.NewReader("{\n \"display_name\": \"<string>\",\n \"config\": {},\n \"shop\": \"<string>\",\n \"ship_from_name\": \"<string>\",\n \"ship_from_address1\": \"<string>\",\n \"ship_from_city\": \"<string>\",\n \"ship_from_state\": \"<string>\",\n \"ship_from_zip\": \"<string>\",\n \"seller_id\": \"<string>\",\n \"bank_account_id\": \"<string>\"\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/integrations/{connector_type}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"<string>\",\n \"config\": {},\n \"shop\": \"<string>\",\n \"ship_from_name\": \"<string>\",\n \"ship_from_address1\": \"<string>\",\n \"ship_from_city\": \"<string>\",\n \"ship_from_state\": \"<string>\",\n \"ship_from_zip\": \"<string>\",\n \"seller_id\": \"<string>\",\n \"bank_account_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/integrations/{connector_type}")
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 \"display_name\": \"<string>\",\n \"config\": {},\n \"shop\": \"<string>\",\n \"ship_from_name\": \"<string>\",\n \"ship_from_address1\": \"<string>\",\n \"ship_from_city\": \"<string>\",\n \"ship_from_state\": \"<string>\",\n \"ship_from_zip\": \"<string>\",\n \"seller_id\": \"<string>\",\n \"bank_account_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connector_type": "stripe",
"display_name": "<string>",
"mode": "sandbox",
"is_active": true,
"config": {},
"has_webhook_secret": true,
"has_credentials_secret_arn": true,
"last_sync_at": "2023-11-07T05:31:56Z",
"sync_status": "<string>",
"sync_error": "<string>",
"ship_from_name": "<string>",
"ship_from_address1": "<string>",
"ship_from_city": "<string>",
"ship_from_state": "<string>",
"ship_from_zip": "<string>",
"seller_id": "<string>",
"bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_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": "forbidden_field",
"code": "forbidden_field",
"param": "<string>",
"hint": "<string>"
}Integrations
Connect an integration
Configures and activates a connector for the entity, validating provider-specific settings such as a Shopify store URL or an AvaTax company code before saving; for Shopify, the response returns an OAuth URL to complete instead of activating immediately. Credentials are stored only in AWS Secrets Manager, never in the database; use the update operation if the connector already exists.
POST
/
integrations
/
{connector_type}
Connect an integration
curl --request POST \
--url https://api.arcuserp.com/v1/integrations/{connector_type} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "<string>",
"config": {},
"shop": "<string>",
"ship_from_name": "<string>",
"ship_from_address1": "<string>",
"ship_from_city": "<string>",
"ship_from_state": "<string>",
"ship_from_zip": "<string>",
"seller_id": "<string>",
"bank_account_id": "<string>"
}
'import requests
url = "https://api.arcuserp.com/v1/integrations/{connector_type}"
payload = {
"display_name": "<string>",
"config": {},
"shop": "<string>",
"ship_from_name": "<string>",
"ship_from_address1": "<string>",
"ship_from_city": "<string>",
"ship_from_state": "<string>",
"ship_from_zip": "<string>",
"seller_id": "<string>",
"bank_account_id": "<string>"
}
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({
display_name: '<string>',
config: {},
shop: '<string>',
ship_from_name: '<string>',
ship_from_address1: '<string>',
ship_from_city: '<string>',
ship_from_state: '<string>',
ship_from_zip: '<string>',
seller_id: '<string>',
bank_account_id: '<string>'
})
};
fetch('https://api.arcuserp.com/v1/integrations/{connector_type}', 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/integrations/{connector_type}",
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([
'display_name' => '<string>',
'config' => [
],
'shop' => '<string>',
'ship_from_name' => '<string>',
'ship_from_address1' => '<string>',
'ship_from_city' => '<string>',
'ship_from_state' => '<string>',
'ship_from_zip' => '<string>',
'seller_id' => '<string>',
'bank_account_id' => '<string>'
]),
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/integrations/{connector_type}"
payload := strings.NewReader("{\n \"display_name\": \"<string>\",\n \"config\": {},\n \"shop\": \"<string>\",\n \"ship_from_name\": \"<string>\",\n \"ship_from_address1\": \"<string>\",\n \"ship_from_city\": \"<string>\",\n \"ship_from_state\": \"<string>\",\n \"ship_from_zip\": \"<string>\",\n \"seller_id\": \"<string>\",\n \"bank_account_id\": \"<string>\"\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/integrations/{connector_type}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"<string>\",\n \"config\": {},\n \"shop\": \"<string>\",\n \"ship_from_name\": \"<string>\",\n \"ship_from_address1\": \"<string>\",\n \"ship_from_city\": \"<string>\",\n \"ship_from_state\": \"<string>\",\n \"ship_from_zip\": \"<string>\",\n \"seller_id\": \"<string>\",\n \"bank_account_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/integrations/{connector_type}")
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 \"display_name\": \"<string>\",\n \"config\": {},\n \"shop\": \"<string>\",\n \"ship_from_name\": \"<string>\",\n \"ship_from_address1\": \"<string>\",\n \"ship_from_city\": \"<string>\",\n \"ship_from_state\": \"<string>\",\n \"ship_from_zip\": \"<string>\",\n \"seller_id\": \"<string>\",\n \"bank_account_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connector_type": "stripe",
"display_name": "<string>",
"mode": "sandbox",
"is_active": true,
"config": {},
"has_webhook_secret": true,
"has_credentials_secret_arn": true,
"last_sync_at": "2023-11-07T05:31:56Z",
"sync_status": "<string>",
"sync_error": "<string>",
"ship_from_name": "<string>",
"ship_from_address1": "<string>",
"ship_from_city": "<string>",
"ship_from_state": "<string>",
"ship_from_zip": "<string>",
"seller_id": "<string>",
"bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_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": "forbidden_field",
"code": "forbidden_field",
"param": "<string>",
"hint": "<string>"
}Authorizations
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.
Headers
Client-generated unique key for idempotent POST/PATCH/DELETE operations. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours. Pattern: or --.
Maximum string length:
255Path Parameters
Connector type. Enum: stripe, avatax, shippo, printnode, postmark, shopify, mapquest, google, openai, plaid, ups, fedex, usps, amazon, ebay, wwex
Available options:
stripe, avatax, shippo, printnode, postmark, shopify, mapquest, google, openai, plaid, ups, fedex, usps, amazon, ebay, wwex Body
application/json
Config-only body for Mode A connectors (most connectors). Body may NOT contain: credentials, secret, api_key, access_token, refresh_token, webhook_secret, credentials_secret_arn (422 returned if present). entity_id MUST NOT be in the body (derived from API key; 422 if present).
Shopify (Mode B, OAuth): provide { shop: "mystore.myshopify.com", mode: "live" }. Response is 200 { object: "integration_oauth_required", oauth_url, expires_at }. Follow the oauth_url; poll GET /v1/integrations/shopify until is_active=true.
7-day deletion-recovery: re-POST within 7 days of DELETE silently restores the prior credential blob from Secrets Manager (per project_shopify_expiring_tokens_contract).
Available options:
sandbox, live Provider-specific configuration JSON
Shopify only: merchant myshopify.com domain (e.g. mystore.myshopify.com)
Amazon/eBay marketplace seller ID
Plaid: bank account UUID to link
Response
Config-only (Mode A): created connector row. Shopify/OAuth (Mode B): { object: "integration_oauth_required", oauth_url, expires_at, hint }.
- Option 1
- Option 2
A configured connector row from entity_connectors. SECURITY: credentials, webhook_secret, and credentials_secret_arn RAW VALUES are NEVER returned. has_credentials_secret_arn (boolean) indicates if credentials are stored. credentials_masked returns key names only (no values). These invariants are enforced by the canonical listConnectors/getConnectorByType handler projection and cannot be overridden by callers.
Available options:
stripe, avatax, shippo, printnode, postmark, shopify, mapquest, google, openai, plaid, ups, fedex, usps, amazon, ebay, wwex Available options:
sandbox, live Provider-specific configuration (opaque JSON)
True if a webhook signing secret is configured (value never returned)
True if credentials are stored in AWS Secrets Manager (ARN never returned)
Was this page helpful?