List IOSS registrations

List active IOSS registrations belonging to the authenticated account, including registrations added in the OMS web portal. Requires shipments:read. Returns at most 10 active records and default_ioss_number; this endpoint does not change the account default. filing.status and filing.filed describe the last confirmed carrier result, not the latest attempt. Only filing.status equal to approved confirms approval. A later failed retry does not erase that approval or change a confirmed filing.filed value to false. Read the separate optional filing.last_attempt_status (in_progress, succeeded, failed or null) for the latest attempt; succeeded does not itself mean approval. A latest failure carries filing.error_code equal to IOSS_FILING_FAILED and optional nullable filing.carrier_error_code and filing.carrier_error_message. The code is an 8–10 digit string with leading zeroes preserved; the message is fixed safe text for known codes or a generic explanation, never the original provider response. These are recorded results, not a fresh carrier status query. Test keys list only their separate simulated registrations and return a null default. Live registrations and the live account default are not copied into this sandbox registry; register separately with POST /v1/ioss before using an explicit ioss_number in test-mode quotes or shipment creation.

Parameters

No parameters.

Responses

{
  "status": 200,
  "message": "OK",
  "data": {
    "data": [
      {
        "ioss_number": "IM1234567890",
        "label": "Own IOSS",
        "type": "own",
        "registration": {
          "company": "Example Trading Ltd",
          "country_code": "DE",
          "street": "Example Street 1",
          "city": "Berlin",
          "postal_code": "10115",
          "email": "customs@example.com"
        },
        "platform_name": null,
        "is_default": false,
        "status": "active",
        "livemode": false,
        "filing": {
          "status": "simulated",
          "filed": false,
          "simulated": true,
          "error_code": null,
          "carrier_error_code": null,
          "carrier_error_message": null,
          "last_attempt_status": null,
          "filed_at": null,
          "last_attempt_at": null
        },
        "created_at": "2026-11-03T08:00:00.000Z",
        "updated_at": "2026-11-03T08:00:00.000Z"
      }
    ],
    "default_ioss_number": null
  }
}

Returned object