> ## Documentation Index > Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Draft Item > Retrieves an item from the working catalog. This item represents the current working state of the item. GetDraftItem does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note that item references data is cached and may take a few moments for changes to propagate. Note: SAS tokens provided are valid for 1 hour. Allowed entity token types: title, master_player_account, title_player_account ## Error codes This operation may return the following PlayFab errors: | Error | Code | | --- | --- | | DatabaseThroughputExceeded | 1113 | | ItemNotFound | 1047 | | NotImplemented | 1515 | ## OpenAPI ````yaml post /Catalog/GetDraftItem openapi: 3.0.0 info: version: '260922' title: PlayFab Economy API description: >- API methods for managing the catalog. Inventory manages in-game assets for any given entity. API methods for managing the versioned catalogs. termsOfService: https://playfab.com/terms/ contact: url: https://community.playfab.com/index.html license: name: Apache 2.0 url: https://github.com/PlayFab/API_Specs/blob/master/LICENSE servers: - url: https://{titleId}.playfabapi.com description: PlayFab title endpoint variables: titleId: default: your_title_id description: Your PlayFab title ID (hex). security: [] tags: - name: Catalog description: |- Catalog Management APIs. In general for Catalog APIs, Read APIs are limited to 100 requests in 60 seconds for Player Entities while Title Entities are limited to 10000 requests in 10 seconds. For Write APIs, Player Entities are limited to 10 requests in 30 seconds and Title Entities are limited to 1000 requests in 10 seconds. - name: Inventory description: |- Player Inventory Management APIs. Inventory operations work on an eventually consistent system against a cache of the Catalog. It can take a few moments for changes to propagate. In general for Inventory APIs, Read APIs are limited to 100 requests in 60 seconds for Player Entities while Title Entities are limited to 10000 requests in 10 seconds. For Write APIs, Player Entities are limited to 30 requests in 90 seconds and Title Entities are limited to 1000 requests in 10 seconds. - name: VersionedCatalog description: '' paths: /Catalog/GetDraftItem: post: tags: - Catalog summary: Get Draft Item description: > Retrieves an item from the working catalog. This item represents the current working state of the item. GetDraftItem does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note that item references data is cached and may take a few moments for changes to propagate. Note: SAS tokens provided are valid for 1 hour. Allowed entity token types: title, master_player_account, title_player_account ## Error codes This operation may return the following PlayFab errors: | Error | Code | | --- | --- | | DatabaseThroughputExceeded | 1113 | | ItemNotFound | 1047 | | NotImplemented | 1515 | operationId: GetDraftItem requestBody: content: application/json: schema: $ref: '#/components/schemas/GetDraftItemRequest' responses: '200': $ref: '#/components/responses/GetDraftItemResponse' '400': $ref: '#/components/responses/ApiErrorWrapper' security: - EntityToken: [] components: schemas: GetDraftItemRequest: type: object properties: AlternateId: allOf: - $ref: '#/components/schemas/CatalogAlternateId' description: An alternate ID associated with this item. CustomTags: description: >- The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). type: object Entity: allOf: - $ref: '#/components/schemas/EntityKey' description: The entity to perform this action on. Id: description: The unique ID of the item. type: string example: Id: dddddddd-dddd-dddd-dddd-dddddddddddd CatalogAlternateId: type: object properties: Type: description: Type of the alternate ID. type: string Value: description: Value of the alternate ID. type: string EntityKey: description: >- Combined entity type and ID structure which uniquely identifies a single entity. type: object properties: Id: description: Unique ID of the entity. type: string Type: description: >- Entity type. See https://learn.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types type: string required: - Id GetDraftItemResponse: type: object properties: Item: allOf: - $ref: '#/components/schemas/CatalogItem' description: Full metadata of the catalog item requested. example: Item: Id: dddddddd-dddd-dddd-dddd-dddddddddddd Type: ugc Title: NEUTRAL: Neutral title en-US: US English title Description: NEUTRAL: Neutral description en-US: US English description Keywords: NEUTRAL: Values: - Keyword_1 - Keyword_2 ContentType: example item CreatorEntity: Id: someId Type: title_player_account TypeString: title_player_account IsHidden: false Tags: - pirates - holiday DisplayVersion: 1.0.0 CreationDate: '2018-08-17T22:32:10.4729879+00:00' LastModifiedDate: '2018-08-17T22:32:31.911375+00:00' Contents: - Id: 00000000-0000-0000-0000-000000000001 Url: >- https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip MaxClientVersion: 2.4.1 MinClientVersion: 2.0.0 Images: - Id: 00000000-0000-0000-0000-000000000003 Type: Thumbnail Url: >- https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg DisplayProperties: mapDetails: mapType: desertIsland gameMode: capture maxPlayers: 16 averageMatchLengthInSeconds: 947 ETag: opaqueString DefaultStackId: Static_Default_Stack_Id ApiErrorWrapper: description: The basic wrapper around every failed API response type: object properties: code: description: Numerical HTTP code type: integer status: description: String HTTP code type: string error: description: Playfab error code type: string errorCode: description: Numerical PlayFab error code type: integer errorMessage: description: Description for the PlayFab errorCode type: string errorDetails: description: Detailed description of individual issues with the request object type: object required: - code - errorCode CatalogItem: type: object properties: AlternateIds: description: >- The alternate IDs associated with this item. An alternate ID can be set to 'FriendlyId' or any of the supported marketplace names. type: array items: $ref: '#/components/schemas/CatalogAlternateId' x-isclass: true Contents: description: >- The set of content/files associated with this item. Up to 100 files can be added to an item. type: array items: $ref: '#/components/schemas/Content' x-isclass: true ContentType: description: The client-defined type of the item. type: string CreationDate: description: The date and time when this item was created. type: string CreatorEntity: allOf: - $ref: '#/components/schemas/EntityKey' description: The ID of the creator of this catalog item. DeepLinks: description: The set of platform specific deep links for this item. type: array items: $ref: '#/components/schemas/DeepLink' x-isclass: true DefaultStackId: description: >- The Stack Id that will be used as default for this item in Inventory when an explicit one is not provided. This DefaultStackId can be a static stack id or '{guid}', which will generate a unique stack id for the item. If null, Inventory's default stack id will be used. type: string Description: description: >- A dictionary of localized descriptions. Key is language code and localized string is the value. The NEUTRAL locale is required. Descriptions have a 10000 character limit per country code. type: object DisplayProperties: description: >- Game specific properties for display purposes. This is an arbitrary JSON blob. The Display Properties field has a 10000 byte limit per item. type: object DisplayVersion: description: >- The user provided version of the item for display purposes. Maximum character length of 50. type: string EndDate: description: >- The date of when the item will cease to be available. If not provided then the product will be available indefinitely. type: string ETag: description: >- The current ETag value that can be used for optimistic concurrency in the If-None-Match header. type: string Id: description: The unique ID of the item. type: string Images: description: >- The images associated with this item. Images can be thumbnails or screenshots. Up to 100 images can be added to an item. Only .png, .jpg, .gif, and .bmp file types can be uploaded type: array items: $ref: '#/components/schemas/Image' x-isclass: true IsHidden: description: Indicates if the item is hidden. type: boolean ItemReferences: description: >- The item references associated with this item. For example, the items in a Bundle/Store/Subscription. Every item can have up to 50 item references. type: array items: $ref: '#/components/schemas/CatalogItemReference' x-isclass: true Keywords: allOf: - $ref: '#/components/schemas/KeywordSet' description: >- A dictionary of localized keywords. Key is language code and localized list of keywords is the value. Keywords have a 50 character limit per keyword and up to 32 keywords can be added per country code. LastModifiedDate: description: The date and time this item was last updated. type: string Moderation: allOf: - $ref: '#/components/schemas/ModerationState' description: The moderation state for this item. Platforms: description: The platforms supported by this item. type: array items: type: string PriceOptions: allOf: - $ref: '#/components/schemas/CatalogPriceOptions' description: The prices the item can be purchased for. Rating: allOf: - $ref: '#/components/schemas/Rating' description: Rating summary for this item. RealMoneyPriceDetails: allOf: - $ref: '#/components/schemas/RealMoneyPriceDetails' description: The real price the item was purchased for per marketplace. StartDate: description: >- The date of when the item will be available. If not provided then the product will appear immediately. type: string StoreDetails: allOf: - $ref: '#/components/schemas/StoreDetails' description: Optional details for stores items. Tags: description: >- The list of tags that are associated with this item. Up to 32 tags can be added to an item. type: array items: type: string Title: description: >- A dictionary of localized titles. Key is language code and localized string is the value. The NEUTRAL locale is required. Titles have a 512 character limit per country code. type: object Type: description: >- The high-level type of the item. The following item types are supported: bundle, catalogItem, currency, store, ugc, subscription. type: string Content: type: object properties: Id: description: The content unique ID. type: string MaxClientVersion: description: >- The maximum client version that this content is compatible with. Client Versions can be up to 3 segments separated by periods(.) and each segment can have a maximum value of 65535. type: string MinClientVersion: description: >- The minimum client version that this content is compatible with. Client Versions can be up to 3 segments separated by periods(.) and each segment can have a maximum value of 65535. type: string Tags: description: >- The list of tags that are associated with this content. Tags must be defined in the Catalog Config before being used in content. type: array items: type: string Type: description: >- The client-defined type of the content. Content Types must be defined in the Catalog Config before being used. type: string Url: description: The Azure CDN URL for retrieval of the catalog item binary content. type: string DeepLink: type: object properties: Platform: description: Target platform for this deep link. type: string Url: description: The deep link for this platform. type: string Image: type: object properties: Id: description: The image unique ID. type: string Tag: description: >- The client-defined tag associated with this image. Tags must be defined in the Catalog Config before being used in images type: string Type: description: >- Images can be defined as either a "thumbnail" or "screenshot". There can only be one "thumbnail" image per item. type: string Url: description: The URL for retrieval of the image. type: string CatalogItemReference: type: object properties: Amount: description: The amount of the catalog item. type: number x-actualtype: int32 Id: description: The unique ID of the catalog item. type: string PriceOptions: allOf: - $ref: '#/components/schemas/CatalogPriceOptions' description: The prices the catalog item can be purchased for. KeywordSet: type: object properties: Values: description: A list of localized keywords. type: array items: type: string ModerationState: type: object properties: LastModifiedDate: description: The date and time this moderation state was last updated. type: string Reason: description: The current stated reason for the associated item being moderated. type: string Status: allOf: - $ref: '#/components/schemas/ModerationStatus' description: The current moderation status for the associated item. CatalogPriceOptions: type: object properties: Prices: description: Prices of the catalog item. An item can have up to 15 prices type: array items: $ref: '#/components/schemas/CatalogPrice' x-isclass: true Rating: type: object properties: Average: description: The average rating for this item. type: number x-actualtype: float Count1Star: description: The total count of 1 star ratings for this item. type: number x-actualtype: int32 Count2Star: description: The total count of 2 star ratings for this item. type: number x-actualtype: int32 Count3Star: description: The total count of 3 star ratings for this item. type: number x-actualtype: int32 Count4Star: description: The total count of 4 star ratings for this item. type: number x-actualtype: int32 Count5Star: description: The total count of 5 star ratings for this item. type: number x-actualtype: int32 TotalCount: description: The total count of ratings for this item. type: number x-actualtype: int32 RealMoneyPriceDetails: description: >- The multi-currency unit price, in real money, of the item that was redeemed within an individual marketplace. Each property is a dictionary where the key is the three-letter currency code as defined in ISO 4217, and the value is the currency amount in the smallest unit (e.g. cents, pence, etc.) in accordance with ISO 4217. Example: If the product price in USD is $1.39, the dictionary entry would be: ["USD"] = 139. Currently, only United States Dollar (USD) is supported. type: object properties: AppleAppStorePrices: description: >- The 'AppleAppStore' price amount per CurrencyCode. 'USD' supported only. type: object x-actualtype: int32 GooglePlayPrices: description: >- The 'GooglePlay' price amount per CurrencyCode. 'USD' supported only. type: object x-actualtype: int32 MicrosoftStorePrices: description: >- The 'MicrosoftStore' price amount per CurrencyCode. 'USD' supported only. type: object x-actualtype: int32 NintendoEShopPrices: description: >- The 'NintendoEShop' price amount per CurrencyCode. 'USD' supported only. type: object x-actualtype: int32 PlayStationStorePrices: description: >- The 'PlayStationStore' price amount per CurrencyCode. 'USD' supported only. type: object x-actualtype: int32 SteamPrices: description: The 'Steam' price amount per CurrencyCode. 'USD' supported only. type: object x-actualtype: int32 StoreDetails: type: object properties: FilterOptions: allOf: - $ref: '#/components/schemas/FilterOptions' description: >- The options for the filter in filter-based stores. These options are mutually exclusive with item references. Permissions: allOf: - $ref: '#/components/schemas/Permissions' description: >- The permissions that control which players can purchase from the store. PriceOptionsOverride: allOf: - $ref: '#/components/schemas/CatalogPriceOptionsOverride' description: >- The global prices utilized in the store. These options are mutually exclusive with price options in item references. ModerationStatus: type: string enum: - Unknown - AwaitingModeration - Approved - Rejected CatalogPrice: type: object properties: Amounts: description: >- The amounts of the catalog item price. Each price can have up to 15 item amounts. type: array items: $ref: '#/components/schemas/CatalogPriceAmount' x-isclass: true UnitAmount: description: The per-unit amount this price can be used to purchase. type: number x-actualtype: int32 UnitDurationInSeconds: description: >- The per-unit duration this price can be used to purchase. The maximum duration is 100 years. type: number x-actualtype: double FilterOptions: type: object properties: Filter: description: >- The OData filter utilized. Mutually exclusive with 'IncludeAllItems'. More info about Filter Complexity limits can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/search#limits type: string IncludeAllItems: description: >- The flag that overrides the filter and allows for returning all catalog items. Mutually exclusive with 'Filter'. type: boolean Permissions: type: object properties: SegmentIds: description: >- The list of ids of Segments that the a player can be in to purchase from the store. When a value is provided, the player must be in at least one of the segments listed for the purchase to be allowed. type: array items: type: string CatalogPriceOptionsOverride: type: object properties: Prices: description: The prices utilized in the override. type: array items: $ref: '#/components/schemas/CatalogPriceOverride' x-isclass: true CatalogPriceAmount: type: object properties: Amount: description: The amount of the price. type: number x-actualtype: int32 ItemId: description: The Item Id of the price. type: string required: - Amount CatalogPriceOverride: type: object properties: Amounts: description: The currency amounts utilized in the override for a singular price. type: array items: $ref: '#/components/schemas/CatalogPriceAmountOverride' x-isclass: true CatalogPriceAmountOverride: type: object properties: FixedValue: description: The exact value that should be utilized in the override. type: number x-actualtype: int32 ItemId: description: The id of the item this override should utilize. type: string Multiplier: description: >- The multiplier that will be applied to the base Catalog value to determine what value should be utilized in the override. type: number x-actualtype: double responses: GetDraftItemResponse: description: '' content: application/json: schema: type: object properties: code: type: integer description: >- The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code. status: type: string description: The Http status code as a string. data: $ref: '#/components/schemas/GetDraftItemResponse' example: code: 200 status: OK data: Item: Id: dddddddd-dddd-dddd-dddd-dddddddddddd Type: ugc Title: NEUTRAL: Neutral title en-US: US English title Description: NEUTRAL: Neutral description en-US: US English description Keywords: NEUTRAL: Values: - Keyword_1 - Keyword_2 ContentType: example item CreatorEntity: Id: someId Type: title_player_account TypeString: title_player_account IsHidden: false Tags: - pirates - holiday DisplayVersion: 1.0.0 CreationDate: '2018-08-17T22:32:10.4729879+00:00' LastModifiedDate: '2018-08-17T22:32:31.911375+00:00' Contents: - Id: 00000000-0000-0000-0000-000000000001 Url: >- https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip MaxClientVersion: 2.4.1 MinClientVersion: 2.0.0 Images: - Id: 00000000-0000-0000-0000-000000000003 Type: Thumbnail Url: >- https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg DisplayProperties: mapDetails: mapType: desertIsland gameMode: capture maxPlayers: 16 averageMatchLengthInSeconds: 947 ETag: opaqueString DefaultStackId: Static_Default_Stack_Id ApiErrorWrapper: description: This is the outer wrapper for all responses with errors content: application/json: schema: $ref: '#/components/schemas/ApiErrorWrapper' securitySchemes: EntityToken: type: apiKey in: header name: X-EntityToken description: >- This API requires an Entity Session Token, available from the Entity GetEntityToken method. ```` ## Related topics - [Get Draft Items](/services/playfab/api-references/rest/economy/catalog/get-draft-items.md) - [Get Draft Item](/api-reference/catalog/get-draft-item.md) - [PFCatalogGetDraftItemsAsync](/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetdraftitemsasync.md) - [PFCatalogGetDraftItemAsync](/services/playfab/api-references/c/pfcatalog/functions/pfcataloggetdraftitemasync.md) - [PFCatalogGetDraftItemRequest](/services/playfab/api-references/c/pfcatalogtypes/structs/pfcataloggetdraftitemrequest.md)