Legacy Migration

Legacy Migration

Endpoints

IntroductionPOST/legacy-migration/authPOST/legacy-migration/jobsGET/legacy-migration/jobsGET/legacy-migration/organizations/{legacyOrgId}GET/legacy-migration/jobs/{id}

The Legacy Migration object

object

Attributes

idstring

Legacy organization ID

Other attributesExpand all

namestring

countrystringnullable

tax_numberstringnullable

created_atstring

already_migratedboolean

migrated_environmentstringnullable

unsupportedarray of objectsShow child attributes

requires_confirmationboolean

subscription_reviewobjectnullableShow child attributes

Examplejson

Copy

{
  "id": "legacy_org_abc123",
  "name": "Nebula Systems GmbH",
  "country": "DE",
  "tax_number": "DE112233445",
  "created_at": "2020-05-15T10:00:00.000Z",
  "already_migrated": false,
  "migrated_environment": null,
  "unsupported": [
    {
      "code": "sales_integrations",
      "label": "Sales integrations",
      "description": "Reconnect compatible stores after migration.",
      "count": 1,
      "collections": [
        "Woocommerce"
      ]
    }
  ],
  "requires_confirmation": true,
  "subscription_review": null
}

---

Authenticate with legacy API

POST/legacy-migration/auth

Authenticate with legacy Space Invoices credentials and get a list of owned organizations.

Request

Header parameters

account_idstringoptional

Account Id on which the request is made. Optional if user is part of only one account.

Body parameters

emailstring<email>required

Email for legacy Space Invoices account

passwordstringrequired

Password for legacy Space Invoices account

cURLNode.js SDKFetchPythonGoRubyPHP

Copy

import SpaceInvoices from '@spaceinvoices/js-sdk/sdk';

const sdk = new SpaceInvoices('YOUR_API_KEY');

const response = await sdk.legacyMigration.legacyMigrationAuth({
  email: "user@example.com",
  password: "legacy-account-password"
}, {
  account_id: "YOUR_ACCOUNT_ID"
});

console.log(response);

Response

Returns

organizationsarray of objectsShow child attributes

legacy_session_idstring

json

Copy

{
  "organizations": [
    {
      "id": "legacy_org_abc123",
      "name": "Nebula Systems GmbH",
      "country": "DE",
      "tax_number": "DE112233445",
      "created_at": "2020-05-15T10:00:00.000Z",
      "already_migrated": false,
      "migrated_environment": null
    }
  ],
  "legacy_session_id": "lm_session_abc123"
}

---

Create migration job

POST/legacy-migration/jobs

Create a new legacy migration job. Portuguese businesses cannot be migrated, including to sandbox.

Request

Header parameters

account_idstringoptional

Account Id on which the request is made. Optional if user is part of only one account.

Body parameters

legacy_org_idstringrequired

Legacy organization ID to migrate

legacy_session_idstringrequired

Temporary legacy session ID created after legacy authentication

environmentstringrequired

Target environment

Possible values: "live", "sandbox"

Other parametersExpand all

confirm_unsupported_databooleanoptional

cURLNode.js SDKFetchPythonGoRubyPHP

Copy

import SpaceInvoices from '@spaceinvoices/js-sdk/sdk';

const sdk = new SpaceInvoices('YOUR_API_KEY');

const response = await sdk.legacyMigration.create({
  legacy_org_id: "legacy_org_abc123",
  legacy_session_id: "lm_session_abc123",
  environment: "sandbox"
}, {
  account_id: "YOUR_ACCOUNT_ID"
});

console.log(response);

Example:

Start sandbox migrationConfirm unsupported data

Response

Returns

idstring

Job ID

Other parametersExpand all

statusstring

messagestring

json

Copy

{
  "id": "mig_507f1f77bcf86cd799439011",
  "status": "pending",
  "message": "Migration job created. It will be processed shortly."
}

---

List migration jobs

GET/legacy-migration/jobs

List all migration jobs for the current account.

Request

Header parameters

account_idstringoptional

Account Id on which the request is made. Optional if user is part of only one account.

cURLNode.js SDKFetchPythonGoRubyPHP

Copy

import SpaceInvoices from '@spaceinvoices/js-sdk/sdk';

const sdk = new SpaceInvoices('YOUR_API_KEY');

const response = await sdk.legacyMigration.listMigrationJobs({
  account_id: "YOUR_ACCOUNT_ID"
});

console.log(response);

Response

Returns

dataarray of objectsShow child attributes

json

Copy

{
  "data": [
    {
      "id": "mig_507f1f77bcf86cd799439011",
      "legacy_org_id": "legacy_org_abc123",
      "environment": "sandbox",
      "entity_id": null,
      "status": "pending",
      "step": "Queued",
      "step_number": 0,
      "total_steps": 8,
      "progress_detail": "Migration job is waiting to start.",
      "error": null,
      "created_at": "2024-01-01T00:00:00.000Z",
      "started_at": null,
      "completed_at": null
    }
  ]
}

---

Inspect a legacy migration organization

GET/legacy-migration/organizations/{legacyOrgId}

Load detailed migration eligibility, unsupported data, and manual follow-up for a selected legacy organization.

Request

Header parameters

account_idstringoptional

Account Id on which the request is made. Optional if user is part of only one account.

Path parameters

legacyOrgIdstringrequired

Legacy organization ID

Query parameters

legacy_session_idstringrequired

Temporary legacy session ID created after legacy authentication

cURLNode.js SDKFetchPythonGoRubyPHP

Copy

import SpaceInvoices from '@spaceinvoices/js-sdk/sdk';

const sdk = new SpaceInvoices('YOUR_API_KEY');

const response = await sdk.legacyMigration.getLegacyMigrationOrganization('LEGACY_ORG_ID', {
  legacy_session_id: "example"
}, {
  account_id: "YOUR_ACCOUNT_ID"
});

console.log(response);

Response

Returns

idstring

Legacy organization ID

Other parametersExpand all

namestring

countrystringnullable

tax_numberstringnullable

created_atstring

already_migratedboolean

migrated_environmentstringnullable

unsupportedarray of objectsShow child attributes

requires_confirmationboolean

subscription_reviewobjectnullableShow child attributes

json

Copy

{
  "id": "legacy_org_abc123",
  "name": "Nebula Systems GmbH",
  "country": "DE",
  "tax_number": "DE112233445",
  "created_at": "2020-05-15T10:00:00.000Z",
  "already_migrated": false,
  "migrated_environment": null,
  "unsupported": [
    {
      "code": "sales_integrations",
      "label": "Sales integrations",
      "description": "Reconnect compatible stores after migration.",
      "count": 1,
      "collections": [
        "Woocommerce"
      ]
    }
  ],
  "requires_confirmation": true,
  "subscription_review": null
}

---

Get migration job status

GET/legacy-migration/jobs/{id}

Get status and progress of a migration job.

Request

Header parameters

account_idstringoptional

Account Id on which the request is made. Optional if user is part of only one account.

Path parameters

idstringrequired

Migration job ID

cURLNode.js SDKFetchPythonGoRubyPHP

Copy

import SpaceInvoices from '@spaceinvoices/js-sdk/sdk';

const sdk = new SpaceInvoices('YOUR_API_KEY');

const response = await sdk.legacyMigration.getMigrationJob('LEGACYMIGRATION_ID', {
  account_id: "YOUR_ACCOUNT_ID"
});

console.log(response);

Response

Returns

idstring

Job ID

Other parametersExpand all

legacy_org_idstring

environmentstring

entity_idstringnullable

statusstring

stepstringnullable

step_numbernumber

total_stepsnumber

progress_detailstringnullable

errorstringnullable

created_atstring

started_atstringnullable

completed_atstringnullable

json

Copy

{
  "id": "mig_507f1f77bcf86cd799439011",
  "legacy_org_id": "legacy_org_abc123",
  "environment": "sandbox",
  "entity_id": null,
  "status": "pending",
  "step": "Queued",
  "step_number": 0,
  "total_steps": 8,
  "progress_detail": "Migration job is waiting to start.",
  "error": null,
  "created_at": "2024-01-01T00:00:00.000Z",
  "started_at": null,
  "completed_at": null
}

Example:

PendingCompleted

---