Parcel Public API v2
  • Homepage
  • Discord Server
  • Customer Support
  • 🔑Obtain API Key
    • Create an API Key
    • Developer Portal
  • 🏢Hub Endpoints
    • Fetch Hub Information
    • Update Hub Information
  • 🛍️Product Endpoints
    • Fetch Product Information
    • Create a new Product
    • Update an existing Product
    • Delete an existing Product
  • 📝Whitelist Endpoints
    • Check Whitelist
    • Give Whitelist
    • Transfer Whitelist
    • Revoke Whitelist
Powered by GitBook
On this page

Was this helpful?

  1. Product Endpoints

Create a new Product

Create a new Product within your Hub

Initiate the creation of a new product within your hub, defining its attributes for seamless integration and management within your ecosystem. This endpoint facilitates the expansion of your product offerings in a structured manner.

Create a new Product

POST https://v2.parcelroblox.com/products/create

Headers

Name
Type
Description

Authorization*

string

prod_DGzVhVsrqNJi4b0Chd9mMPUI9

Content-Type

string

application/json

Request Body

Name
Type
Description

name*

string

Product Name

description*

string

Product Description

developer_product_id*

string

Roblox Developer Product ID

file*

string

File URL (or text message)

onsale*

boolean

Product Sale Status

role_id*

string / null

Discord Buyer Role ID

decal_id*

string / null

Roblox Decal ID

stock*

string

Product Stock

category*

string / null

Product Category

instructions*

string / null

Product Delivery Instructions

If everything was able to process properly:

{ "status": "200", "message": "OK", "data": { "state": "Product created", "product": object } }

If you did not follow the schema:

{ "status": "400", "message": "Your payload did not pass the Schema validation.", "error": string, "data": {} }

If the product name that you supplied is already registered:

{ "status": "400", "message": "The name '' is already in-use.\nPlease use a different product name.", "data": {} }

If the Roblox Developer Product ID that you supplied does not exist:

{ "status": "400", "message": "Developer Product ID could not be found.\nAre you sure that you've entered the correct developer product ID?\nPossible solution: Make sure the Developer Product exists in the Hub game.", "data": {} }

If you did not supply a Discord Buyer Role ID (Parcel Pro only):

{ "status": "400", "message": "Missing role_id or invalid input.", "data": {} }

If you did not supply a Product Stock (Parcel Pro only):

{ "status": "400", "message": "Missing stock or invalid input. Please respond with a number between 0-999 or unlimited.", "data": {} }

If you the Product Stock you supplied is not within the number range (Parcel Pro only):

{ "status": "400", "message": "On the stock field, please respond with a number between 0-999.", "data": {} }

If you did not supply Product Delivery Instructions (Parcel Pro only):

{ "status": "400", "message": "Missing instructions or invalid input.", "data": {} }

If your current tier does not support certain fields:

{ "status": "403", "message": "Access forbidden: Your tier (Parcel Free) does not allow configuring stock, instructions, or role_id.", "data": {} }

If you provided an invalid authorization key:

{ "status": "401", "message": "Invalid authorization key." }

If you did not provide an authorization key:

{ "status": "401", "message": "No authorization key was provided." }

If something was wrong on our end:

{ "status": "500", "message": "Internal Server Error" }
PreviousFetch Product InformationNextUpdate an existing Product

Last updated 12 months ago

Was this helpful?

🛍️