Skip to content

Overview

REST API v1. Every request authenticates with an app’s access token (Authorization: Bearer). Errors are RFC 9457 problems (application/problem+json). Clients must ignore fields they do not know.

Information

  • OpenAPI version: 3.1.2

An app installed by a merchant. A public app: OAuth 2.0 authorization code, PKCE (S256) required. A private app (one organization’s own): client credentials, its token standing for its installation there, narrowed by scope when asked (none asked: every scope the installation holds).

Security scheme type: oauth2

Flow type: clientCredentials

Token URL: https://connectato.com/oauth/token

Scopes:

  • read_integrations - Read integrations
  • read_invoices - Read invoices
  • write_invoices - Issue invoices
  • read_orders - Read orders
  • write_orders - Send orders as a store
  • read_shipments - Read AWBs
  • write_shipments - Create and cancel AWBs

Flow type: authorizationCode

Authorization URL: https://connectato.com/oauth/authorize

Token URL: https://connectato.com/oauth/token

Refresh URL: https://connectato.com/oauth/token

Scopes:

  • read_integrations - Read integrations
  • read_invoices - Read invoices
  • write_invoices - Issue invoices
  • read_orders - Read orders
  • write_orders - Send orders as a store
  • read_shipments - Read AWBs
  • write_shipments - Create and cancel AWBs

An access token taken with either OAuth flow (a private app’s client credentials, a public app’s authorization code), sent as Authorization: Bearer <token>. The client secret never goes in a browser.

Security scheme type: http