Add Item to Catalog
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.
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Headers
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.
"6B29FC40-CA47-1067-B31D-00DD010662DA"
Path Parameters
The paypoint's entrypoint identifier. Learn more
"8cfec329267"
Body
Item or product name. Max length of 250 characters.
250
"Materials deposit"
Item or product price per unit.
12.45
Quantity of item or product.
1
Item or product code. Max length of 250 characters.
250
"M-DEPOSIT"
Item or product description. Max length of 250 characters.
250
"Deposit for materials."
Item or product commodity code. Max length of 250 characters.
250
"010"
Unit of measurement. Max length of 100 characters.
100
"SqFt"
Internal class of item or product: value '0' is only for invoices, '1' for bills, and '2' is common for both.
0
, 1
, 2
Array of tags classifying item or product.
Response
Response schema for line item operations.
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
true
Response text for operation: 'Success' or 'Declined'.
"Success"
Auxiliary validation used internally by payment pages and components.
null
If isSuccess
= true, this contains the line item identifier. If isSuccess
= false, this contains the reason of the error.
Was this page helpful?