Product Dependent Migrations

get

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

productIdstring · flake-idRequiredExample: 411486491630370816

Query parameters

limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterstring · flake-idOptional

Returns items after the specified ID. Used for forward pagination through results.

Example: 411486491630370816

beforestring · flake-idOptional

Returns items before the specified ID. Used for backward pagination through results.

Example: 411486491630370816

ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

Responses

200

OK

application/json

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

product_idstring · flake-idRequiredExample: 411486491630370816

created_atstring · date-timeRequired

statusstring · enumRequiredPossible values:

send_new_commands_to_all_serversbooleanRequired

send_all_commands_to_new_serversbooleanRequired

completed_atstring · nullableOptional

default

Error response

application/json

get/v1/stores/{storeId}/products/{productId}/dependent-migrations

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/products/{productId}/dependent-migrations HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "product_id": "411486491630370816",
    "created_at": "2026-08-09T07:38:02.086Z",
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "migration_targets": [
      {
        "type": "invalid",
        "versions": [
          {
            "old_product_version_id": "411486491630370816",
            "old_product_version_created_at": "2026-08-09T07:38:02.086Z",
            "new_product_version_id": "411486491630370816",
            "total_entities_migrated": 1,
            "migrated": true
          }
        ]
      }
    ],
    "status": "invalid",
    "send_new_commands_to_all_servers": true,
    "send_all_commands_to_new_servers": true,
    "completed_at": null
  }
]

post

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

productIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

send_new_commands_to_all_serversbooleanRequired

send_all_commands_to_new_serversbooleanRequired

Responses

200

OK

application/json

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

product_idstring · flake-idRequiredExample: 411486491630370816

created_atstring · date-timeRequired

statusstring · enumRequiredPossible values:

send_new_commands_to_all_serversbooleanRequired

send_all_commands_to_new_serversbooleanRequired

completed_atstring · nullableOptional

default

Error response

application/json

post/v1/stores/{storeId}/products/{productId}/dependent-migrations

HTTPcURLJavaScriptPython

POST /v1/stores/{storeId}/products/{productId}/dependent-migrations HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "send_new_commands_to_all_servers": true,
  "send_all_commands_to_new_servers": true,
  "target_types": [
    "invalid"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "product_id": "411486491630370816",
  "created_at": "2026-08-09T07:38:02.086Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "migration_targets": [
    {
      "type": "invalid",
      "versions": [
        {
          "old_product_version_id": "411486491630370816",
          "old_product_version_created_at": "2026-08-09T07:38:02.086Z",
          "new_product_version_id": "411486491630370816",
          "total_entities_migrated": 1,
          "migrated": true
        }
      ]
    }
  ],
  "status": "invalid",
  "send_new_commands_to_all_servers": true,
  "send_all_commands_to_new_servers": true,
  "completed_at": null
}

get

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

productIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

product_version_idstring · flake-idRequiredExample: 411486491630370816

product_version_created_atstring · date-timeRequired

default

Error response

application/json

get/v1/stores/{storeId}/products/{productId}/dependent-migrations/estimate

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/products/{productId}/dependent-migrations/estimate HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

[
  {
    "product_version_id": "411486491630370816",
    "product_version_created_at": "2026-08-09T07:38:02.086Z",
    "target_counts": [
      {
        "type": "invalid",
        "total_entities": 1
      }
    ]
  }
]

get

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

productDependentMigrationIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

product_idstring · flake-idRequiredExample: 411486491630370816

created_atstring · date-timeRequired

statusstring · enumRequiredPossible values:

send_new_commands_to_all_serversbooleanRequired

send_all_commands_to_new_serversbooleanRequired

completed_atstring · nullableOptional

default

Error response

application/json

get/v1/stores/{storeId}/product-dependent-migrations/{productDependentMigrationId}

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/product-dependent-migrations/{productDependentMigrationId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "product_id": "411486491630370816",
  "created_at": "2026-08-09T07:38:02.086Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "migration_targets": [
    {
      "type": "invalid",
      "versions": [
        {
          "old_product_version_id": "411486491630370816",
          "old_product_version_created_at": "2026-08-09T07:38:02.086Z",
          "new_product_version_id": "411486491630370816",
          "total_entities_migrated": 1,
          "migrated": true
        }
      ]
    }
  ],
  "status": "invalid",
  "send_new_commands_to_all_servers": true,
  "send_all_commands_to_new_servers": true,
  "completed_at": null
}