Skip to main content

Test Connection

POST 
/api/shippit/test

Validates a Shippit API key without saving a connection. Shippit is a courier aggregator; this probes the supplied key against Shippit's merchant endpoint and returns the merchant profile it resolves to, so you can confirm the key is correct before creating an instance.

Not yet available to API tokens

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

Body fields:

  • api_key (string, required): the Shippit API key to validate. Minimum 8 characters.
  • environment (string, optional): which Shippit environment the key belongs to, either "production" or "sandbox". Defaults to "production".

Returns 200 with the resolved merchant name and company/contact details when the key is accepted. Returns 422 with a "code" of "invalid_key" when Shippit rejects the key, or "api_error" when Shippit could not be reached. Returns 422 with field errors when the request body itself is invalid.

Authentication: Requires a Bearer token.

Requires the integrations.create permission.

Request​

Responses​

OK

Response Headers
    Content-Type