---
title: "getCustomItem"
method: GET
path: "/getCustomItem"
tags: ["Item"]
---

# getCustomItem

`GET /getCustomItem`

## Request

- Base URL: `https://api.cloudbeds.com/api/v1.3`
- URL: `https://api.cloudbeds.com/api/v1.3/getCustomItem`
- Auth: one of:
  - API key in header `x-api-key`
  - OAuth 2
    - Authorization code
    - Scopes: `read:item`

Returns every item and payment of one posting made with [postCustomItem](#api-Item-postCustomItem), including the items and payments added to it later with [appendCustomItem](#api-Item-appendCustomItem). Look the posting up by any of its items or any of its payments. Postings made by any application on the property are returned.<br> Every item and payment carries the keys of its Accounting API transactions: query the Accounting API by its `sourceKind` and `sourceID`, then match `externalRelationKind` and `externalRelationID`.

## Query parameters

- `propertyID` string
- `soldProductID` string
- `paymentID` string

## Response `200`

200 Response

- GetCustomItemResponse
  - `success` boolean: Returns if the request could be completed
  - `data` object: Posting details
    - `referenceID` string: The referenceID sent with the posting. Null if none was sent
    - `items` object[]: Items of the posting, in the order they were posted
      - `soldProductID` string: Sold product identifier, as returned by postCustomItem
      - `externalRelationID` string: The soldProductID without its prefix: the externalRelationId of the item's Accounting API transactions
      - `externalRelationKind` 'ITEM_POS': The externalRelationKind of the item's Accounting API transactions
      - `sourceKind` 'RESERVATION' | 'HOUSE_ACCOUNT' | 'GROUP_PROFILE': The Accounting API sourceKind the item was posted to
      - `sourceID` string: The Accounting API sourceId the item was posted to: the internal reservation, house account or group profile identifier
      - `itemName` string: Item name
      - `itemQuantity` integer: Items quantity
      - `itemAmount` number: Item total amount, without taxes and fees
      - `isVoided` boolean: Whether the item was voided
    - `payments` object[]: Payments sent with the posting
      - `paymentID` string: Payment identifier
      - `externalRelationID` string: The paymentID: the externalRelationId of the payment's Accounting API transaction
      - `externalRelationKind` 'PAYMENT': The externalRelationKind of the payment's Accounting API transaction
      - `sourceKind` 'RESERVATION' | 'HOUSE_ACCOUNT' | 'GROUP_PROFILE': The Accounting API sourceKind the payment was posted to
      - `sourceID` string: The Accounting API sourceId the payment was posted to
      - `paymentType` string: Payment method
      - `amount` number: Payment amount
      - `currency` string: Payment currency
      - `status` string: Payment status
      - `isVoided` boolean: Whether the payment was voided

## Changes

- **2026-11-03** `6f4f997d5f7a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cloudbeds/apis/cloudbeds-api/changes/getCustomItem/get.md)

---

[API](https://skmtc.dev/cloudbeds/apis/cloudbeds-api.md) - [All operations](https://skmtc.dev/cloudbeds/apis/cloudbeds-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudbeds/apis/cloudbeds-api/revisions/6f4f997d5f7a?raw)