Item Configuration v1

Reference for the Item Configuration v1 endpoints on Roblox.

Base URL: https://itemconfiguration.roblox.com

Endpoints

Method	Path	Name
`POST`	`/v1/creations/get-asset-details`	`postCreationsGetAssetDetails`
`GET`	`/v1/creations/get-assets`	`getCreationsGetAssets`
`GET`	`/v1/preferences/publishing`	`getPreferencesPublishing`
`POST`	`/v1/preferences/publishing`	`postPreferencesPublishing`
`DELETE`	`/v1/preferences/publishing`	`deletePreferencesPublishing`
`PATCH`	`/v1/preferences/publishing`	`patchPreferencesPublishing`

`postCreationsGetAssetDetails`

POST /v1/creations/get-asset-details

Gets the asset status and other configuration details for the given assetIds list.

Usage

import { fetchApi } from 'rozod';
import { postCreationsGetAssetDetails } from 'rozod/endpoints/itemconfigurationv1';

const data = await fetchApi(postCreationsGetAssetDetails, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`AssetIds`	`number[]`

Response

Array of objects:

Field	Type	Description
`assetId`	`number`
`name`	`string`
`status`	`“Unknown”	“ReviewPending”
`description`	`string`
`creatorType`	`string`
`creatorTargetId`	`number`
`isArchived`	`boolean`
`assetType`	`string`
`created`	`string`
`updated`	`string`

Errors

Status	Description
400	1: Missing AssetIds parameters 2: Invalid asset Ids
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed
414	3: Too many asset Ids
429	9: Flood Limit Exceeded
503	6: Service Unavailable

`getCreationsGetAssets`

GET /v1/creations/get-assets

Gets the user created asset information filtered by the given asset type.

Usage

import { fetchApi } from 'rozod';
import { getCreationsGetAssets } from 'rozod/endpoints/itemconfigurationv1';

const data = await fetchApi(getCreationsGetAssets, {
  assetType: /* string */,
  isArchived: /* boolean? */,
  groupId: /* integer? */,
  cursor: /* string? */
});

Parameters

Name	Type	Required	Description
`assetType`	`string`	Yes
`isArchived`	`boolean?`	No
`groupId`	`integer?`	No
`cursor`	`string?`	No	The paging cursor for the previous or next page.

Response

Field	Type	Description
`previousPageCursor`	`string`
`nextPageCursor`	`string`
`data`	`object[]`	See below

data[] item fields:

Field	Type	Description
`assetId`	`number`
`name`	`string`

Errors

Status	Description
400	5: Invalid assetType 10: Invalid Asset Category
401	0: Authorization has been denied for this request.
403	7: User does not have necessary permissions for group 8: Asset type does not have necessary permissions for group
429	9: Flood Limit Exceeded
503	6: Service Unavailable

`getPreferencesPublishing`

GET /v1/preferences/publishing

Usage

import { fetchApi } from 'rozod';
import { getPreferencesPublishing } from 'rozod/endpoints/itemconfigurationv1';

const data = await fetchApi(getPreferencesPublishing, {
  groupId: /* integer? */
});

Parameters

Name	Type	Required	Description
`groupId`	`integer?`	No

Response

Field	Type	Description
`id`	`string`
`creatorUserId`	`number`
`creatorGroupId`	`number`
`publishingType`	`“Invalid”	“Limited”
`saleLocationType`	`“SALE_LOCATION_TYPE_INVALID”	“SALE_LOCATION_TYPE_SHOP_AND_ALL_EXPERIENCES”
`places`	`number[]`
`priceInRobux`	`number`
`priceOffset`	`number`
`isFree`	`boolean`
`enableRegionalPricing`	`boolean`
`isRentalOptIn`	`boolean`
`autoPublishEnabled`	`boolean`
`created`	`string`
`updated`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request.

`postPreferencesPublishing`

POST /v1/preferences/publishing

Usage

import { fetchApi } from 'rozod';
import { postPreferencesPublishing } from 'rozod/endpoints/itemconfigurationv1';

const data = await fetchApi(postPreferencesPublishing, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`creatorUserId`	`number`
`creatorGroupId`	`number`
`publishingType`	`“Invalid”	“Limited”
`saleLocationType`	`“SALE_LOCATION_TYPE_INVALID”	“SALE_LOCATION_TYPE_SHOP_AND_ALL_EXPERIENCES”
`places`	`number[]`
`priceInRobux`	`number`
`priceOffset`	`number`
`isFree`	`boolean`
`enableRegionalPricing`	`boolean`
`isRentalOptIn`	`boolean`
`autoPublishEnabled`	`boolean`

Response

Field	Type	Description
`id`	`string`
`creatorUserId`	`number`
`creatorGroupId`	`number`
`publishingType`	`“Invalid”	“Limited”
`saleLocationType`	`“SALE_LOCATION_TYPE_INVALID”	“SALE_LOCATION_TYPE_SHOP_AND_ALL_EXPERIENCES”
`places`	`number[]`
`priceInRobux`	`number`
`priceOffset`	`number`
`isFree`	`boolean`
`enableRegionalPricing`	`boolean`
`isRentalOptIn`	`boolean`
`autoPublishEnabled`	`boolean`
`created`	`string`
`updated`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`deletePreferencesPublishing`

DELETE /v1/preferences/publishing

Usage

import { fetchApi } from 'rozod';
import { deletePreferencesPublishing } from 'rozod/endpoints/itemconfigurationv1';

const data = await fetchApi(deletePreferencesPublishing, {
  groupId: /* integer? */
});

Parameters

Name	Type	Required	Description
`groupId`	`integer?`	No

Response

Type: unknown

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`patchPreferencesPublishing`

PATCH /v1/preferences/publishing

Usage

import { fetchApi } from 'rozod';
import { patchPreferencesPublishing } from 'rozod/endpoints/itemconfigurationv1';

const data = await fetchApi(patchPreferencesPublishing, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`creatorUserId`	`number`
`creatorGroupId`	`number`
`publishingType`	`0	1
`saleLocationType`	`0	1
`places`	`number[]`
`priceInRobux`	`number`
`priceOffset`	`number`
`isFree`	`boolean`
`enableRegionalPricing`	`boolean`
`isRentalOptIn`	`boolean`
`autoPublishEnabled`	`boolean`

Response

Field	Type	Description
`id`	`string`
`creatorUserId`	`number`
`creatorGroupId`	`number`
`publishingType`	`“Invalid”	“Limited”
`saleLocationType`	`“SALE_LOCATION_TYPE_INVALID”	“SALE_LOCATION_TYPE_SHOP_AND_ALL_EXPERIENCES”
`places`	`number[]`
`priceInRobux`	`number`
`priceOffset`	`number`
`isFree`	`boolean`
`enableRegionalPricing`	`boolean`
`isRentalOptIn`	`boolean`
`autoPublishEnabled`	`boolean`
`created`	`string`
`updated`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed