Delivery

Get delivery items associated with an order

get

Retrieves all delivery items associated with a specific order.

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequired

The ID of the store.

Example: 411486491630370816

orderIdstring · flake-idRequired

The ID of the order to retrieve delivery items from.

Example: 411486491630370816

Query parameters

activeOnlybooleanOptional

Responses

200

OK

application/json

Represents a delivery item assigned to a customer

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

customer_idstring · flake-idRequiredExample: 411486491630370816

order_customer_idstring · flake-idOptionalExample: 411486491630370816

checkout_idstring · flake-idOptionalExample: 411486491630370816

checkout_line_idstring · flake-idOptionalExample: 411486491630370816

order_idstring · flake-idOptionalExample: 411486491630370816

order_line_idstring · flake-idOptionalExample: 411486491630370816

subscription_idstring · flake-idOptionalExample: 411486491630370816

trial_idstring · flake-idOptionalExample: 411486491630370816

execute_on_gameserver_idstring · flake-idOptionalExample: 411486491630370816

quantity_indexinteger · nullableOptional

The index of the item when multiple quantities were assigned

statestring · enumRequiredPossible values:

added_atstring · date-timeRequired

The date and time when the item was added

active_atstring · nullableOptional

The date and time when the item became active

expirablebooleanRequired

Indicates whether the delivery item can expire

expires_atstring · nullableOptional

The date and time when the item expires naturally

override_expires_atstring · nullableOptional

The override expiry date for the delivery item

removed_atstring · nullableOptional

The date and time when the item was removed

revoked_atstring · nullableOptional

The date and time when the item was revoked

revoke_reasonstring · nullableOptional

The reason for revoking the delivery item

skip_commandsbooleanRequired

Indicates whether command execution should be skipped for this item

giftbooleanRequired

Indicates whether the item was given as a gift

default

Error response

application/json

get

/v1/stores/{storeId}/orders/{orderId}/delivery/items

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/orders/{orderId}/delivery/items HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2026-02-18T14:26:22.136Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "order_customer_id": "411486491630370816",
    "order_customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2026-02-18T14:26:22.136Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order_line_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "trial_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "quantity_index": null,
    "product": {
      "id": "411486491630370816",
      "name": "Premium Membership",
      "slug": "premium-membership",
      "version_id": "v2.1.0"
    },
    "state": "usable",
    "added_at": "2026-02-18T14:26:22.136Z",
    "added_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "active_at": null,
    "expirable": true,
    "expires_at": null,
    "override_expires_at": null,
    "removed_at": null,
    "revoked_at": null,
    "revoke_reason": null,
    "revoked_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "command_attempts": [
      {
        "id": "411486491630370816",
        "store_id": "411486491630370816",
        "inventory_item_id": "411486491630370816",
        "gameserver_id": "411486491630370816",
        "steam_id": "76561197960287930",
        "minecraft_uuid": null,
        "customer_name": null,
        "customer_id": "411486491630370816",
        "command_stage": null,
        "command": "text",
        "online_only": true,
        "rerun": true,
        "queued_at": "2026-02-18T14:26:22.136Z",
        "executed_at": null,
        "executed_by_ip": null,
        "unqueued_at": null
      }
    ],
    "skip_commands": true,
    "custom_variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "gift": true
  }
]

Assign delivery items in bulk

post

Allows you to assign multiple delivery items for multiple customers in bulk

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Bodyobject[]

application/jsontext/jsonapplication/*+json

customer_idstring · flake-idRequiredExample: 411486491630370816

product_version_idstring · flake-idOptionalExample: 411486491630370816

execute_on_gameserver_idstring · flake-idOptionalExample: 411486491630370816

quantityinteger · nullableOptional

Quantity of products to assign.

override_expires_atstring · nullableOptional

Override expiry date for the delivery item.

skip_commandsboolean · nullableOptional

Skip command execution when assigning the item.

custom_variablesobject · nullableOptional

Custom variables for the assignment.

Responses

200

OK

application/json

Represents a delivery item assigned to a customer

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

customer_idstring · flake-idRequiredExample: 411486491630370816

order_customer_idstring · flake-idOptionalExample: 411486491630370816

checkout_idstring · flake-idOptionalExample: 411486491630370816

checkout_line_idstring · flake-idOptionalExample: 411486491630370816

order_idstring · flake-idOptionalExample: 411486491630370816

order_line_idstring · flake-idOptionalExample: 411486491630370816

subscription_idstring · flake-idOptionalExample: 411486491630370816

trial_idstring · flake-idOptionalExample: 411486491630370816

execute_on_gameserver_idstring · flake-idOptionalExample: 411486491630370816

quantity_indexinteger · nullableOptional

The index of the item when multiple quantities were assigned

statestring · enumRequiredPossible values:

added_atstring · date-timeRequired

The date and time when the item was added

active_atstring · nullableOptional

The date and time when the item became active

expirablebooleanRequired

Indicates whether the delivery item can expire

expires_atstring · nullableOptional

The date and time when the item expires naturally

override_expires_atstring · nullableOptional

The override expiry date for the delivery item

removed_atstring · nullableOptional

The date and time when the item was removed

revoked_atstring · nullableOptional

The date and time when the item was revoked

revoke_reasonstring · nullableOptional

The reason for revoking the delivery item

skip_commandsbooleanRequired

Indicates whether command execution should be skipped for this item

giftbooleanRequired

Indicates whether the item was given as a gift

default

Error response

application/json

post

/v1/stores/{storeId}/delivery/items

HTTPcURLJavaScriptPython

POST /v1/stores/{storeId}/delivery/items HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 216

[
  {
    "customer_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "quantity": null,
    "override_expires_at": null,
    "skip_commands": null,
    "custom_variables": null
  }
]

application/jsontext/jsonapplication/*+json

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2026-02-18T14:26:22.136Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "order_customer_id": "411486491630370816",
    "order_customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2026-02-18T14:26:22.136Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order_line_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "trial_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "quantity_index": null,
    "product": {
      "id": "411486491630370816",
      "name": "Premium Membership",
      "slug": "premium-membership",
      "version_id": "v2.1.0"
    },
    "state": "usable",
    "added_at": "2026-02-18T14:26:22.136Z",
    "added_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "active_at": null,
    "expirable": true,
    "expires_at": null,
    "override_expires_at": null,
    "removed_at": null,
    "revoked_at": null,
    "revoke_reason": null,
    "revoked_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "command_attempts": [
      {
        "id": "411486491630370816",
        "store_id": "411486491630370816",
        "inventory_item_id": "411486491630370816",
        "gameserver_id": "411486491630370816",
        "steam_id": "76561197960287930",
        "minecraft_uuid": null,
        "customer_name": null,
        "customer_id": "411486491630370816",
        "command_stage": null,
        "command": "text",
        "online_only": true,
        "rerun": true,
        "queued_at": "2026-02-18T14:26:22.136Z",
        "executed_at": null,
        "executed_by_ip": null,
        "unqueued_at": null
      }
    ],
    "skip_commands": true,
    "custom_variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "gift": true
  }
]

Unqueue commands by Attempt IDs

post

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

attempt_idsstring · flake-id[]RequiredExample: 411486491630370816

Responses

200

OK

application/json

unqueued_countinteger · int64Required

default

Error response

application/json

post

/v1/stores/{storeId}/delivery/commands/unqueue

HTTPcURLJavaScriptPython

POST /v1/stores/{storeId}/delivery/commands/unqueue HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "attempt_ids": [
    "411486491630370816"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "unqueued_count": 1
}

Get delivery items associated with a customer

get

Retrieves delivery items associated with a customer

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

customerIdstring · 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.

activeOnlybooleanOptional

Responses

200

OK

application/json

Represents a delivery item assigned to a customer

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

customer_idstring · flake-idRequiredExample: 411486491630370816

order_customer_idstring · flake-idOptionalExample: 411486491630370816

checkout_idstring · flake-idOptionalExample: 411486491630370816

checkout_line_idstring · flake-idOptionalExample: 411486491630370816

order_idstring · flake-idOptionalExample: 411486491630370816

order_line_idstring · flake-idOptionalExample: 411486491630370816

subscription_idstring · flake-idOptionalExample: 411486491630370816

trial_idstring · flake-idOptionalExample: 411486491630370816

execute_on_gameserver_idstring · flake-idOptionalExample: 411486491630370816

quantity_indexinteger · nullableOptional

The index of the item when multiple quantities were assigned

statestring · enumRequiredPossible values:

added_atstring · date-timeRequired

The date and time when the item was added

active_atstring · nullableOptional

The date and time when the item became active

expirablebooleanRequired

Indicates whether the delivery item can expire

expires_atstring · nullableOptional

The date and time when the item expires naturally

override_expires_atstring · nullableOptional

The override expiry date for the delivery item

removed_atstring · nullableOptional

The date and time when the item was removed

revoked_atstring · nullableOptional

The date and time when the item was revoked

revoke_reasonstring · nullableOptional

The reason for revoking the delivery item

skip_commandsbooleanRequired

Indicates whether command execution should be skipped for this item

giftbooleanRequired

Indicates whether the item was given as a gift

default

Error response

application/json

get

/v1/stores/{storeId}/customers/{customerId}/delivery/items

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/customers/{customerId}/delivery/items HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2026-02-18T14:26:22.136Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "order_customer_id": "411486491630370816",
    "order_customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2026-02-18T14:26:22.136Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order_line_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "trial_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "quantity_index": null,
    "product": {
      "id": "411486491630370816",
      "name": "Premium Membership",
      "slug": "premium-membership",
      "version_id": "v2.1.0"
    },
    "state": "usable",
    "added_at": "2026-02-18T14:26:22.136Z",
    "added_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "active_at": null,
    "expirable": true,
    "expires_at": null,
    "override_expires_at": null,
    "removed_at": null,
    "revoked_at": null,
    "revoke_reason": null,
    "revoked_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "command_attempts": [
      {
        "id": "411486491630370816",
        "store_id": "411486491630370816",
        "inventory_item_id": "411486491630370816",
        "gameserver_id": "411486491630370816",
        "steam_id": "76561197960287930",
        "minecraft_uuid": null,
        "customer_name": null,
        "customer_id": "411486491630370816",
        "command_stage": null,
        "command": "text",
        "online_only": true,
        "rerun": true,
        "queued_at": "2026-02-18T14:26:22.136Z",
        "executed_at": null,
        "executed_by_ip": null,
        "unqueued_at": null
      }
    ],
    "skip_commands": true,
    "custom_variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "gift": true
  }
]

Assign a delivery item to a customer

post

Allows you to assign a delivery item to a customer

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

customerIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

product_idstring · flake-idOptionalExample: 411486491630370816

product_version_idstring · flake-idOptionalExample: 411486491630370816

execute_on_gameserver_idstring · flake-idOptionalExample: 411486491630370816

quantityinteger · nullableOptional

Quantity of products to assign.

override_expires_atstring · nullableOptional

Override expiry date for the delivery item.

skip_commandsboolean · nullableOptional

Skip command execution when assigning the item.

custom_variablesobject · nullableOptional

Custom variables for the assignment.

Responses

200

OK

application/json

Represents a delivery item assigned to a customer

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

customer_idstring · flake-idRequiredExample: 411486491630370816

order_customer_idstring · flake-idOptionalExample: 411486491630370816

checkout_idstring · flake-idOptionalExample: 411486491630370816

checkout_line_idstring · flake-idOptionalExample: 411486491630370816

order_idstring · flake-idOptionalExample: 411486491630370816

order_line_idstring · flake-idOptionalExample: 411486491630370816

subscription_idstring · flake-idOptionalExample: 411486491630370816

trial_idstring · flake-idOptionalExample: 411486491630370816

execute_on_gameserver_idstring · flake-idOptionalExample: 411486491630370816

quantity_indexinteger · nullableOptional

The index of the item when multiple quantities were assigned

statestring · enumRequiredPossible values:

added_atstring · date-timeRequired

The date and time when the item was added

active_atstring · nullableOptional

The date and time when the item became active

expirablebooleanRequired

Indicates whether the delivery item can expire

expires_atstring · nullableOptional

The date and time when the item expires naturally

override_expires_atstring · nullableOptional

The override expiry date for the delivery item

removed_atstring · nullableOptional

The date and time when the item was removed

revoked_atstring · nullableOptional

The date and time when the item was revoked

revoke_reasonstring · nullableOptional

The reason for revoking the delivery item

skip_commandsbooleanRequired

Indicates whether command execution should be skipped for this item

giftbooleanRequired

Indicates whether the item was given as a gift

default

Error response

application/json

post

/v1/stores/{storeId}/customers/{customerId}/delivery/items

HTTPcURLJavaScriptPython

POST /v1/stores/{storeId}/customers/{customerId}/delivery/items HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 213

{
  "product_id": "411486491630370816",
  "product_version_id": "411486491630370816",
  "execute_on_gameserver_id": "411486491630370816",
  "quantity": null,
  "override_expires_at": null,
  "skip_commands": null,
  "custom_variables": null
}

application/jsontext/jsonapplication/*+json

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2026-02-18T14:26:22.136Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "order_customer_id": "411486491630370816",
    "order_customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2026-02-18T14:26:22.136Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order_line_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "trial_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "quantity_index": null,
    "product": {
      "id": "411486491630370816",
      "name": "Premium Membership",
      "slug": "premium-membership",
      "version_id": "v2.1.0"
    },
    "state": "usable",
    "added_at": "2026-02-18T14:26:22.136Z",
    "added_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "active_at": null,
    "expirable": true,
    "expires_at": null,
    "override_expires_at": null,
    "removed_at": null,
    "revoked_at": null,
    "revoke_reason": null,
    "revoked_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "command_attempts": [
      {
        "id": "411486491630370816",
        "store_id": "411486491630370816",
        "inventory_item_id": "411486491630370816",
        "gameserver_id": "411486491630370816",
        "steam_id": "76561197960287930",
        "minecraft_uuid": null,
        "customer_name": null,
        "customer_id": "411486491630370816",
        "command_stage": null,
        "command": "text",
        "online_only": true,
        "rerun": true,
        "queued_at": "2026-02-18T14:26:22.136Z",
        "executed_at": null,
        "executed_by_ip": null,
        "unqueued_at": null
      }
    ],
    "skip_commands": true,
    "custom_variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "gift": true
  }
]

Revoke a delivery item from a customer

delete

Allows you to revoke a delivery item associated with a customer

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

customerIdstring · flake-idRequiredExample: 411486491630370816

deliveryItemIdstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

default

Error response

application/json

delete

/v1/stores/{storeId}/customers/{customerId}/delivery/items/{deliveryItemId}

HTTPcURLJavaScriptPython

DELETE /v1/stores/{storeId}/customers/{customerId}/delivery/items/{deliveryItemId} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Get command attempts associated with a customer

get

Retrieves command attempts associated with a customer

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

customerIdstring · 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

inventory_item_idstring · flake-idOptionalExample: 411486491630370816

gameserver_idstring · flake-idRequiredExample: 411486491630370816

steam_idstring · steam-idOptional

A 64-bit Steam account identifier. Accepts string or numeric format.

Example: 76561197960287930

minecraft_uuidstring · nullableOptional

customer_namestring · nullableOptional

customer_idstring · flake-idOptionalExample: 411486491630370816

command_stagestring · nullableOptional

commandstringRequired

online_onlybooleanRequired

rerunbooleanRequired

queued_atstring · date-timeRequired

executed_atstring · nullableOptional

executed_by_ipstring · nullableOptional

unqueued_atstring · nullableOptional

default

Error response

application/json

get

/v1/stores/{storeId}/customers/{customerId}/delivery/commands

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/customers/{customerId}/delivery/commands HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "inventory_item_id": "411486491630370816",
    "gameserver_id": "411486491630370816",
    "steam_id": "76561197960287930",
    "minecraft_uuid": null,
    "customer_name": null,
    "customer_id": "411486491630370816",
    "command_stage": null,
    "command": "text",
    "online_only": true,
    "rerun": true,
    "queued_at": "2026-02-18T14:26:22.136Z",
    "executed_at": null,
    "executed_by_ip": null,
    "unqueued_at": null
  }
]

Returns delivery items in which an associated command attempt is for the gameserver

get

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

gameServerIdstring · 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.

activeOnlybooleanOptional

Responses

200

OK

application/json

Represents a delivery item assigned to a customer

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

customer_idstring · flake-idRequiredExample: 411486491630370816

order_customer_idstring · flake-idOptionalExample: 411486491630370816

checkout_idstring · flake-idOptionalExample: 411486491630370816

checkout_line_idstring · flake-idOptionalExample: 411486491630370816

order_idstring · flake-idOptionalExample: 411486491630370816

order_line_idstring · flake-idOptionalExample: 411486491630370816

subscription_idstring · flake-idOptionalExample: 411486491630370816

trial_idstring · flake-idOptionalExample: 411486491630370816

execute_on_gameserver_idstring · flake-idOptionalExample: 411486491630370816

quantity_indexinteger · nullableOptional

The index of the item when multiple quantities were assigned

statestring · enumRequiredPossible values:

added_atstring · date-timeRequired

The date and time when the item was added

active_atstring · nullableOptional

The date and time when the item became active

expirablebooleanRequired

Indicates whether the delivery item can expire

expires_atstring · nullableOptional

The date and time when the item expires naturally

override_expires_atstring · nullableOptional

The override expiry date for the delivery item

removed_atstring · nullableOptional

The date and time when the item was removed

revoked_atstring · nullableOptional

The date and time when the item was revoked

revoke_reasonstring · nullableOptional

The reason for revoking the delivery item

skip_commandsbooleanRequired

Indicates whether command execution should be skipped for this item

giftbooleanRequired

Indicates whether the item was given as a gift

default

Error response

application/json

get

/v1/stores/{storeId}/gameservers/{gameServerId}/delivery/items

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/gameservers/{gameServerId}/delivery/items HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2026-02-18T14:26:22.136Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "order_customer_id": "411486491630370816",
    "order_customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": null
      },
      "steam_id": "76561197960287930",
      "steam": {
        "id": "76561197960287930",
        "name": "text",
        "avatar_url": "text"
      },
      "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "minecraft": {
        "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "notch",
        "avatar_url": "text"
      },
      "xbox_xuid": null,
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2026-02-18T14:26:22.136Z",
      "updated_at": null,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order_line_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "trial_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "quantity_index": null,
    "product": {
      "id": "411486491630370816",
      "name": "Premium Membership",
      "slug": "premium-membership",
      "version_id": "v2.1.0"
    },
    "state": "usable",
    "added_at": "2026-02-18T14:26:22.136Z",
    "added_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "active_at": null,
    "expirable": true,
    "expires_at": null,
    "override_expires_at": null,
    "removed_at": null,
    "revoked_at": null,
    "revoke_reason": null,
    "revoked_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "command_attempts": [
      {
        "id": "411486491630370816",
        "store_id": "411486491630370816",
        "inventory_item_id": "411486491630370816",
        "gameserver_id": "411486491630370816",
        "steam_id": "76561197960287930",
        "minecraft_uuid": null,
        "customer_name": null,
        "customer_id": "411486491630370816",
        "command_stage": null,
        "command": "text",
        "online_only": true,
        "rerun": true,
        "queued_at": "2026-02-18T14:26:22.136Z",
        "executed_at": null,
        "executed_by_ip": null,
        "unqueued_at": null
      }
    ],
    "skip_commands": true,
    "custom_variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "gift": true
  }
]

Resend commands for a given Gameserver

post

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

gameServerIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

starts_atstring · nullableOptional

ends_atstring · nullableOptional

inventory_item_idstring · flake-idOptionalExample: 411486491630370816

customer_idstring · flake-idOptionalExample: 411486491630370816

order_idstring · flake-idOptionalExample: 411486491630370816

product_idstring · flake-idOptionalExample: 411486491630370816

subscription_idstring · flake-idOptionalExample: 411486491630370816

Responses

200

OK

application/json

enqueued_commands_countinteger · int32Required

default

Error response

application/json

post

/v1/stores/{storeId}/gameservers/{gameServerId}/delivery/commands/resend

HTTPcURLJavaScriptPython

POST /v1/stores/{storeId}/gameservers/{gameServerId}/delivery/commands/resend HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 214

{
  "starts_at": null,
  "ends_at": null,
  "inventory_item_id": "411486491630370816",
  "customer_id": "411486491630370816",
  "order_id": "411486491630370816",
  "product_id": "411486491630370816",
  "subscription_id": "411486491630370816"
}

application/jsontext/jsonapplication/*+json

{
  "enqueued_commands_count": 1
}