CreatorStoreProduct

Attributes

pathstring

displayNamestring

descriptionstring

basePriceobject

purchasePriceobject

publishedboolean

restrictionsarray<enum>

RESTRICTION_UNSPECIFIED, SOLD_ITEM_RESTRICTED, SELLER_TEMPORARILY_RESTRICTED, SELLER_PERMANENTLY_RESTRICTED, SELLER_NO_LONGER_ACTIVE

purchasableboolean

One of

modelAssetIdstring

pluginAssetIdstring

audioAssetIdstring

decalAssetIdstring

meshPartAssetIdstring

videoAssetIdstring

fontFamilyAssetIdstring

One of

userSellerstring

groupSellerstring

Base URL

https://apis.roblox.com/cloud

The CreatorStoreProduct Resource

{
  "path": "creator-store-products/ProductNamespace-ProductType-123",
  "displayName": "string",
  "description": "string",
  "basePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "purchasePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "published": true,
  "restrictions": "string",
  "purchasable": true,
  "userSeller": "string",
  "modelAssetId": "string"
}

CreatorStoreProduct

Create Creator Store Product

POST /v2/creator-store-products

Scopes

creator-store-product:write

RequestRequest BodyCreatorStoreProduct

ResponseCreatorStoreProduct

POST /v2/creator-store-products

curl -L -X POST 'https://apis.roblox.com/cloud/v2/creator-store-products' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  -d  \
  '{
  "displayName": "string",
  "description": "string",
  "basePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "purchasePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "published": true,
  "modelAssetId": "string"
}'

Response

{
  "path": "creator-store-products/ProductNamespace-ProductType-123",
  "displayName": "string",
  "description": "string",
  "basePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "purchasePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "published": true,
  "restrictions": "string",
  "purchasable": true,
  "userSeller": "string",
  "modelAssetId": "string"
}

CreatorStoreProduct

Get Creator Store Product

GET /v2/creator-store-products/{creator-store-product}

Scopes

creator-store-product:read

RequestPath Parameters

creator-store-productstringRequired

ResponseCreatorStoreProduct

GET /v2/creator-store-products/{creator-store-product}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/creator-store-products/{creator-store-product}' \
  -H 'x-api-key: {your-api-key}'

Response

{
  "path": "creator-store-products/ProductNamespace-ProductType-123",
  "displayName": "string",
  "description": "string",
  "basePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "purchasePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "published": true,
  "restrictions": "string",
  "purchasable": true,
  "userSeller": "string",
  "modelAssetId": "string"
}

CreatorStoreProduct

Update Creator Store Product

PATCH /v2/creator-store-products/{creator-store-product}

Scopes

creator-store-product:write

RequestPath Parameters

creator-store-productstringRequired

Query Parameters

updateMaskstring

allowMissingboolean

Request BodyCreatorStoreProduct

ResponseCreatorStoreProduct

PATCH /v2/creator-store-products/{creator-store-product}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/creator-store-products/{creator-store-product}?updateMask={string}&allowMissing={boolean}' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  -d  \
  '{
  "displayName": "string",
  "description": "string",
  "basePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "purchasePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "published": true,
  "modelAssetId": "string"
}'

Response

{
  "path": "creator-store-products/ProductNamespace-ProductType-123",
  "displayName": "string",
  "description": "string",
  "basePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "purchasePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "published": true,
  "restrictions": "string",
  "purchasable": true,
  "userSeller": "string",
  "modelAssetId": "string"
}