Skip to main content
POST
/
integrations
/
{connector_type}
Create or initiate a connector connection
curl --request POST \
  --url https://api.arcuserp.com/v1/integrations/{connector_type} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "sandbox",
  "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>"
}
'
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Headers

​
Idempotency-Key
string

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: 255

Path Parameters

​
connector_type
enum<string>
required

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

​
mode
enum<string>
Available options:
sandbox,
live
​
display_name
string
​
config
object

Provider-specific configuration JSON

​
shop
string

Shopify only: merchant myshopify.com domain (e.g. mystore.myshopify.com)

​
ship_from_name
string
​
ship_from_address1
string
​
ship_from_city
string
​
ship_from_state
string
​
ship_from_zip
string
​
seller_id
string

Amazon/eBay marketplace seller ID

​
bank_account_id
string

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 }.

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.

​
id
string<uuid>
​
entity_id
string<uuid>
​
connector_type
enum<string>
Available options:
stripe,
avatax,
shippo,
printnode,
postmark,
shopify,
mapquest,
google,
openai,
plaid,
ups,
fedex,
usps,
amazon,
ebay,
wwex
​
display_name
string
​
mode
enum<string>
Available options:
sandbox,
live
​
is_active
boolean
​
config
object

Provider-specific configuration (opaque JSON)

​
has_webhook_secret
boolean

True if a webhook signing secret is configured (value never returned)

​
has_credentials_secret_arn
boolean

True if credentials are stored in AWS Secrets Manager (ARN never returned)

​
last_sync_at
string<date-time> | null
​
sync_status
string | null
​
sync_error
string | null
​
ship_from_name
string | null
​
ship_from_address1
string | null
​
ship_from_city
string | null
​
ship_from_state
string | null
​
ship_from_zip
string | null
​
seller_id
string | null
​
bank_account_id
string<uuid> | null
​
created_at
string<date-time>
​
updated_at
string<date-time>