Zoey REST API reference ยท Interactive version: apidocs.zoey.com
GET https://container-url.zoeysite.com/api/rest/transactions?page=1&limit=10&order=total&dir=desc&filter[0][attribute]=method_code&filter[0][nin][0]=purchaseorder&filter[0][nin][1]=cryozonic_stripe&filter[0][nin][2]=cryozonic_achpayments_ach
Query parameters:
| Name | Example | Notes |
|---|---|---|
page | 1 | Page Number (Optional, Default: 1) |
limit | 10 | Page Limit (Optional, Default: 10) |
order | total | Order Attribute (Optional, Default: 'id'); |
dir | desc | Order Direction (Optional, Default: 'asc') |
filter[0][attribute] | method_code | Filter (Optional) |
filter[0][nin][0] | purchaseorder | |
filter[0][nin][1] | cryozonic_stripe | |
filter[0][nin][2] | cryozonic_achpayments_ach |
Example response (Get All):
{
"result": {
"status": {
"success": 1,
"details": []
},
"data": {
"totalRecords": 438,
"items": [
{
"id": "340",
"entity_type_id": "163",
"state": "2",
"sales_transaction_id": null,
"increment_id": "100000531",
"store_id": "1",
"method_code": "checkmo",
"method_code_comment": null,
"total": "3888.9000",
"base_total": "3888.9000",
"surcharge_amount": "0.0000",
"base_surcharge_amount": "0.0000",
"currency_code": "USD",
"base_currency_code": "USD",
"currency_rate": "1.0000",
"is_archived": "0",
"created_at": "2024-08-07 18:27:03",
"updated_at": "2024-08-07 18:44:30",
"entity_type_code": "zoey_transaction_payment"
},
{
"id": "511",
"entity_type_id": "163",
"state": "2",
"sales_transaction_id": null,
"increment_id": "100000705",
"store_id": "1",
"method_code": "banktransfer",
"method_code_comment": null,
"total": "3502.8700",
"base_total": "3502.8700",
"surcharge_amount": "0.0000",
"base_surcharge_amount": "0.0000",
"currency_code": "USD",
"base_currency_code": "USD",
"currency_rate": "1.0000",
"is_archived": "0",
"created_at": "2024-10-03 18:27:40",
"updated_at": "2024-10-03 18:27:40",
"entity_type_code": "zoey_transaction_payment"
},
{
"id": "481",
"entity_type_id": "163",
"state": "2",
"sales_transaction_id": "686",
"increment_id": "100000672",
"store_id": "1",
"method_code": "amazon_payments",
"method_code_comment": null,
"total": "3496.0000",
"base_total": "349
... (truncated)
GET https://container-url.zoeysite.com/api/rest/transactions/:id
Example response (Get):
{
"result": {
"status": {
"success": 1,
"details": []
},
"data": {
"id": "1439",
"entity_type_id": 163,
"state": "2",
"sales_transaction_id": null,
"increment_id": "100001086",
"store_id": "1",
"method_code": "cashondelivery",
"method_code_comment": null,
"total": "525.9450",
"base_total": "525.9450",
"surcharge_amount": "0.0000",
"base_surcharge_amount": "0.0000",
"currency_code": "USD",
"base_currency_code": "USD",
"currency_rate": "1.0000",
"is_archived": "0",
"created_at": "2025-01-17 18:24:12",
"updated_at": "2025-01-17 18:24:12",
"entity_type": {
"entity_type_id": "163",
"entity_type_code": "zoey_transaction_payment",
"entity_type_label": null
},
"base_total_available": "",
"total_available": "",
"transactions": null
}
}
}