v1
latestOpenAPI 3.0.02026-07-24126202516.7 KBItems
List Items
OK
get/items
Query parameters
offsetinteger
Number of records to offset. Required for pagination.
limitinteger
Number of records to retrieve. Up to 200.
searchstring required
A text value to be used for searching within the item description
created_beforestring
Date and time in ISO 8601 format the item(s) were created before (e.g. 2020-02-27T23:54:59Z)
created_afterstring
Date and time in ISO 8601 format the item(s) were created after (e.g. 2020-02-27T23:54:59Z)
Response
OK
Example response
{
"items": [
{
"id": "7190770-1-2908",
"name": "Item #001",
"description": "My first Item.",
"state": "pending",
"status": 22000,
"amount": 20000,
"payment_type_id": 2,
"currency": "AUD",
"buyer_name": "Sample Buyer",
"buyer_email": "sample.buyer@assemblypayments.com",
"buyer_country": "AUS",
"seller_name": "Sample Seller",
"seller_email": "sample.seller@assemblypayments.com",
"seller_country": "AUS",
"tds_check_state": "NA",
"net_amount": 20000,
"seller_fees": 400,
"promisepay_fee": 350,
"total_outstanding": 20000,
"total_amount": 20000,
"payment_method": "pending",
"payment_credit_card_enabled": true,
"payment_direct_debit_enabled": true,
"related": {
"buyers": "064d6800-fff3-11e5-86aa-5e5517507c66",
"sellers": "5830def0-ffe8-11e5-86aa-5e5517507c66"
}
}
]
}