For AI agents: markdown of this page — /docs-content-en/entities/invoices/products-get-single.md documentation index — /llms.txt

Get a product from an invoice

GET /v1/invoices/:id/products/:rowId

Returns a single invoice product row by row ID.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionInvoice ID
ParameterrowId (path) Typenumber Requiredyes DescriptionProduct row ID (from the add or list response)

rowId is the product row ID, not the productId from the product catalog.

Examples

curl — personal key

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/invoices/741/products/1471" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X GET "https://vibecode.bitrix24.com/v1/invoices/741/products/1471" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/invoices/741/products/1471', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Price:', data.price)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/invoices/741/products/1471', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata.id Typenumber DescriptionProduct row ID
Fielddata.productId Typenumber DescriptionCatalog product ID
Fielddata.productName Typestring DescriptionProduct name
Fielddata.price Typenumber DescriptionPrice per unit
Fielddata.quantity Typenumber DescriptionQuantity
Fielddata.discount Typenumber DescriptionDiscount amount
Fielddata.discountRate Typenumber DescriptionDiscount percentage
Fielddata.discountTypeId Typenumber DescriptionDiscount type — 1 means an amount, 2 a percentage
Fielddata.taxRate Typenumber | null DescriptionTax rate (%)
Fielddata.taxIncluded Typeboolean DescriptionTax included in the price
Fielddata.priceExclusive Typenumber DescriptionPrice excluding tax, with discount
Fielddata.priceNetto Typenumber DescriptionNet price
Fielddata.priceBrutto Typenumber DescriptionGross price
Fielddata.priceAccount Typenumber DescriptionPrice in the reporting currency
Fielddata.measureCode Typenumber DescriptionUnit of measure code
Fielddata.measureName Typestring DescriptionUnit of measure name
Fielddata.sort Typenumber DescriptionSort order
Fielddata.ownerId Typenumber DescriptionID of the owner entity the row belongs to
Fielddata.ownerType Typestring DescriptionRow owner type, SI for an invoice
Fielddata.storeId Typenumber | null DescriptionWarehouse ID. List: GET /v1/warehouses. null when inventory management is off
Fielddata.customized Typestring DescriptionWhether the row was edited manually — Y or N
Fielddata.xmlId Typestring DescriptionExternal row code
Fielddata.type Typenumber DescriptionRow type

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 1471,
    "productId": 1,
    "productName": "Server equipment",
    "price": 5000,
    "priceAccount": 5000,
    "priceExclusive": 5000,
    "priceNetto": 5000,
    "priceBrutto": 5000,
    "quantity": 3,
    "discountTypeId": 2,
    "discountRate": 0,
    "discount": 0,
    "taxRate": null,
    "taxIncluded": false,
    "customized": "Y",
    "measureCode": 796,
    "measureName": "pcs",
    "sort": 0,
    "ownerId": 741,
    "ownerType": "SI",
    "storeId": 3,
    "xmlId": "sale_basket_995",
    "type": 1
  }
}

Error response example

404 — invoice or product row not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Item not found"
  }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionInvoice or product row not found
HTTP400 CodeINVALID_ROW_ID DescriptionThe rowId in the URL is not a positive integer
HTTP403 CodeSCOPE_DENIED DescriptionAPI key lacks the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionAPI key has no configured tokens
HTTP429 CodeRATE_LIMITED DescriptionRate limit exceeded: 300 requests per minute per portal. All API keys of the portal share one limit. The current limit is returned in the x-ratelimit-limit header. Retry after the delay in the Retry-After header

For the full list of common API errors, see Errors.

See also