List of Items
Returns a paginated list of catalog items as { meta: { count, totalPages, page, limit, sortBy }, data: [...] }. salesPrice is in dollars.
query Parameters
limitItems per page (default 10)
pagePage number (default 1)
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
List of Items › Responses
Paginated items list.
Create an item
Create a new product/service item in the catalog.
salesPrice: price in dollars; must not be 0; negative allowed only without taxes (discount lines).
categories: effectively required (send [] when none). Entries are { id: string | null, name }; id: null creates a new category.
type: any non-empty string (e.g. product, service).
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Create an item › Request Body
nameItem name shown on invoices and payment pages
typeItem type. Any non-empty string (e.g. product, service).
descriptionItem description
salesPricePrice in dollars; must not be 0; negative allowed only without taxes (discount lines).
Item's categories. Effectively required (send [] when none). Entries are { id: string | null, name }; id: null creates the category.
skuStock keeping unit (SKU) used to identify the item in your catalog
taxesTax ids applied to this item. Send [] when none. Not allowed when salesPrice is negative.
Create an item › Responses
Item created.
List of item IDs (unpaginated)
Returns a bare JSON array of item id strings (no data envelope, no pagination). It carries no names or prices, so it is not suitable for dropdowns on its own; fetch GET /public/item/{id} for details.
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
List of item IDs (unpaginated) › Responses
Bare array of item ids.
List of categories
Returns all item categories as a bare JSON array (no data envelope). Each entry includes clientId.
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
List of categories › Responses
Bare array of categories.
idnameclientIdcreatedAtupdatedAtDelete a item by id
Soft-deletes a catalog item (deletedAt is set). Note: salesPrice in this response is an integer amount in cents (1000 = $10.00), unlike the other item routes.
path Parameters
idItem ID
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Delete a item by id › Responses
Item deleted. salesPrice is in cents.
Update an Item
Partial update of a catalog item. categories and taxes must be present in the body (send [] to keep none). salesPrice is in dollars. The response currently reflects the item before the update; re-fetch GET /public/item/{id} for the stored state.
path Parameters
idItem ID
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Update an Item › Request Body
nameItem name shown on invoices and payment pages
typeItem type. Any non-empty string (e.g. product, service).
descriptionItem description
skuStock keeping unit (SKU) used to identify the item in your catalog
salesPricePrice in dollars; must not be 0; negative allowed only without taxes (discount lines).
Item's categories. Effectively required (send [] when none). Entries are { id: string | null, name }; id: null creates the category.
taxesTax ids applied to this item. Send [] when none. Not allowed when salesPrice is negative.
Update an Item › Responses
Item updated.
Delete a list of items
Delete multiple catalog items by id list. itemList holds item ids (at least one). Atomicity is undefined: on error some items may already be deleted — refresh the list afterwards.
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Delete a list of items › Request Body
itemListItem ids to act on. At least one id is required.
createdByUsername owner performing the action
Delete a list of items › Responses
Items deleted.
Duplicate an item
Create a copy of an existing item. Returns { data: <item> }; salesPrice is an integer amount in cents (not converted).
path Parameters
idItem ID to duplicate
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Duplicate an item › Responses
Duplicate created. salesPrice is in cents.
Duplicate a list item
Duplicate multiple items at once. itemList holds item ids (at least one). Atomicity is undefined: on error some items may already be duplicated — refresh the list afterwards. Returns only { success }; re-list items to see the copies.
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Duplicate a list item › Request Body
itemListItem ids to act on. At least one id is required.
createdByUsername owner performing the action
Duplicate a list item › Responses
Duplicates created.

