Products
Retrieves all products for the specified store. DO NOT USE THIS ROUTE FOR DISPLAYING PRODUCTS ON YOUR STOREFRONT, use the storefront API instead.
The ID of the store to retrieve products for.
411486491630370816
GET /v1/stores/{storeId}/products HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"version_id": "411486491630370816",
"image_url": "text",
"slug": "text",
"name": "text",
"description": "text",
"label": "text",
"sort_order": 1,
"price": 1,
"single_game_server_only": true,
"allow_one_time_purchase": true,
"allow_subscription": true,
"subscription_interval_value": 1,
"subscription_interval_scale": "invalid",
"remove_after_enabled": true,
"remove_after_time_value": 1,
"remove_after_time_scale": "invalid",
"stock_available": {
"store_available": 1,
"customer_available": 1
},
"store_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"customer_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"stock_limit_do_not_include_removed": true,
"tags": [
{
"id": "411486491630370816",
"slug": "packages",
"name": "Packages"
}
],
"gameservers": [
{
"id": "411486491630370816",
"name": "US 2x TRIO",
"enabled": true
}
],
"commands": [
{
"stage": "invalid",
"content": "text",
"online_only": true,
"override_execute_on_gameserver_ids": [
"411486491630370816"
]
}
],
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"created_at": "2025-08-01T19:23:48.946Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2025-08-01T19:23:48.946Z",
"deliverable_actions": {
"grant_giftcard": true
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"payout_splits": [
{
"user_id": "411486491630370816",
"percentage": 1,
"platform_fee": 1
}
],
"tax_code": "unknown",
"allow_concurrent_active_items": true,
"disable_promo_codes": true,
"is_hidden": true,
"is_gifting_disabled": true,
"enabled_at": "2025-08-01T19:23:48.946Z",
"enabled_until": "2025-08-01T19:23:48.946Z",
"required_product_ids": [
"411486491630370816"
],
"required_product_all": true,
"custom_variable_ids": [
"411486491630370816"
]
}
]
Creates a new product in the specified store. Creating dynamic products while creating a checkout session via this endpoint without prior approval is prohibited and will result in store deactivation per our User Agreement.
The ID of the store to create the product in.
411486491630370816
The unique URL-safe identifier (slug) for the product.
The display name of the product.
The detailed description of the product.
The display label for the product.
The price of the product in the lowest denominator (e.g. cents).
Indicates whether the customer is prompted to select a game server before purchasing.
Indicates whether one-time purchases are allowed.
Indicates whether subscription purchases are allowed.
The subscription interval value.
Indicates whether automatic removal is enabled.
The time value for automatic removal.
Indicates whether removed items should be excluded from stock limits.
The tag IDs associated with the product.
411486491630370816
The gameserver IDs associated with the product.
411486491630370816
Determines the category of the product for taxation purposes. Contact support for help with setting the correct tax code.
Indicates whether concurrent active items are allowed.
Indicates whether using coupons and gift cards on this product is allowed.
Indicates whether the product is hidden.
Indicates whether gifting is disabled.
The date and time when the product becomes enabled.
Set to null
to keep enabled.
The date and time until which the product remains enabled.
Set to null
to keep enabled.
The IDs of products required for purchasing this product.
411486491630370816
Indicates whether all required products are needed.
The IDs of associated custom variables.
411486491630370816
POST /v1/stores/{storeId}/products HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1250
{
"slug": "text",
"name": "text",
"description": "text",
"label": "text",
"price": 1,
"single_game_server_only": true,
"allow_one_time_purchase": true,
"allow_subscription": true,
"subscription_interval_value": 1,
"subscription_interval_scale": "invalid",
"remove_after_enabled": true,
"remove_after_time_value": 1,
"remove_after_time_scale": "invalid",
"store_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"customer_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"stock_limit_do_not_include_removed": true,
"tags": [
"411486491630370816"
],
"gameservers": [
"411486491630370816"
],
"commands": [
{
"stage": "invalid",
"content": "text",
"online_only": true,
"override_execute_on_gameserver_ids": [
"411486491630370816"
]
}
],
"deliverable_actions": {
"grant_giftcard": true
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"payout_splits": [
{
"user_id": "411486491630370816",
"percentage": 1,
"platform_fee": 1
}
],
"tax_code": "unknown",
"allow_concurrent_active_items": true,
"disable_promo_codes": true,
"is_hidden": true,
"is_gifting_disabled": true,
"enabled_at": "2025-08-01T19:23:48.946Z",
"enabled_until": "2025-08-01T19:23:48.946Z",
"required_product_ids": [
"411486491630370816"
],
"required_product_all": true,
"custom_variable_ids": [
"411486491630370816"
]
}
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"version_id": "411486491630370816",
"image_url": "text",
"slug": "text",
"name": "text",
"description": "text",
"label": "text",
"sort_order": 1,
"price": 1,
"single_game_server_only": true,
"allow_one_time_purchase": true,
"allow_subscription": true,
"subscription_interval_value": 1,
"subscription_interval_scale": "invalid",
"remove_after_enabled": true,
"remove_after_time_value": 1,
"remove_after_time_scale": "invalid",
"stock_available": {
"store_available": 1,
"customer_available": 1
},
"store_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"customer_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"stock_limit_do_not_include_removed": true,
"tags": [
{
"id": "411486491630370816",
"slug": "packages",
"name": "Packages"
}
],
"gameservers": [
{
"id": "411486491630370816",
"name": "US 2x TRIO",
"enabled": true
}
],
"commands": [
{
"stage": "invalid",
"content": "text",
"online_only": true,
"override_execute_on_gameserver_ids": [
"411486491630370816"
]
}
],
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"created_at": "2025-08-01T19:23:48.946Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2025-08-01T19:23:48.946Z",
"deliverable_actions": {
"grant_giftcard": true
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"payout_splits": [
{
"user_id": "411486491630370816",
"percentage": 1,
"platform_fee": 1
}
],
"tax_code": "unknown",
"allow_concurrent_active_items": true,
"disable_promo_codes": true,
"is_hidden": true,
"is_gifting_disabled": true,
"enabled_at": "2025-08-01T19:23:48.946Z",
"enabled_until": "2025-08-01T19:23:48.946Z",
"required_product_ids": [
"411486491630370816"
],
"required_product_all": true,
"custom_variable_ids": [
"411486491630370816"
]
}
Retrieves a specific product by ID from the specified store. DO NOT USE THIS ROUTE FOR DISPLAYING PRODUCTS ON YOUR STOREFRONT, use the storefront API instead.
The ID of the store the product belongs to.
411486491630370816
The ID of the product to retrieve.
411486491630370816
GET /v1/stores/{storeId}/products/{productId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"version_id": "411486491630370816",
"image_url": "text",
"slug": "text",
"name": "text",
"description": "text",
"label": "text",
"sort_order": 1,
"price": 1,
"single_game_server_only": true,
"allow_one_time_purchase": true,
"allow_subscription": true,
"subscription_interval_value": 1,
"subscription_interval_scale": "invalid",
"remove_after_enabled": true,
"remove_after_time_value": 1,
"remove_after_time_scale": "invalid",
"stock_available": {
"store_available": 1,
"customer_available": 1
},
"store_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"customer_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"stock_limit_do_not_include_removed": true,
"tags": [
{
"id": "411486491630370816",
"slug": "packages",
"name": "Packages"
}
],
"gameservers": [
{
"id": "411486491630370816",
"name": "US 2x TRIO",
"enabled": true
}
],
"commands": [
{
"stage": "invalid",
"content": "text",
"online_only": true,
"override_execute_on_gameserver_ids": [
"411486491630370816"
]
}
],
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"created_at": "2025-08-01T19:23:48.946Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2025-08-01T19:23:48.946Z",
"deliverable_actions": {
"grant_giftcard": true
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"payout_splits": [
{
"user_id": "411486491630370816",
"percentage": 1,
"platform_fee": 1
}
],
"tax_code": "unknown",
"allow_concurrent_active_items": true,
"disable_promo_codes": true,
"is_hidden": true,
"is_gifting_disabled": true,
"enabled_at": "2025-08-01T19:23:48.946Z",
"enabled_until": "2025-08-01T19:23:48.946Z",
"required_product_ids": [
"411486491630370816"
],
"required_product_all": true,
"custom_variable_ids": [
"411486491630370816"
]
}
Deletes a product from the specified store.
The ID of the store the product belongs to.
411486491630370816
The ID of the product to delete.
411486491630370816
DELETE /v1/stores/{storeId}/products/{productId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
Updates an existing product in the specified store.
The ID of the store the product belongs to.
411486491630370816
The ID of the product to update.
411486491630370816
The unique URL-safe identifier (slug) for the product.
The display name of the product.
The detailed description of the product.
The display label for the product.
The price of the product in the lowest denominator (e.g. cents).
Indicates whether the customer is prompted to select a game server before purchasing.
Indicates whether one-time purchases are allowed.
Indicates whether subscription purchases are allowed.
The subscription interval value.
Indicates whether automatic removal is enabled.
The time value for automatic removal.
Indicates whether removed items should be excluded from stock limits.
The tag IDs associated with the product.
411486491630370816
The gameserver IDs associated with the product.
411486491630370816
Determines the category of the product for taxation purposes. Contact support for help with setting the correct tax code.
Indicates whether concurrent active items are allowed.
Indicates whether using coupons and gift cards on this product is allowed.
Indicates whether the product is hidden.
Indicates whether gifting is disabled.
The date and time when the product becomes enabled.
Set to null
to keep enabled.
The date and time until which the product remains enabled.
Set to null
to keep enabled.
The IDs of products required for purchasing this product.
411486491630370816
Indicates whether all required products are needed.
The IDs of associated custom variables.
411486491630370816
PATCH /v1/stores/{storeId}/products/{productId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1250
{
"slug": "text",
"name": "text",
"description": "text",
"label": "text",
"price": 1,
"single_game_server_only": true,
"allow_one_time_purchase": true,
"allow_subscription": true,
"subscription_interval_value": 1,
"subscription_interval_scale": "invalid",
"remove_after_enabled": true,
"remove_after_time_value": 1,
"remove_after_time_scale": "invalid",
"store_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"customer_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"stock_limit_do_not_include_removed": true,
"tags": [
"411486491630370816"
],
"gameservers": [
"411486491630370816"
],
"commands": [
{
"stage": "invalid",
"content": "text",
"online_only": true,
"override_execute_on_gameserver_ids": [
"411486491630370816"
]
}
],
"deliverable_actions": {
"grant_giftcard": true
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"payout_splits": [
{
"user_id": "411486491630370816",
"percentage": 1,
"platform_fee": 1
}
],
"tax_code": "unknown",
"allow_concurrent_active_items": true,
"disable_promo_codes": true,
"is_hidden": true,
"is_gifting_disabled": true,
"enabled_at": "2025-08-01T19:23:48.946Z",
"enabled_until": "2025-08-01T19:23:48.946Z",
"required_product_ids": [
"411486491630370816"
],
"required_product_all": true,
"custom_variable_ids": [
"411486491630370816"
]
}
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"version_id": "411486491630370816",
"image_url": "text",
"slug": "text",
"name": "text",
"description": "text",
"label": "text",
"sort_order": 1,
"price": 1,
"single_game_server_only": true,
"allow_one_time_purchase": true,
"allow_subscription": true,
"subscription_interval_value": 1,
"subscription_interval_scale": "invalid",
"remove_after_enabled": true,
"remove_after_time_value": 1,
"remove_after_time_scale": "invalid",
"stock_available": {
"store_available": 1,
"customer_available": 1
},
"store_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"customer_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"stock_limit_do_not_include_removed": true,
"tags": [
{
"id": "411486491630370816",
"slug": "packages",
"name": "Packages"
}
],
"gameservers": [
{
"id": "411486491630370816",
"name": "US 2x TRIO",
"enabled": true
}
],
"commands": [
{
"stage": "invalid",
"content": "text",
"online_only": true,
"override_execute_on_gameserver_ids": [
"411486491630370816"
]
}
],
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"created_at": "2025-08-01T19:23:48.946Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2025-08-01T19:23:48.946Z",
"deliverable_actions": {
"grant_giftcard": true
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"payout_splits": [
{
"user_id": "411486491630370816",
"percentage": 1,
"platform_fee": 1
}
],
"tax_code": "unknown",
"allow_concurrent_active_items": true,
"disable_promo_codes": true,
"is_hidden": true,
"is_gifting_disabled": true,
"enabled_at": "2025-08-01T19:23:48.946Z",
"enabled_until": "2025-08-01T19:23:48.946Z",
"required_product_ids": [
"411486491630370816"
],
"required_product_all": true,
"custom_variable_ids": [
"411486491630370816"
]
}
Updates the sort order of products in the specified store.
The ID of the store to update product sort order in.
411486491630370816
An array of product IDs in the order that they should be sorted.
411486491630370816
POST /v1/stores/{storeId}/products/sort-order HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"product_ids": [
"411486491630370816"
]
}
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"version_id": "411486491630370816",
"image_url": "text",
"slug": "text",
"name": "text",
"description": "text",
"label": "text",
"sort_order": 1,
"price": 1,
"single_game_server_only": true,
"allow_one_time_purchase": true,
"allow_subscription": true,
"subscription_interval_value": 1,
"subscription_interval_scale": "invalid",
"remove_after_enabled": true,
"remove_after_time_value": 1,
"remove_after_time_scale": "invalid",
"stock_available": {
"store_available": 1,
"customer_available": 1
},
"store_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"customer_stock_limit": {
"enabled": true,
"quantity": 1,
"time_value": 1,
"time_scale": "invalid"
},
"stock_limit_do_not_include_removed": true,
"tags": [
{
"id": "411486491630370816",
"slug": "packages",
"name": "Packages"
}
],
"gameservers": [
{
"id": "411486491630370816",
"name": "US 2x TRIO",
"enabled": true
}
],
"commands": [
{
"stage": "invalid",
"content": "text",
"online_only": true,
"override_execute_on_gameserver_ids": [
"411486491630370816"
]
}
],
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"created_at": "2025-08-01T19:23:48.946Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"updated_at": "2025-08-01T19:23:48.946Z",
"deliverable_actions": {
"grant_giftcard": true
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"payout_splits": [
{
"user_id": "411486491630370816",
"percentage": 1,
"platform_fee": 1
}
],
"tax_code": "unknown",
"allow_concurrent_active_items": true,
"disable_promo_codes": true,
"is_hidden": true,
"is_gifting_disabled": true,
"enabled_at": "2025-08-01T19:23:48.946Z",
"enabled_until": "2025-08-01T19:23:48.946Z",
"required_product_ids": [
"411486491630370816"
],
"required_product_all": true,
"custom_variable_ids": [
"411486491630370816"
]
}
Was this helpful?