APICross-product endpointsLine items

Update item

View as MarkdownOpen in Claude
Updates an item.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

lineItemIdintegerRequired

ID for the line item (also known as a product, service, or item).

Request

This endpoint expects an object.
itemCostdoubleRequired
Item or product price per unit.
itemQtyintegerRequired
Quantity of item or product.
itemCategorieslist of stringsOptional
Array of tags classifying item or product.
itemCommodityCodestringOptional<=250 characters
Item or product commodity code. Max length of 250 characters.
itemDescriptionstringOptional<=250 characters
Item or product description. Max length of 250 characters.
itemModeintegerOptional

Internal class of item or product: value ‘0’ is only for invoices, ‘1’ for bills, and ‘2’ is common for both.

itemProductCodestringOptional<=250 characters
Item or product code. Max length of 250 characters.
itemProductNamestringOptional<=250 characters
Item or product name. Max length of 250 characters.
itemUnitOfMeasurestringOptional<=100 characters
Unit of measurement. Max length of 100 characters.

Response

Success
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

pageIdentifierstring
Auxiliary validation used internally by payment pages and components.
responseDatastring or integer

If isSuccess = true, this contains the line item identifier. If isSuccess = false, this contains the reason for the error.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error