> 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/parcels/get-specific-parcel.md).

# Get Specific Parcel

```php
GET /parcels/find/{parcel_id}
```

This API is used to retrieve detailed information about a specific parcel.

{% hint style="info" %}
**Note:** Replace <mark style="color:blue;">{parcel\_id}</mark> with the <mark style="color:blue;">parcel\_code</mark> of the parcel whose information you wish to retrieve.
{% endhint %}

#### Headers

<table><thead><tr><th width="374">Key</th><th>Value</th></tr></thead><tbody><tr><td>Accept</td><td>application/json</td></tr></tbody></table>

#### Request body

{% code lineNumbers="true" %}

```json
{
    "Shiply_API_KEY": "your_api_key"
}
```

{% endcode %}

#### Response body

{% tabs %}
{% tab title="Success" %}
Status code: <mark style="color:green;">200 OK</mark>

{% code lineNumbers="true" %}

```json
{
    "parcel_code": "asnf-000-5090230",
    "description": "تجربة 2",
    "customer_user_id": 4,
    "driver_user_id": 3,
    "paid_driver_id": null,
    "in_account": 0,
    "parcel_status_id": 5,
    "is_locked": 0,
    "parcel_position_id": 5,
    "address_id": 1469043,
    "recipient_id": 1462054,
    "qr_code": null,
    "qr_hash": "",
    "region_cost_map_id": null,
    "total_price": 200,
    "actual_price": 165,
    "parcel_delivery_cost": 20,
    "price_extra_fee": 0,
    "planned_date": "2024-10-23",
    "note": null,
    "weight": null,
    "length": 40,
    "width": 40,
    "height": 41,
    "size_fee": 0,
    "created_at": "2024-10-19 11:56:21",
    "updated_at": "2024-11-16 15:54:06",
    "customer_invoice_id": null,
    "final_parcel_status_id": null,
    "extra_delivery_cost": 0,
    "is_replacement": 0,
    "commission": 0,
    "customer_private_note": null,
    "cell": null,
    "reference_number": null,
    "discount_value": 0,
    "size": 65600,
    "total_size": 65600,
    "contents": [],
    "driver": {
        "id": 3,
        "first_name": " رامي محمد",
        "user_type_id": 1,
        "role_id": 1,
        "second_name": "",
        "last_name": "",
        "email": "zakaria.zorba@gmail.com",
        "email_verified_at": null,
        "phone_number": "0599123456",
        "phone_number_2": null,
        "landline_number": null,
        "account_status_id": 1,
        "created_at": "2020-02-14 00:09:00",
        "updated_at": "2024-10-10 12:39:43",
        "identity": null,
        "deleted_at": null,
        "start_work_at": null,
        "end_work_at": null,
        "private_note": null,
        "last_parcel_created_date": null,
        "profile_picture": null,
        "profile_picture_id": null,
        "app_id": null,
        "wallet_enabled": 0,
        "customer_contacts": []
    },
    "parcel_status": {
        "id": 5,
        "name": "Pending",
        "ar_aliase": "عالق",
        "en_aliase": "Pending",
        "description": ""
    },
    "parcel_position": {
        "id": 5,
        "name": "Driver",
        "ar_aliase": "مع السائق",
        "en_aliase": "Driver",
        "office_id": null,
        "description": ""
    },
    "address": {
        "id": 1469043,
        "city_id": 2,
        "village_id": 55,
        "street_name": "تجربة 2",
        "location_updated_at": null,
        "additional_information": null,
        "order": 0,
        "created_at": "2024-10-19 11:56:21",
        "updated_at": "2024-10-19 11:56:21",
        "location_updated_by_user_id": null,
        "hasLocation": false,
        "city": {
            "id": 9,
            "name": "عمان",
            "deleted_at": null
        },
        "village": {
            "id": 55,
            "city_id": 148,
            "name": "عمان",
            "region_id": 1,
            "region_type": 1,
            "note": null,
            "is_closed": 0,
            "deleted_at": null
        }
    },
    "recipient": {
        "id": 1462054,
        "address_id": 1469043,
        "first_name": "تجربة 2",
        "last_name": null,
        "note": null,
        "phone": "0598126148",
        "phone2": "0598126148",
        "is_blocked": 0,
        "created_at": "2024-10-19 11:56:21",
        "updated_at": "2024-10-19 11:56:21"
    },
    "final_parcel_status": null,
    "promotion_usages": [],
    "companion_parcels": []
}

```

{% endcode %}

The response contains all parcel information and you my focus on these parameters:\ <mark style="color:blue;">parcel\_code</mark>, <mark style="color:blue;">description</mark>, <mark style="color:blue;">qr\_code</mark>, <mark style="color:blue;">total\_price</mark>, <mark style="color:blue;">parcel\_delivery\_cost</mark>, <mark style="color:blue;">note</mark>, <mark style="color:blue;">extra\_delivery\_cost</mark>, <mark style="color:blue;">parcel\_status.name</mark>, <mark style="color:blue;">recipient.first\_name</mark>, <mark style="color:blue;">recipient.phone</mark>, <mark style="color:blue;">address.city\_id</mark>, <mark style="color:blue;">address.village\_id</mark>, <mark style="color:blue;">address.street\_name</mark>.
{% endtab %}

{% tab title="Parcel not found" %}
Status code: <mark style="color:red;">404 not found</mark>

{% code lineNumbers="true" %}

```json
{
    "error": "Parcel not found"
}
```

{% endcode %}

This response is returned when the <mark style="color:blue;">{parcel\_id}</mark> provided in the route does not correspond to an existing parcel.
{% endtab %}

{% tab title="Unauthorized" %}
Status code: <mark style="color:green;">200 OK</mark>

{% code lineNumbers="true" %}

```json
{
    "success": false,
    "errors": [
        "unauthorized"
    ]
}
```

{% endcode %}

This response is returned when the <mark style="color:blue;">Shiply\_API\_KEY</mark> is not included in the request body.
{% endtab %}
{% endtabs %}
