Get Order Credit Notes
GET
https://api.zid.sa/v1v1/managers/store/orders/{order-id}/credit-notes
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.zid.sa/v1v1/managers/store/orders/22350/credit-notes' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y' \
--header 'X-manager-Token: eyJpdiI6ImdmbVQ5ZTFZWm5hRkdvbmFTQ2o2ZkE9PSIsInZhbHVlIjoiMDVXVU1yQWFaTDgvMEZwYW5JWGR1QVZCQ3hFUzQxQ2t3a1oxOGR2QWhEays3N28zeldtaytKU1pzL2tHQU9jT2dZMlZCcnBsUEp1TmcxTG1SWlBnMDVLc0R3dlpGZENsY0s2Y1RwNHpEbVpYbGtjYlVITVpzcy8rNHBkQmxqZExsZW01REJkZmdQb3FmZmNTWTZXZ2JWRitmRWpWSnRZU0NOcTFvRGdjRU9Obk5TZDZRL2FCRHdobytwK3JVZUsrbWJ3RmtmUHlOcEZMcENzUENxUEkrUHFZZTdPQ043S0xtczF0d1k1ekZlaz0iLCJtYWMiOiI0ZDM4MDk3NDMwZDRhZjNkOGI0MzU1ODdmZGVmNGJiNzFmYTE2ZTZjYWM1Njc0NTQ0NmIwMjY1NWMxZWY4ZDQyIiwidGFnIjoiIn0::' \
--header 'Accept-Language: en' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36'
Response Response Example
{
"code": "SUCCESS_WITH_SINGLE_PAYLOAD_OBJECT",
"message": null,
"payload": {
"credit_notes": [
{
"id": "16936fba-13a8-4d1f-8f2e-b4bb77c0bf5e",
"order_id": 22350,
"store_id": 25653,
"invoice_type": "credit_note",
"translated_invoice_type": "إشعار دائن",
"original_invoice_number": 22350,
"invoice_number": 775,
"issue_reason": "issue_reason_cancel",
"invoice_title": "فاتورة إلغاء",
"translated_issue_reason": "إلغاء طلب",
"store_name": "uat_lite",
"shipping_method_code": ".option_",
"store_url": "https://uatlite.zidtest.com/",
"order_status": {
"name": "تم الإلغاء",
"code": "cancelled"
},
"currency_code": "SAR",
"customer": {
"id": 135,
"name": "POS Guest Customer",
"verified": 1,
"email": "pos_guest_customer@test.com",
"mobile": "966500000001",
"note": "Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test",
"type": null
},
"has_different_consignee": 0,
"order_total": "30.0000",
"order_total_string": "30.00 SAR",
"products_sum_total_string": "30.00 SAR",
"has_different_transaction_currency": false,
"transaction_reference": null,
"transaction_amount": "30.0000",
"transaction_amount_string": "30.00 SAR",
"return_policy": "Test TestTest\n TestTest TestTest TestTest TestTest TestTest TestTest TestTest TestTest TestTest TestTest TestTest TestTest TestTest TestTest Test",
"items": [
{
"id": "e291f766-e57c-467a-ad4e-8a06dd7b2a36",
"product_id": "4e3ffbe67db84a0fbcba534528e90eec",
"code": null,
"name": "تجريبي",
"custom_fields": [],
"sku": "Z.25653.17167197217481027",
"quantity": 3,
"is_taxable": true,
"is_discounted": false,
"meta": null,
"weight": null,
"net_price_with_additions": 10,
"net_price_with_additions_string": "10.00 SAR",
"price_with_additions": 10,
"price_with_additions_string": "10.00 SAR",
"net_price": "10.0000",
"net_price_string": "10.00 SAR",
"net_sale_price": null,
"net_sale_price_string": null,
"net_additions_price": 0,
"net_additions_price_string": null,
"original_price": null,
"original_price_string": null,
"gross_price": 0,
"gross_price_string": "0.00 SAR",
"gross_sale_price": null,
"gross_sale_price_string": null,
"price_before": null,
"price_before_string": null,
"total_before": null,
"total_before_string": null,
"gross_additions_price": 0,
"gross_additions_price_string": null,
"tax_percentage": 0,
"tax_amount": 0,
"tax_amount_string": "0.00 SAR",
"tax_amount_string_per_item": "0.00 SAR",
"sale_price": null,
"sale_price_string": null,
"price": 10,
"price_string": "10.00 SAR",
"additions_price": 0,
"additions_price_string": "0.00 SAR",
"total": 30,
"total_string": "30.00 SAR",
"images": [
{
"id": "static",
"origin": "https://media.zid.store/static/missing_image.png",
"thumbs": {
"fullSize": "https://media.zid.store/static/missing_image.png",
"thumbnail": "https://media.zid.store/static/missing_image.png",
"small": "https://media.zid.store/static/missing_image.png",
"medium": "https://media.zid.store/static/missing_image.png",
"large": "https://media.zid.store/static/missing_image.png"
}
}
],
"shipping": false,
"options": []
}
],
"shipping": {
"address": {
"district": "test",
"street": "test",
"city": {
"id": 1,
"name": "الرياض"
},
"country": {
"id": 183,
"name": "ساو تومي وبرينسيبي"
},
"meta": {
"shipping_address_meta": {
"buyer": {
"name": "POS Guest Customer",
"telephone": "966500000001",
"email": "pos_guest_customer@test.com"
}
}
}
},
"method": {
"id": 0,
"type": "pickup",
"is_system_option": false,
"name": null,
"estimated_delivery_time": null,
"code": ".option_",
"icon": "https://zid-testing-907587157081.s3.eu-west-1.amazonaws.com/static/delivery.png",
"tracking_number": null
}
},
"payment": {
"invoice": [
{
"code": "sub_totals",
"value": "30.0000",
"value_string": "30.00 SAR",
"title": "قيمة المنتجات"
},
{
"code": "total",
"value": "30.0000",
"value_string": "30.00 SAR",
"title": "المجموع الكلي"
}
],
"method": {
"id": 11182,
"name": "items.[]",
"code": "POS-CC",
"type": "pos"
}
},
"payment_method": {
"name": "بطاقة إئتمانية"
},
"customer_note": "Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test Test Test v Test Test",
"currency": {
"order_currency": {
"id": 2,
"code": "SAR",
"exchange_rate": 1
},
"order_store_currency": {
"id": 2,
"code": "SAR",
"exchange_rate": null
}
},
"coupon": null,
"items_count": 1,
"original_order_date": "27-05-2024 | 02:55 م",
"issue_date": "27-05-2024 | 02:58 م",
"created_at": "2024-05-27 11:58:39",
"updated_at": "2024-05-27 11:58:39",
"zatca": {
"qr_code_data": null
}
}
],
"returned_items": [
{
"id": "e291f766-e57c-467a-ad4e-8a06dd7b2a36",
"product_id": "4e3ffbe67db84a0fbcba534528e90eec",
"code": null,
"name": "تجريبي",
"custom_fields": [],
"sku": "Z.25653.17167197217481027",
"quantity": 3,
"is_taxable": true,
"is_discounted": false,
"meta": null,
"weight": null,
"net_price_with_additions": 10,
"net_price_with_additions_string": "10.00 SAR",
"price_with_additions": 10,
"price_with_additions_string": "10.00 SAR",
"net_price": "10.0000",
"net_price_string": "10.00 SAR",
"net_sale_price": null,
"net_sale_price_string": null,
"net_additions_price": 0,
"net_additions_price_string": null,
"original_price": null,
"original_price_string": null,
"gross_price": 0,
"gross_price_string": "0.00 SAR",
"gross_sale_price": null,
"gross_sale_price_string": null,
"price_before": null,
"price_before_string": null,
"total_before": null,
"total_before_string": null,
"gross_additions_price": 0,
"gross_additions_price_string": null,
"tax_percentage": 0,
"tax_amount": 0,
"tax_amount_string": "0.00 SAR",
"tax_amount_string_per_item": "0.00 SAR",
"sale_price": null,
"sale_price_string": null,
"price": 10,
"price_string": "10.00 SAR",
"additions_price": 0,
"additions_price_string": "0.00 SAR",
"total": 30,
"total_string": "30.00 SAR",
"images": [
{
"id": "static",
"origin": "https://media.zid.store/static/missing_image.png",
"thumbs": {
"fullSize": "https://media.zid.store/static/missing_image.png",
"thumbnail": "https://media.zid.store/static/missing_image.png",
"small": "https://media.zid.store/static/missing_image.png",
"medium": "https://media.zid.store/static/missing_image.png",
"large": "https://media.zid.store/static/missing_image.png"
}
}
],
"shipping": false,
"options": []
}
]
}
}
Request
Path Params
order-id
string
required
Example:
22350
Header Params
Accept
string
optional
Example:
application/json
Authorization
string
optional
Example:
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y
X-manager-Token
string
optional
X-Manager-Token
should be included in the header of API requests that require store-related information.Example:
eyJpdiI6ImdmbVQ5ZTFZWm5hRkdvbmFTQ2o2ZkE9PSIsInZhbHVlIjoiMDVXVU1yQWFaTDgvMEZwYW5JWGR1QVZCQ3hFUzQxQ2t3a1oxOGR2QWhEays3N28zeldtaytKU1pzL2tHQU9jT2dZMlZCcnBsUEp1TmcxTG1SWlBnMDVLc0R3dlpGZENsY0s2Y1RwNHpEbVpYbGtjYlVITVpzcy8rNHBkQmxqZExsZW01REJkZmdQb3FmZmNTWTZXZ2JWRitmRWpWSnRZU0NOcTFvRGdjRU9Obk5TZDZRL2FCRHdobytwK3JVZUsrbWJ3RmtmUHlOcEZMcENzUENxUEkrUHFZZTdPQ043S0xtczF0d1k1ekZlaz0iLCJtYWMiOiI0ZDM4MDk3NDMwZDRhZjNkOGI0MzU1ODdmZGVmNGJiNzFmYTE2ZTZjYWM1Njc0NTQ0NmIwMjY1NWMxZWY4ZDQyIiwidGFnIjoiIn0::
Accept-Language
string
optional
en
if not specified.Example:
en
User-Agent
string
optional
Example:
Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36
Responses
Modified at 2025-02-15 18:55:12