API referenceShared resource endpointsLine items

Create item

Adds products and services to an entrypoint's catalog. These are used as line items for invoicing and transactions. In the response, "responseData" displays the item's code.

Path parameters

entrystringRequired

The paypoint’s entrypoint identifier. Learn more

Headers

requestTokenstringRequired
idempotencyKeystringOptional
A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

Request

This endpoint expects an object.
itemCostdoubleRequired
Item or product price per unit.
itemQtyintegerRequired
Quantity of item or product.
itemCategorieslist of optional 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
isSuccessbooleanOptional

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

pageIdentifierstringOptional
Auxiliary validation used internally by payment pages and components.
responseDatastring or integerOptional

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

responseTextstringOptional

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

Errors