List Order Credit Notes

The GET Credit Notes endpoint allows you to retrieve a list of credit notes associated with an order from the system. Credit notes are issued for orders that have been cancelled or modified, and this endpoint provides detailed information about each credit note, including customer details, product information, and payment details.

🔑Scopes

orders.read - Orders Read

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "code": "SUCCESS_WITH_SINGLE_PAYLOAD_OBJECT",
    "message": null,
    "payload": {
        "credit_notes": [
            {
                "id": "ca2dc662-9ee4-4fb5-a543-74693946ef4c",
                "order_id": 59214748,
                "store_id": 3,
                "invoice_type": "debit_note",
                "translated_invoice_type": "Debit note",
                "original_invoice_number": 59214748,
                "invoice_number": 1122155,
                "issue_reason": "issue_reason_update",
                "invoice_title": "Updated order",
                "translated_issue_reason": "Order update",
                "store_name": "Mohammed Zayan",
                "shipping_method_code": "zid_shipping.option_574614",
                "store_url": "https://osama.zid.store/",
                "order_status": {
                    "name": "جديد",
                    "code": "new"
                },
                "payment_status": "paid",
                "currency_code": "SAR",
                "customer": {
                    "id": 37,
                    "name": "Osama Khaled",
                    "email": "osamakhaled2010@gmail.com",
                    "mobile": "966503187421",
                    "note": "",
                    "type": "individual"
                },
                "has_different_consignee": 0,
                "order_total": "211.4500",
                "order_total_string": "211.45 SAR",
                "has_different_transaction_currency": false,
                "transaction_reference": null,
                "transaction_amount": "211.4500",
                "transaction_amount_string": "211.45 SAR",
                "items": [
                    {
                        "id": "bb15784e-e525-4438-bb3b-27871d3baae6",
                        "product_id": "2a39d7b88d9d4040b636ab9a085b540d",
                        "name": "ماء تونر جينسينغ من بيوتي اوف جوسون",
                        "sku": "glow1114",
                        "quantity": 1,
                        "is_taxable": true,
                        "is_discounted": false,
                        "net_price_with_additions": 59.1304,
                        "tax_percentage": 0.15,
                        "tax_amount": 8.8696,
                        "total": 68
                    }
                ],
                "items_count": 1,
                "created_at": "2026-01-21 15:00:22",
                "updated_at": "2026-01-21 15:00:22",
                "zatca": {
                    "qr_code_data": "AQACDzMxMTExMTExMTExMTExMwMUMjAyNi0wMS0yMVQxNTowMDoyMloEAjY4BQQ4Ljg3"
                }
            }
        ],
        "returned_items": [
            {
                "id": "bb15784e-e525-4438-bb3b-27871d3baae6",
                "product_id": "2a39d7b88d9d4040b636ab9a085b540d",
                "quantity": 1,
                "net_price_with_additions": 59.1304,
                "tax_percentage": 0.15,
                "tax_amount": 8.8696
            }
        ]
    }
}

🟠401Unauthorized