> For the complete documentation index, see [llms.txt](https://shiply-integration-apis.gitbook.io/shiply-integration-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://shiply-integration-apis.gitbook.io/shiply-integration-documentation/integration-apis/invoices/get-invoice.md). # Get Invoice ```php GET /customerInvoices/find ``` This API is used to retrieve the details of a specific customer invoice. #### Headers
KeyValue
Acceptapplication/json
#### Request body {% code lineNumbers="true" %} ```json { "id": "asnf-625864", // required "Shiply_API_KEY": "your_api_key" } ``` {% endcode %} {% hint style="info" %} **Note:** Replace {id} with the invoice\_code of the invoice whose information you wish to retrieve. {% endhint %} #### Response body {% tabs %} {% tab title="Success" %} Status code: 200 OK {% code lineNumbers="true" %} ```json { "success": true, "invoice": { "invoice_code": "asnf-625864", "invoice_type_id": 1, "customer_user_id": 4, "sales_user_id": null, "invoice_status_id": 4, "invoice_amount": -111, "closed_by": 4, "code": 5640, "recipient_name": null, "closed_at": "2026-05-25 13:26:52", "created_at": "2026-05-25T10:26:52.000000Z", "updated_at": "2026-05-25T10:26:52.000000Z", "delivered_parcels_count": 1, "returned_parcels_count": 0, "attachment": null, "attachment_url": "https://stage.shiplylogistics.com/api/files/", "locked": false, "original_value": -111, "region_classification": { "القدس": { "total": 1, "delivered": "1", "returned": "0", "replaced": "0" } }, "transaction_number": "TXN-HSGJE5-161717", "attachments": [], "invoice_status": { "id": 4, "name": "moved_to_wallet", "ar_name": "محفظة", "description": "The invoice's value has been transfered to the customer wallet.", "created_at": "2025-07-06T07:00:49.000000Z", "updated_at": "2025-07-06T07:00:49.000000Z" }, "invoice_parcels": [ { "parcel_code": "asnf-000-6945469", "sequence_number": 3734, "description": "master content discrtisadasd", "customer_instructions": "ss", "customer_user_id": 4, "bulk_upload_id": null, "driver_user_id": null, "paid_driver_id": null, "in_account": 0, "parcel_status_id": 8, "is_locked": 0, "parcel_position_id": 6, "parcel_type_id": null, "reference_parcel_code": null, "returned_reason_id": null, "address_id": 1471222, "recipient_id": 1464313, "qr_code": "shiply_saad9", "qr_hash": "", "region_cost_map_id": 8295, "total_price": -90, "actual_price": 69, "parcel_delivery_cost": 21, "price_extra_fee": 0, "sc_payment_fees": "0.00", "cc_payment_fees": "0.00", "is_paid_using_visa_card": 0, "planned_date": null, "note": null, "weight": 1, "length": 40, "width": 40, "height": 40, "size_fee": 0, "created_at": "2026-05-25 13:25:09", "updated_at": "2026-05-25 13:26:52", "customer_invoice_id": 126123, "final_parcel_status_id": 6, "extra_delivery_cost": 0, "is_replacement": 0, "commission": 0, "customer_private_note": null, "cell": null, "reference_number": null, "is_completely_received": 1, "is_fragile": 0, "deleted_at": null, "delivery_method": "normal", "customer_net_amount": "-111.00", "discount_value": 0, "size": 64000, "total_size": 64000, "delivery_method_object": { "key": "normal", "ar_name": "عادي", "en_name": "Normal" }, "contents": [], "customer": { "id": 4, "first_name": "demo" }, "final_parcel_status": { "id": 6, "name": "Delivered", "ar_aliase": "واصل", "en_aliase": "Delivered", "description": "" }, "address": { "id": 1471222, "city_id": 1, "village_id": 256, "street_name": "الاستلام من مكتب شبلي", "location_updated_at": null, "additional_information": null, "order": 0, "created_at": "2025-12-14T12:00:52.000000Z", "updated_at": "2025-12-14T12:00:52.000000Z", "location_updated_by_user_id": null, "hasLocation": false, "city": { "id": 1, "name": "القدس" }, "village": { "id": 256, "name": "بيت صفافا" } }, "recipient": { "id": 1464313, "address_id": 1471222, "first_name": "عرين مبسلط", "last_name": "", "note": null, "phone": "0595120839", "phone2": null, "is_blocked": 0, "is_master": 0, "recipient_info_id": 461, "created_at": "2025-12-14T12:00:52.000000Z", "updated_at": "2025-12-14T12:00:52.000000Z" }, "companion_parcels": [], "last_delivered_history": { "id": 15397647, "parcel_status_id": 6, "parcel_position_id": 6, "actor_user_id": 11, "driver_id": null, "history_type": 1, "note": "", "created_at": "2026-05-25T10:26:05.000000Z", "updated_at": "2026-05-25T10:26:05.000000Z" }, "promotion_usages": [], "companion_parcels_count": 0 } ], "invoice_exceptions": [], "invoice_type": { "id": 1, "ar_name": "فاتورة نقدية", "en_name": "Cash invoice type", "key": "CASH_INVOICE_TYPE" }, "customer": { "id": 4, "first_name": "demo", "user_type_id": 8, "role_id": null, "second_name": "", "third_name": "", "last_name": "", "nationality": null, "email": "demo@demo.com", "date_of_birth": null, "email_verified_at": null, "phone_number": "+970597271855", "phone_number_2": "092328793", "landline_number": "092328793", "account_status_id": 1, "user_status_id": 2, "created_at": "2020-02-13T22:19:25.000000Z", "updated_at": "2026-06-18T06:48:17.000000Z", "identity": "403434345", "identity_doc_type": null, "deleted_at": null, "start_work_at": null, "end_work_at": null, "private_note": "Private demo Note 4 edited from search screen", "last_parcel_created_date": "2023-08-02 16:06:32", "profile_picture": "ProfilePictures/Pk9BCAdVlNURYg0tyHoH_4_1771767525_699b06e5f1d1b.jpg", "profile_picture_id": 10951, "app_id": 4, "last_login": "2026-06-18 09:37:52", "last_checkin": null, "login_required_at": "2026-05-05T09:54:16.000000Z", "wallet_enabled": 1, "can_borrow": 1, "customer_info": { "customer_user_id": 4, "customer_code": "asnf", "business_name": "الاسم التجاري للديمو", "customer_number": "00010262", "customer_developer_info_id": null, "event_webhook_url": "https://webhook.site/5c04810c-dd42-4a6c-8493-09cad4f6d709", "delivered_parcel_cost": 20, "returned_parcel_cost": 10, "al_quds_delivered_parcel_cost": 35, "al_quds_returned_parcel_cost": 20, "occupied_lands_delivered_parcel_cost": 75, "occupied_lands_returned_parcel_cost": 0, "max_balance": 40000, "invoice_creation_limit": 1, "price_extra_fee_threshold": 500, "price_extra_fee_percentage": 0.1, "price_extra_fee_percentage_returned": 0.055, "url": "1234", "fixed_commission_value": 0, "percent_commission_value": 0, "show_driver_phone": 1, "include_parcel_after_deliver_time": 0, "max_companions": 4, "extra_size_factor": 1, "size_fee_discount_percentage": "0.00", "default_parcel_length": 45, "default_parcel_width": 45, "default_parcel_height": 45, "customer_classification_id": 4, "customer_success_manager": 1719, "max_price_for_parcel": 2000, "is_receive_returns_from_office": 1, "visa_payment_enabled": 1, "agreed_to_cover_visa_commission": 1, "visa_commission_value": "0.10", "is_deliver_parcels_to_office": 1, "is_receive_invoices_from_office": 1, "cell": "4D", "is_product_catalog_enabled": 0, "parcel_creation_mode_id": 3, "is_fragile_enabled": 0, "cs_cart_company_id": 22, "cs_cart_email": "demo@demo.com", "location_url": "https://www.google.com/maps/@32.2254464,35.2571557,19.03z?entry=ttu&g_ep=EgoyMDI1MDcyOC4wIKXMDSoASAFQAw%3D%3D", "cs_cart_account_status": "ACTIVE", "cs_cart_company_name": "Demo Store", "requires_returned_parcels_statement": 0, "max_bulk_parcel_rows": 300, "can_search_any_recipient": 1, "lead_source_id": 1, "referred_by": 77, "is_shiply_store_enabled": 1 } }, "promotion_usages": [], "wallet_transaction": { "transaction_number": "TXN-HSGJE5-161717", "user_id": 4, "wallet_id": 5, "type_id": 1, "amount": -111, "status": "COMPLETED", "balance_before": 28437.15, "balance_after": 28326.15, "description": "تحويل فاتورة رقم #126123 بقيمة -111 ILS إلى المحفظة", "reference_type": "INVOICE", "author_id": 4, "created_at": "2026-05-25T10:26:52.000000Z", "updated_at": "2026-05-25T10:26:52.000000Z", "deleted_at": null }, "sales": [] } } ``` {% endcode %} {% endtab %} {% tab title="Invoice not found" %} Status code: 200 OK {% code lineNumbers="true" %} ```json { "success": false, "error": "the invoice was not found" } ``` {% endcode %} This response is returned when the {id} provided in the route does not correspond to an existing invoice. {% endtab %} {% tab title="Unauthorized" %} Status code: 200 OK {% code lineNumbers="true" %} ```json { "success": false, "errors": [ "unauthorized" ] } ``` {% endcode %} This response is returned when the Shiply\_API\_KEY is not included in the request body. {% endtab %} {% endtabs %}