CreatorStoreProduct

Attributes

pathstring

basePriceobject

purchasePriceobject

publishedboolean

restrictionsarray<enum>

Output Only

purchasableboolean

Output Only

One of the following for seller:

userSellerstring

Output Only

groupSellerstring

Output Only

One of the following for productType:

modelAssetIdstring

Immutable

pluginAssetIdstring

Immutable

audioAssetIdstring

Immutable

decalAssetIdstring

Immutable

meshPartAssetIdstring

Immutable

videoAssetIdstring

Immutable

fontFamilyAssetIdstring

Immutable

Base URL

https://apis.roblox.com/cloud

The CreatorStoreProduct Resource

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

CreatorStoreProduct

Create Creator Store Product

POST /cloud/v2/creator-store-products

Scopes

creator-store-product:write

RequestRequest BodyCreatorStoreProduct

ResponseCreatorStoreProduct

POST /cloud/v2/creator-store-products

curl -L -X POST 'https://apis.roblox.com/cloud/v2/creator-store-products' \
  -H 'x-api-key: {your-api-key}' \
  --data '{ \
  "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",
  "basePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "purchasePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "published": true,
  "restrictions": [
    "RESTRICTION_UNSPECIFIED"
  ],
  "purchasable": true,
  "userSeller": "string",
  "modelAssetId": "string"
}

CreatorStoreProduct

Get Creator Store Product

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

Scopes

creator-store-product:read

RequestPath Parameters

creator-store-productstring

Required

ResponseCreatorStoreProduct

GET /cloud/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",
  "basePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "purchasePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "published": true,
  "restrictions": [
    "RESTRICTION_UNSPECIFIED"
  ],
  "purchasable": true,
  "userSeller": "string",
  "modelAssetId": "string"
}

CreatorStoreProduct

Update Creator Store Product

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

Scopes

creator-store-product:write

RequestPath Parameters

creator-store-productstring

Required

Query Parameters

updateMaskstring

allowMissingboolean

Request BodyCreatorStoreProduct

ResponseCreatorStoreProduct

PATCH /cloud/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}' \
  --data '{ \
  "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",
  "basePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "purchasePrice": {
    "currencyCode": "string",
    "quantity": {
      "significand": "integer",
      "exponent": "integer"
    }
  },
  "published": true,
  "restrictions": [
    "RESTRICTION_UNSPECIFIED"
  ],
  "purchasable": true,
  "userSeller": "string",
  "modelAssetId": "string"
}