API Reference

Create a product

post
https://forge.gg/forge-direct/v1/shop/products

Access

This endpoint requires API key (header X-API-KEY).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 100

Product name or title

string
required
length between 1 and 1000

Detailed product description

uri
required

URL to the product image

tags
array of strings
length ≤ 10

Product tags for categorization and search

tags
price
object
required

Pricing information for the product

string
enum
required

How the product is delivered to the user

Allowed:
codes
array of strings

List of redemption codes (Mandatory when redemption_type is 'Codes', Not providing might set the quantity to 0)

codes
metadata
object
required

Arbitrary JSON structure

string
length between 1 and 50

Product category for organization

boolean
Defaults to false

Whether the product is currently active and available for purchase

integer
≥ 0

Available stock quantity (ignored if unlimited_stock is true)

integer
≥ 1
Defaults to 1

Maximum quantity a single user can purchase

boolean
required
Defaults to false

Whether the product has unlimited stock availability

Responses

Updated 8 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago

Did this page help you?