> ## Documentation Index > Fetch the complete documentation index at: https://docs.supercycle.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve an item > Returns all fields on an item. Can include timeline events if requested. ## OpenAPI ````yaml https://app.supercycle.com/docs/openapi-v1.yml get /items/{itemId} openapi: 3.1.0 info: title: Supercycle API version: 1.0.0 contact: name: Supercycle Support email: support@supercycle.com description: >+ The Supercycle API provides comprehensive endpoints designed to streamline inventory, rental, and return management for merchants using the Supercycle platform. This API facilitates the integration with external systems such as Shopify, enabling seamless synchronization of product data, rental operations, and returns processing. Key features include: - **Inventory Management:** Endpoints to create, update, and retrieve detailed information about items and products. - **Rental Operations:** Manage rentals from creation to dispatch, with automated serial allocation and synchronization with Shopify orders. - **Returns Processing:** Efficiently manage and track returns with the ability to update statuses and item conditions. - **Timeline Comments:** Add comments to timeline events associated with resources in a shop. - **Availability Timelines:** Per-variant day-by-day availability counts for back-office and OMS integrations (mirrors the storefront availability timeline). - **Blocked Dates:** List, retrieve, and create manually blocked date ranges on items, variants, and products that reduce availability. **Rate limits:** Requests are throttled per API key (Bearer token). Across all endpoints, a key may make at most **120 requests per minute**. The availability timeline endpoint (`GET /availability_timelines`) is limited to **10 requests per minute** per key because it is computationally expensive—cache responses client-side where possible. Requests without a Bearer token are limited to **30 requests per minute** per client IP. When exceeded, the API returns **429 Too Many Requests** with `Retry-After`, `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers. This API is essential for merchants looking to enhance their operational efficiency, providing the tools needed to manage their inventory, rentals, returns, timeline events, availability planning, and blocked dates all in one place. For support or enquiries, please contact [Supercycle Support](mailto:support@supercycle.com). servers: - url: https://app.supercycle.com/api/v1 security: - bearerAuth: [] tags: - name: AvailabilityTimelines - name: BlockedDates - name: Conditions - name: CustomFieldDefinitions - name: CustomFields - name: Items - name: Products - name: Variants - name: Rentals - name: ReturnOrders - name: TimelineComments - name: Locations paths: /items/{itemId}: parameters: - $ref: '#/components/parameters/ItemId' get: tags: - Items summary: Retrieve an item description: Returns all fields on an item. Can include timeline events if requested. operationId: getItem responses: '200': description: Expected response to a valid request content: application/json: schema: $ref: '#/components/schemas/Item' '429': $ref: '#/components/responses/TooManyRequests' components: parameters: ItemId: name: itemId in: path required: true schema: type: integer description: Numeric ID of the item to retrieve. schemas: Item: type: object required: - id - createdAt - activeRentalId - productTitle - serial - sequentialId - shopifyVariantId - status - tags - variantTitle - visibility properties: id: type: integer format: int64 description: Numeric ID of the item. createdAt: type: string format: date-time activeRentalId: oneOf: - type: 'null' - type: integer format: int64 activeReturnId: oneOf: - type: 'null' - type: integer format: int64 condition: oneOf: - type: 'null' - $ref: '#/components/schemas/Condition' type: object conditionId: type: - 'null' - integer description: ID of the condition. May be null if no condition is set. imageUrl: type: - 'null' - string location: oneOf: - type: 'null' - $ref: '#/components/schemas/Location' type: object description: Location of the item in the warehouse. pickLocation: type: - 'null' - string description: >- Physical location within warehouse using Zone-Aisle-Shelf-Bin format (e.g., "A1-02-B3"). May be null if no pick location is set. acquisitionCostCents: type: - 'null' - integer description: Amount paid to acquire this item, in cents. May be null if not set. roiCents: type: - 'null' - integer description: >- Computed return on investment (lifecycle revenue minus acquisition cost), in cents. Null when acquisitionCostCents is null. productTitle: type: string serial: type: - 'null' - string sequentialId: type: integer format: int32 shopifyProductId: type: - 'null' - integer shopifyVariantId: type: - 'null' - integer status: type: string enum: - processed - unprocessed tags: type: array items: type: string variantTitle: type: - 'null' - string visibility: type: string enum: - available - unavailable - sold - retired timelineEvents: type: array description: Timeline events for this item items: $ref: '#/components/schemas/TimelineEvent' customFields: type: array description: Custom fields attached to this item items: $ref: '#/components/schemas/CustomField' Condition: type: object unevaluatedProperties: false required: - id - createdAt - severityKey - severityTone - title properties: id: type: integer format: int64 description: Numeric ID of the condition. createdAt: type: string format: date-time description: Date and time the condition was created. severityKey: type: string description: Severity key of the condition. severityTone: type: string description: Tone of the condition. title: type: string description: Title of the condition. Location: type: object required: - shopifyId - name properties: shopifyId: type: integer format: int64 description: Numeric ID of the Shopify location. name: type: string description: Name of the location. TimelineEvent: type: object required: - id - eventableId - eventableType - eventType properties: id: type: integer format: int64 description: Numeric ID of the timeline event. eventableId: type: integer format: int64 description: Numeric ID of the resource associated with the event. eventableType: type: string description: Type of the resource (e.g., Item, Rental, ReturnOrder). eventType: type: string description: Type of the timeline event. metadata: type: object description: Additional data associated with the timeline event. createdAt: type: string format: date-time description: Timestamp when the event was created. updatedAt: type: string format: date-time description: Timestamp when the event was last updated. author: type: string nullable: true description: Author of the timeline event. CustomField: type: object required: - id - ownerId - ownerType - definitionId - key - value properties: id: type: integer format: int64 description: Numeric ID of the custom field. ownerId: type: integer format: int64 description: ID of the item or rental that owns this custom field. ownerType: type: string enum: - Item - Rental description: Type of the owner resource. definitionId: type: integer format: int64 description: ID of the custom field definition. key: type: string description: Key of the custom field definition. value: type: string description: Raw stored value of the custom field. valueJson: description: >- Typed JSON value of the custom field (format depends on definition type). responses: TooManyRequests: description: Rate limit exceeded headers: Retry-After: description: Seconds until the current throttle window resets. schema: type: integer example: 42 X-RateLimit-Limit: description: Maximum requests allowed in the window that triggered this response. schema: type: integer example: 120 X-RateLimit-Remaining: description: >- Remaining requests in the window (always 0 when this response is returned). schema: type: integer example: 0 X-RateLimit-Reset: description: ISO 8601 timestamp when the throttle window resets. schema: type: string format: date-time content: application/json: schema: type: object required: - error properties: error: type: string example: Rate limit exceeded. Retry after 42 seconds. securitySchemes: bearerAuth: type: http scheme: bearer ````