Test Odoo 3PL Connection (Unsaved Credentials)

POST 
/api/odoo-3pl/test-connection

Checks a base URL and API key against Odoo 3PL (ShipPro) before you create an instance. Nothing is saved.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Body:

• base_url — string, required. HTTPS URL ending in /api/v1/3pl (production https://ship-prosolutions.com/api/v1/3pl; a test. host is the sandbox).
• api_key — string, required. Must start with 3pl_. Keys are environment-specific — a sandbox key does not work against production.

A successful check returns connected: true with the Odoo 3PL customer name and ID. A failed check returns 422 with connected: false and an error explaining why (for example an invalid or revoked key, or an IP that is not allowed).

Requires the integrations.create permission.

Authentication: Bearer token (Personal Access Token).

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden

Response Headers

Content-Type

422

Unprocessable Entity

Response Headers

Content-Type

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.