Unity Inventory API

openapi: 3.2.0
info:
  title: Unity Economy Inventory API
  description: The Unity Economy REST API allows you to manage in-game economies including virtual currencies, inventory items, purchases, and player balances. It provides both Admin endpoints for configuring economy resources and Player endpoints for runtime player interactions such as making purchases and checking balances.
  version: v2.0.0
  termsOfService: https://unity.com/legal/terms-of-service
  contact:
    name: Unity Support
    url: https://support.unity.com
  license:
    name: Unity Terms of Service
    url: https://unity.com/legal/terms-of-service
servers:
- url: https://economy.services.api.unity.com
  description: Unity Economy Production Server
security:
- bearerAuth: []
tags:
- name: Inventory
  description: Manage inventory items and player inventory
paths:
  /v2/projects/{projectId}/environments/{environmentId}/players/{playerId}/inventory:
    get:
      operationId: getPlayerInventory
      summary: Get Player Inventory
      description: Returns all inventory items currently held by the player.
      tags:
      - Inventory
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      - name: playerId
        in: path
        required: true
        schema:
          type: string
      - name: playersItemIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      - name: itemIds
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Player inventory items
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlayerInventory'
components:
  schemas:
    PlayerInventory:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/InventoryItem'
    Timestamp:
      type: object
      properties:
        date:
          type: string
          format: date-time
    InventoryItem:
      type: object
      properties:
        playersItemId:
          type: string
        inventoryItemId:
          type: string
        quantity:
          type: integer
        instanceData:
          type: object
        writeLock:
          type: string
        created:
          $ref: '#/components/schemas/Timestamp'
        modified:
          $ref: '#/components/schemas/Timestamp'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Unity Economy Documentation
  url: https://docs.unity.com/ugs/en-us/manual/economy/manual/write-configuration/rest-api