Discord
get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
productVersionIdstring · flake-idRequiredExample:
411486491630370816
Responses
200
OK
application/json
default
Error response
application/json
get
GET /v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"product_id": "411486491630370816",
"product_version_id": "411486491630370816",
"discord_server_id": "411486491630370816",
"execution_stage": "on_purchase",
"revocation_stages": [
"on_expire"
],
"action_type": "persist_role",
"channel_id": "411486491630370816",
"role_id": "411486491630370816",
"message": "text"
}
]
put
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
productVersionIdstring · flake-idRequiredExample:
411486491630370816
Bodyobject[]
discord_server_idstring · flake-idRequiredExample:
411486491630370816
action_typestring · enumRequiredPossible values:
execution_stagestring · enumRequiredPossible values:
channel_idstring · flake-idOptionalExample:
411486491630370816
role_idstring · flake-idOptionalExample:
411486491630370816
messagestring | nullableOptional
Responses
200
OK
application/json
default
Error response
application/json
put
PUT /v1/stores/{storeId}/product_versions/{productVersionId}/discord_actions HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 221
[
{
"discord_server_id": "411486491630370816",
"action_type": "persist_role",
"execution_stage": "on_purchase",
"revocation_stages": [
"on_expire"
],
"channel_id": "411486491630370816",
"role_id": "411486491630370816",
"message": "text"
}
]
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"product_id": "411486491630370816",
"product_version_id": "411486491630370816",
"discord_server_id": "411486491630370816",
"execution_stage": "on_purchase",
"revocation_stages": [
"on_expire"
],
"action_type": "persist_role",
"channel_id": "411486491630370816",
"role_id": "411486491630370816",
"message": "text"
}
get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
orderIdstring · flake-idRequiredExample:
411486491630370816
Responses
200
OK
application/json
default
Error response
application/json
get
GET /v1/stores/{storeId}/orders/{orderId}/discord HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": {
"discord_id": "411486491630370816",
"username": "text",
"avatar_hash": "text"
}
}
get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
orderIdstring · flake-idRequiredExample:
411486491630370816
Responses
200
OK
application/json
default
Error response
application/json
get
GET /v1/stores/{storeId}/orders/{orderId}/discord/queued HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": 1,
"execution_stage": "on_purchase",
"status": "active",
"store_id": "411486491630370816",
"order_id": "411486491630370816",
"delivery_item_id": "411486491630370816",
"checkout_id": "411486491630370816",
"checkout_line_id": "411486491630370816",
"product_id": "411486491630370816",
"product_version_id": "411486491630370816",
"discord_server_id": "411486491630370816",
"action_type": "persist_role",
"discord_user_id": "411486491630370816",
"channel_id": "411486491630370816",
"role_id": "411486491630370816",
"message": "text",
"revocation_stages": [
"on_expire"
],
"enqueued_at": "2025-08-01T19:19:39.511Z",
"finalised_at": "2025-08-01T19:19:39.511Z",
"executions": [
{
"id": 1,
"queue_id": 1,
"executed_at": "2025-08-01T19:19:39.511Z",
"execution_status": "success",
"message": "text",
"trace_id": "text"
}
]
}
]
get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
inventoryItemIdstring · flake-idRequiredExample:
411486491630370816
Responses
200
OK
application/json
default
Error response
application/json
get
GET /v1/stores/{storeId}/inventory/{inventoryItemId}/discord/queued HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": 1,
"execution_stage": "on_purchase",
"status": "active",
"store_id": "411486491630370816",
"order_id": "411486491630370816",
"delivery_item_id": "411486491630370816",
"checkout_id": "411486491630370816",
"checkout_line_id": "411486491630370816",
"product_id": "411486491630370816",
"product_version_id": "411486491630370816",
"discord_server_id": "411486491630370816",
"action_type": "persist_role",
"discord_user_id": "411486491630370816",
"channel_id": "411486491630370816",
"role_id": "411486491630370816",
"message": "text",
"revocation_stages": [
"on_expire"
],
"enqueued_at": "2025-08-01T19:19:39.511Z",
"finalised_at": "2025-08-01T19:19:39.511Z",
"executions": [
{
"id": 1,
"queue_id": 1,
"executed_at": "2025-08-01T19:19:39.511Z",
"execution_status": "success",
"message": "text",
"trace_id": "text"
}
]
}
]
get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
inventoryItemIdstring · flake-idRequiredExample:
411486491630370816
Responses
200
OK
application/json
default
Error response
application/json
get
GET /v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"discord_id": "411486491630370816",
"username": "text",
"avatar_hash": "text"
}
put
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
inventoryItemIdstring · flake-idRequiredExample:
411486491630370816
Query parameters
discordUserIdinteger · int64Optional
Responses
200
OK
default
Error response
application/json
put
PUT /v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
delete
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
inventoryItemIdstring · flake-idRequiredExample:
411486491630370816
Responses
200
OK
default
Error response
application/json
delete
DELETE /v1/stores/{storeId}/inventory/{inventoryItemId}/discord/link HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
Responses
200
OK
application/json
default
Error response
application/json
get
GET /v1/stores/{storeId}/discord/links HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"token": "text",
"store_id": "411486491630370816",
"server_id": "411486491630370816",
"server_name": "text",
"server_icon_url": "text",
"created_at": "2025-08-01T19:19:39.511Z",
"linked_at": "2025-08-01T19:19:39.511Z"
}
]
post
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
Responses
200
OK
application/json
default
Error response
application/json
post
POST /v1/stores/{storeId}/discord/links HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"token": "text",
"store_id": "411486491630370816",
"server_id": "411486491630370816",
"server_name": "text",
"server_icon_url": "text",
"created_at": "2025-08-01T19:19:39.511Z",
"linked_at": "2025-08-01T19:19:39.511Z"
}
delete
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
tokenstringRequired
Responses
200
OK
application/json
default
Error response
application/json
delete
DELETE /v1/stores/{storeId}/discord/links/{token} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"token": "text",
"store_id": "411486491630370816",
"server_id": "411486491630370816",
"server_name": "text",
"server_icon_url": "text",
"created_at": "2025-08-01T19:19:39.511Z",
"linked_at": "2025-08-01T19:19:39.511Z"
}
]
get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
discordServerIdinteger · int64Required
Responses
200
OK
application/json
default
Error response
application/json
get
GET /v1/stores/{storeId}/discord/{discordServerId}/roles HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": "411486491630370816",
"name": "text"
}
]
get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
discordServerIdinteger · int64Required
Responses
200
OK
application/json
default
Error response
application/json
get
GET /v1/stores/{storeId}/discord/{discordServerId}/discord/text_channels HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": "text",
"name": "text",
"category": "text"
}
]
Was this helpful?