Product Dependent Migrations

Get Product Dependent Migrations

GEThttps://api.paynow.gg/v1/stores/{storeId}/products/{productId}/dependent-migrations

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

productIdFlakeIdRequired

Query parameters

limitintegerOptional

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

afterFlakeIdOptional

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

beforeFlakeIdOptional

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

ascbooleanOptional

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

Response

200OKProductDependentMigrationDto[]

Show fields

created_atstringRequired

created_byActorDtoRequired

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

idFlakeIdRequired

migration_targetsProductDependentMigrationTargetDto[]Required

typeenumRequired

Possible enum values

invalid
active_subscriptions
active_unused_delivery_items
non_expirable_delivery_items

versionsProductDependentMigrationTargetVersionDto[]Required

migratedbooleanRequired

new_product_version_idFlakeIdRequired

old_product_version_created_atstringRequired

old_product_version_idFlakeIdRequired

total_entities_migratedintegerRequired

product_idFlakeIdRequired

send_all_commands_to_new_serversbooleanRequired

send_new_commands_to_all_serversbooleanRequired

statusenumRequired

Possible enum values

invalid
created
completed

store_idFlakeIdRequired

completed_atstringOptional

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/products/{productId}/dependent-migrations" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.productDependentMigrations.getProductDependentMigrations("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/products/{productId}/dependent-migrations", headers=headers)

Response200

[
  {
    "created_at": "2024-01-01T00:00:00Z",
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "id": "411486491630370816",
    "migration_targets": [
      {
        "type": "invalid",
        "versions": [
          {
            "migrated": true,
            "new_product_version_id": "411486491630370816",
            "old_product_version_created_at": "2024-01-01T00:00:00Z",
            "old_product_version_id": "411486491630370816",
            "total_entities_migrated": 0
          }
        ]
      }
    ],
    "product_id": "411486491630370816",
    "send_all_commands_to_new_servers": true,
    "send_new_commands_to_all_servers": true,
    "status": "invalid",
    "store_id": "411486491630370816",
    "completed_at": "2024-01-01T00:00:00Z"
  }
]

Create Product Dependent Migration

POSThttps://api.paynow.gg/v1/stores/{storeId}/products/{productId}/dependent-migrations

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

productIdFlakeIdRequired

Request body

send_all_commands_to_new_serversbooleanRequired

send_new_commands_to_all_serversbooleanRequired

target_typesenum[]Required

Possible enum values

invalid
active_subscriptions
active_unused_delivery_items
non_expirable_delivery_items

Response

200OKProductDependentMigrationDto

Show fields

created_atstringRequired

created_byActorDtoRequired

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

idFlakeIdRequired

migration_targetsProductDependentMigrationTargetDto[]Required

typeenumRequired

Possible enum values

invalid
active_subscriptions
active_unused_delivery_items
non_expirable_delivery_items

versionsProductDependentMigrationTargetVersionDto[]Required

migratedbooleanRequired

new_product_version_idFlakeIdRequired

old_product_version_created_atstringRequired

old_product_version_idFlakeIdRequired

total_entities_migratedintegerRequired

product_idFlakeIdRequired

send_all_commands_to_new_serversbooleanRequired

send_new_commands_to_all_serversbooleanRequired

statusenumRequired

Possible enum values

invalid
created
completed

store_idFlakeIdRequired

completed_atstringOptional

Failed requests return a PayNowError body. See the error response guide.

curl -X POST "https://api.paynow.gg/v1/stores/{storeId}/products/{productId}/dependent-migrations" \
  -H "Authorization: APIKey TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "send_all_commands_to_new_servers": true,
  "send_new_commands_to_all_servers": true,
  "target_types": [
    "invalid"
  ]
}'

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.productDependentMigrations.createProductDependentMigration("411486491630370816", {
  send_all_commands_to_new_servers: true,
  send_new_commands_to_all_servers: true,
  target_types: [
    "invalid",
  ],
});

import requests

headers = {"Authorization": "APIKey TOKEN"}
payload = {
    "send_all_commands_to_new_servers": True,
    "send_new_commands_to_all_servers": True,
    "target_types": [
        "invalid",
    ],
}
response = requests.post("https://api.paynow.gg/v1/stores/{storeId}/products/{productId}/dependent-migrations", headers=headers, json=payload)

Response200

{
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "id": "411486491630370816",
  "migration_targets": [
    {
      "type": "invalid",
      "versions": [
        {
          "migrated": true,
          "new_product_version_id": "411486491630370816",
          "old_product_version_created_at": "2024-01-01T00:00:00Z",
          "old_product_version_id": "411486491630370816",
          "total_entities_migrated": 0
        }
      ]
    }
  ],
  "product_id": "411486491630370816",
  "send_all_commands_to_new_servers": true,
  "send_new_commands_to_all_servers": true,
  "status": "invalid",
  "store_id": "411486491630370816",
  "completed_at": "2024-01-01T00:00:00Z"
}

Get Product Dependent Migration Estimate

GEThttps://api.paynow.gg/v1/stores/{storeId}/products/{productId}/dependent-migrations/estimate

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

productIdFlakeIdRequired

Response

200OKProductDependentMigrationEstimateVersionDto[]

Show fields

product_version_created_atstringRequired

product_version_idFlakeIdRequired

target_countsProductDependentMigrationEstimateTargetCountDto[]Required

total_entitiesintegerRequired

typeenumRequired

Possible enum values

invalid
active_subscriptions
active_unused_delivery_items
non_expirable_delivery_items

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/products/{productId}/dependent-migrations/estimate" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.productDependentMigrations.getProductDependentMigrationEstimate("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/products/{productId}/dependent-migrations/estimate", headers=headers)

Response200

[
  {
    "product_version_created_at": "2024-01-01T00:00:00Z",
    "product_version_id": "411486491630370816",
    "target_counts": [
      {
        "total_entities": 0,
        "type": "invalid"
      }
    ]
  }
]

Get Product Dependent Migration By Id

GEThttps://api.paynow.gg/v1/stores/{storeId}/product-dependent-migrations/{productDependentMigrationId}

Headers

AuthorizationAPI KeyRequired

Authentication token for this request, sent as Authorization: APIKey TOKEN.

Path parameters

storeIdFlakeIdRequired

productDependentMigrationIdFlakeIdRequired

Response

200OKProductDependentMigrationDto

Show fields

created_atstringRequired

created_byActorDtoRequired

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

idFlakeIdRequired

migration_targetsProductDependentMigrationTargetDto[]Required

typeenumRequired

Possible enum values

invalid
active_subscriptions
active_unused_delivery_items
non_expirable_delivery_items

versionsProductDependentMigrationTargetVersionDto[]Required

migratedbooleanRequired

new_product_version_idFlakeIdRequired

old_product_version_created_atstringRequired

old_product_version_idFlakeIdRequired

total_entities_migratedintegerRequired

product_idFlakeIdRequired

send_all_commands_to_new_serversbooleanRequired

send_new_commands_to_all_serversbooleanRequired

statusenumRequired

Possible enum values

invalid
created
completed

store_idFlakeIdRequired

completed_atstringOptional

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/product-dependent-migrations/{productDependentMigrationId}" \
  -H "Authorization: APIKey TOKEN"

import { createManagementClient } from "@paynow-gg/typescript-sdk";

const paynow = createManagementClient({
  apiKey: "API_KEY",
  storeId: "STORE_ID",
});

const result = await paynow.productDependentMigrations.getProductDependentMigrationById("411486491630370816");

import requests

headers = {"Authorization": "APIKey TOKEN"}
response = requests.get("https://api.paynow.gg/v1/stores/{storeId}/product-dependent-migrations/{productDependentMigrationId}", headers=headers)

Response200

{
  "created_at": "2024-01-01T00:00:00Z",
  "created_by": {
    "type": "anonymous",
    "id": "411486491630370816"
  },
  "id": "411486491630370816",
  "migration_targets": [
    {
      "type": "invalid",
      "versions": [
        {
          "migrated": true,
          "new_product_version_id": "411486491630370816",
          "old_product_version_created_at": "2024-01-01T00:00:00Z",
          "old_product_version_id": "411486491630370816",
          "total_entities_migrated": 0
        }
      ]
    }
  ],
  "product_id": "411486491630370816",
  "send_all_commands_to_new_servers": true,
  "send_new_commands_to_all_servers": true,
  "status": "invalid",
  "store_id": "411486491630370816",
  "completed_at": "2024-01-01T00:00:00Z"
}