# Get an Inward Consignment

## Get inward consignment 

<mark style="color:blue;">`GET`</mark> `https://{{workspace}}.myeshopbox.com/api/v1/consignments`

This endpoint allows you to get the inward consignment

#### Query Parameters

| Name                | Type    | Description                                                         |
| ------------------- | ------- | ------------------------------------------------------------------- |
| consignment\_number | string  | `Eshopbox`  generated unique identifier for this inward consignment |
| consignmentDetails  | boolean | True: If you want  consignment received details in response         |

#### Headers

| Name           | Type   | Description                                         |
| -------------- | ------ | --------------------------------------------------- |
| Authentication | string | The Bearer token allows to grant access to the API. |

{% tabs %}
{% tab title="200 Inward consignment successfully retrieved." %}

```
{
   "id": "7630",
   "consignmentNumber": "CON/45/873",
   "refConsigmentNumber": "675986",
   "fromPartyId": "5",
   "refFromPartyID": "PW60",
   "fromPartyName": "Kapas Kraft Fashion Limited",
   "toPartyId": "72",
   "toPartyName": "Eshopbox Gurgaon(Sohana)",
   "refToPartyID": "ESBFLPLT",
   "type": "INWARD",
   "status": "SCHEDULED",
   "warehouseId": "7",
   "warehouseName": "Kapas Kraft Apparels Limited 1006",
   "externalWarehouseId": "2022",
   "document": [
    {
     "document_type": "inv",
     "document_number": "45243",
     "document_url": "https://cdn.filestackcontent.com/45243"
    }
   ],
   "schedule": {
     "scheduledArrivalDate": "2020-03-23T00:03:00.000Z",
     "scheduledArivalFrom": "10:00:00",
     "scheduledArivalTo": "11:00:00",
     "receivedOn": "2020-03-19 17:46:40.0",
     "completedOn": null,
     "cancelledOn": null
   },
   "itemSummary": {
     "consignmentQty": "45",
     "receivedQty": 20,
     "pendingQty": "45",
     "qcAcceptedQty": 20,
     "qcRejectedQty": 1,
     "shortageQty": "0",
     "unexpectedQty": "0",
     "boxQty": 1,
     "rejectedImagesUrl": [
      "https://storage.cloud.google.com/rejected.appspot.com/345.jpg"
     ],
     "acknowledgmentSlipUrl": [
      "https://storage.cloud.google.com/acknowlwdgement.appspot.com/1234567.pdf"
     ],
     "damagedQty": 2
   },
   "trackingDetails": {
      "transportBy": "Client",
      "courierName": XC-AIR,
      "trackingNumber": null,
      "vehiclePlateNumber": HR-26 5234,
      "sealID": 5490
   },
   "uploadDetails": {
      "successCount": 3,
      "failureCount": 0
     },
   "remarks": null,
   "estimatedCompletionDate": "2020-03-20T00:00:00.000Z",
   "failureReason": null,
   "requestReschedule": null,
   "slaStatus": null,
   "failImageUrl": "https://storage.googleapis.com/failImage.appspot.com/fail417.zip",
   "numberOfAvailableBoxes": 2,
   "numberOfDamagedBoxes": 0,
   "createdOn": "2020-03-18T14:32:57.000Z",
   "updatedOn": "2020-03-23T13:54:06.000Z"
  
  }
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X GET https://{{workspace}}.myeshopbox.com/api/v1/consignments \    
 -H "Authorization: Bearer XXXX"
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://eshop.gitbook.io/eshopbox-developers/consignment/inward-consignment/get-an-inward-consignment.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.