Command Delivery

Get delivery items associated with an order

get

Retrieves all delivery items associated with a specific order.

Authorizations

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

Responses

200

application/json

default

Error response

application/json

get

GET /v1/stores/{storeId}/orders/{orderId}/command-delivery HTTP/1.1
Host: 
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": "text"
      },
      "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": "text",
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2025-08-28T18:00:43.129Z",
      "updated_at": "2025-08-28T18:00:43.129Z",
      "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": "text"
      },
      "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": "text",
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2025-08-28T18:00:43.129Z",
      "updated_at": "2025-08-28T18:00:43.129Z",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order_line_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "quantity_index": 1,
    "product": {
      "id": "411486491630370816",
      "name": "Premium Membership",
      "slug": "premium-membership",
      "version_id": "v2.1.0"
    },
    "state": "usable",
    "added_at": "2025-08-28T18:00:43.129Z",
    "added_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "active_at": "2025-08-28T18:00:43.129Z",
    "expirable": true,
    "expires_at": "2025-08-28T18:00:43.129Z",
    "override_expires_at": "2025-08-28T18:00:43.129Z",
    "removed_at": "2025-08-28T18:00:43.129Z",
    "revoked_at": "2025-08-28T18:00:43.129Z",
    "revoke_reason": "text",
    "revoked_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "command_attempts": [
      {
        "id": "411486491630370816",
        "inventory_item_id": "411486491630370816",
        "gameserver_id": "411486491630370816",
        "steam_id": "76561197960287930",
        "minecraft_uuid": "text",
        "customer_name": "text",
        "command_stage": "text",
        "command": "text",
        "online_only": true,
        "rerun": true,
        "queued_at": "2025-08-28T18:00:43.129Z",
        "executed_at": "2025-08-28T18:00:43.129Z",
        "unqueued_at": "2025-08-28T18:00:43.129Z"
      }
    ],
    "skip_commands": true,
    "custom_variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "gift": true
  }
]

Get delivery items associated with a customer

get

Retrieves delivery items associated with a customer

Authorizations

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.

afterinteger · int64Optional

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

beforeinteger · int64Optional

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.

Responses

200

application/json

default

Error response

application/json

get

GET /v1/stores/{storeId}/customers/{customerId}/command-delivery HTTP/1.1
Host: 
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": "text"
      },
      "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": "text",
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2025-08-28T18:00:43.129Z",
      "updated_at": "2025-08-28T18:00:43.129Z",
      "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": "text"
      },
      "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": "text",
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2025-08-28T18:00:43.129Z",
      "updated_at": "2025-08-28T18:00:43.129Z",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order_line_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "quantity_index": 1,
    "product": {
      "id": "411486491630370816",
      "name": "Premium Membership",
      "slug": "premium-membership",
      "version_id": "v2.1.0"
    },
    "state": "usable",
    "added_at": "2025-08-28T18:00:43.129Z",
    "added_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "active_at": "2025-08-28T18:00:43.129Z",
    "expirable": true,
    "expires_at": "2025-08-28T18:00:43.129Z",
    "override_expires_at": "2025-08-28T18:00:43.129Z",
    "removed_at": "2025-08-28T18:00:43.129Z",
    "revoked_at": "2025-08-28T18:00:43.129Z",
    "revoke_reason": "text",
    "revoked_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "command_attempts": [
      {
        "id": "411486491630370816",
        "inventory_item_id": "411486491630370816",
        "gameserver_id": "411486491630370816",
        "steam_id": "76561197960287930",
        "minecraft_uuid": "text",
        "customer_name": "text",
        "command_stage": "text",
        "command": "text",
        "online_only": true,
        "rerun": true,
        "queued_at": "2025-08-28T18:00:43.129Z",
        "executed_at": "2025-08-28T18:00:43.129Z",
        "unqueued_at": "2025-08-28T18:00:43.129Z"
      }
    ],
    "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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

customerIdstring · flake-idRequiredExample: 411486491630370816

Body

product_idstring · flake-idOptionalExample: 411486491630370816

product_version_idstring · flake-idOptionalExample: 411486491630370816

execute_on_gameserver_idstring · flake-idOptionalExample: 411486491630370816

quantityinteger · int32 | nullableOptional

Quantity of products to assign.

override_expires_atstring · date-time | nullableOptional

Override expiry date for the delivery item.

skip_commandsboolean | nullableOptional

Skip command execution when assigning the item.

Responses

200

application/json

default

Error response

application/json

post

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

{
  "product_id": "411486491630370816",
  "product_version_id": "411486491630370816",
  "execute_on_gameserver_id": "411486491630370816",
  "quantity": 1,
  "override_expires_at": "2025-08-28T18:00:43.129Z",
  "skip_commands": true,
  "custom_variables": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": "text"
      },
      "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": "text",
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2025-08-28T18:00:43.129Z",
      "updated_at": "2025-08-28T18:00:43.129Z",
      "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": "text"
      },
      "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": "text",
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2025-08-28T18:00:43.129Z",
      "updated_at": "2025-08-28T18:00:43.129Z",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order_line_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "quantity_index": 1,
    "product": {
      "id": "411486491630370816",
      "name": "Premium Membership",
      "slug": "premium-membership",
      "version_id": "v2.1.0"
    },
    "state": "usable",
    "added_at": "2025-08-28T18:00:43.129Z",
    "added_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "active_at": "2025-08-28T18:00:43.129Z",
    "expirable": true,
    "expires_at": "2025-08-28T18:00:43.129Z",
    "override_expires_at": "2025-08-28T18:00:43.129Z",
    "removed_at": "2025-08-28T18:00:43.129Z",
    "revoked_at": "2025-08-28T18:00:43.129Z",
    "revoke_reason": "text",
    "revoked_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "command_attempts": [
      {
        "id": "411486491630370816",
        "inventory_item_id": "411486491630370816",
        "gameserver_id": "411486491630370816",
        "steam_id": "76561197960287930",
        "minecraft_uuid": "text",
        "customer_name": "text",
        "command_stage": "text",
        "command": "text",
        "online_only": true,
        "rerun": true,
        "queued_at": "2025-08-28T18:00:43.129Z",
        "executed_at": "2025-08-28T18:00:43.129Z",
        "unqueued_at": "2025-08-28T18:00:43.129Z"
      }
    ],
    "skip_commands": true,
    "custom_variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "gift": true
  }
]

Revoke a delivery item for a customer

delete

Allows you to revoke a delivery item associated with a customer

Authorizations

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

customerIdstring · flake-idRequiredExample: 411486491630370816

deliveryItemIdstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

No content

default

Error response

application/json

delete

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

No content

Assign delivery items in bulk

post

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

Authorizations

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Bodyobject[]

customer_idstring · flake-idRequiredExample: 411486491630370816

product_version_idstring · flake-idOptionalExample: 411486491630370816

execute_on_gameserver_idstring · flake-idOptionalExample: 411486491630370816

quantityinteger · int32 | nullableOptional

Quantity of products to assign.

override_expires_atstring · date-time | nullableOptional

Override expiry date for the delivery item.

skip_commandsboolean | nullableOptional

Skip command execution when assigning the item.

Responses

200

application/json

default

Error response

application/json

post

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

[
  {
    "customer_id": "411486491630370816",
    "product_version_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "quantity": 1,
    "override_expires_at": "2025-08-28T18:00:43.129Z",
    "skip_commands": true,
    "custom_variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "customer_id": "411486491630370816",
    "customer": {
      "id": "411486491630370816",
      "store_id": "411486491630370816",
      "profile": {
        "id": "text",
        "platform": "steam",
        "name": "text",
        "avatar_url": "text"
      },
      "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": "text",
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2025-08-28T18:00:43.129Z",
      "updated_at": "2025-08-28T18:00:43.129Z",
      "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": "text"
      },
      "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": "text",
      "minecraft_platform": "unknown",
      "name": "m0uka",
      "created_at": "2025-08-28T18:00:43.129Z",
      "updated_at": "2025-08-28T18:00:43.129Z",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "checkout_id": "411486491630370816",
    "checkout_line_id": "411486491630370816",
    "order_id": "411486491630370816",
    "order_line_id": "411486491630370816",
    "subscription_id": "411486491630370816",
    "execute_on_gameserver_id": "411486491630370816",
    "quantity_index": 1,
    "product": {
      "id": "411486491630370816",
      "name": "Premium Membership",
      "slug": "premium-membership",
      "version_id": "v2.1.0"
    },
    "state": "usable",
    "added_at": "2025-08-28T18:00:43.129Z",
    "added_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "active_at": "2025-08-28T18:00:43.129Z",
    "expirable": true,
    "expires_at": "2025-08-28T18:00:43.129Z",
    "override_expires_at": "2025-08-28T18:00:43.129Z",
    "removed_at": "2025-08-28T18:00:43.129Z",
    "revoked_at": "2025-08-28T18:00:43.129Z",
    "revoke_reason": "text",
    "revoked_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "command_attempts": [
      {
        "id": "411486491630370816",
        "inventory_item_id": "411486491630370816",
        "gameserver_id": "411486491630370816",
        "steam_id": "76561197960287930",
        "minecraft_uuid": "text",
        "customer_name": "text",
        "command_stage": "text",
        "command": "text",
        "online_only": true,
        "rerun": true,
        "queued_at": "2025-08-28T18:00:43.129Z",
        "executed_at": "2025-08-28T18:00:43.129Z",
        "unqueued_at": "2025-08-28T18:00:43.129Z"
      }
    ],
    "skip_commands": true,
    "custom_variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "gift": true
  }
]

PreviousCheckout NextCoupons

Was this helpful?