Test a Shippo connection

POST /v1/integrations/shippo/test-connection

Test a Shippo connection

Check a Shippo API token and list the sales channels that fed the account in the last 30 days, without connecting anything. Step two of the guided connect.

Requires: integration.manage

Request Body

The Shippo API token

RequestBody

apiTokenrequired

string

Example Request

application/json

{
  "apiToken": "string"
}

Response Schema

Response

accountNamerequired

string

channelsrequired

object[]

recentOrdersrequired

number

Orders from it in the window the connect check read.

shopApprequired

string

Shippo's `shop_app` value, e.g. "Shopify".

testModerequired

boolean

Example Response

201 OK — application/json

{
  "accountName": "string",
  "testMode": true,
  "channels": [
    {
      "shopApp": "string",
      "recentOrders": 1
    }
  ]
}