# Inward Consignment
Consignment is a batch of goods created for the movement of inventory.
#### **INWARD CONSIGNMENT**
With each inward Consignment, you will be able to view its:
* *Contact* from which you’ll be sending the inventory.
* The Eshobpox FC to which you’ll send the inventory.
* Inventory details like ordered, received, accepted, rejected (with reasons), shortage and unexpected quantity.
* Important dates like:
* Created on: Date on which the consignment is created.
* Scheduled for: Date for which the delivery appointment is taken for the consignment.
* Delivered on: Actual date on which the consignment is delivered
* Estimated Completion by: Date by which Eshopbox will complete the receiving of the items.
* Completed on: Actual date on which receiving of the items is completed.
####
### The `Inward consignment` Object
{% tabs %}
{% tab title="Attributes" %}
| Attribute | Type | Description |
| ------------------------- | ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `id` | `integer` | The unique identifier for this inward consignment |
| `consignmentNumber` | `string` | Identifier for this inward consignment |
| `refConsigmentNumber` | `string` | You can provide own identifier for this inward consignment |
| `fromPartyId` | `integer` | Your party id from where your items will be shipped |
| `refFromPartyID` | `string` | Your party code from where your items will be shipped |
| `fromPartyName` | `string` | Your party name from where your items will be shipped |
| `toPartyId` | `integer` | `Eshopbox` party id where your items will be shipped |
| `refToPartyID` | `string` | `Eshopbox` party code where your items will be shipped |
| `toPartyName` | `string` | `Eshopbox` party name where your items will be shipped |
| `type` | `string` | Consignment type equals to `INWARD` |
| `status` | `string` | Status of consignment [`Enum`](/eshopbox-developers/consignment/inward-consignment.md#enum-status) |
| `warehouseId` | `string` | `Eshopbox` warehouse id |
| `warehouseName` | `string` | `Eshopbox` warehouse name |
| `externalWarehouseId` | `string` | `Eshopbox` warehouse code |
| `schedule` | [`array[object`](/eshopbox-developers/consignment/inward-consignment.md#the-schedule-object)`]` | Consignment schedule details |
| `document` | [`array[object]`](/eshopbox-developers/consignment/inward-consignment.md#the-document-object) | Consignment documents details |
| `itemSummary` | [`array[object]`](/eshopbox-developers/consignment/inward-consignment.md#the-itemsummary-object) | Items details summary |
| `trackingDetails` | [`array[object]`](/eshopbox-developers/consignment/inward-consignment.md#the-trackingdetails-object) | Tracking details summary |
| `uploadDetails` | [`array[object]`](/eshopbox-developers/consignment/inward-consignment.md#the-uploaddetails-object) | upload details summary |
| `remarks` | `string` | Remarks on consignment provided by `Eshopbox` warehouse team |
| `estimatedCompletionDate` | `string` | Estimate consignment completed date |
| `failureReason` | `string` | Consignment failure reason |
| `requestReschedule` | `string` | Consignment reschedule flag `Enum` |
| `failImageUrl` | `string` | Damage item image URL |
| `numberOfAvailableBoxes` | `string` | Total number of boxes |
| `numberOfDamagedBoxes` | `string` | Number of damaged boxed |
| `createdOn` | `string` | The time at which a inward consignment is created |
| `updatedOn` | `string` | The time at which a inward consignment is updated |
| {% endtab %} | | |
{% tab title="Sample Object" %}
```
{
"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 %}
### Enum: status
| Attribute | Description |
| ----------- | --------------------------------------------------------------- |
| `CREATING` | Consignment creating under process |
| `CREATED` | Consignment created |
| `SCHEDULED` | Consignment scheduled for deliver items to `Eshopbox` warehouse |
| `DELIVERED` | Consignment items delivered at `Eshopbox` warehouse |
| `COMPLETED` | Quality checked at`Eshopbox` warehouse |
| `CANCELLED` | Consignment cancelled |
| `FAILED` | Consignment failed |
### The `schedule` object
| Attribute | Type | Description |
| --------------------------------- | -------- | -------------------------------------------- |
| `schedule[].scheduledArrivalDate` | `string` | Consignment schedule date |
| `schedule[].scheduledArivalFrom` | `string` | Consignment schedule from time |
| `schedule[].scheduledArivalTo` | `string` | Consignment schedule to time |
| `schedule[].receivedOn` | `string` | Consignment received at `Eshopbox` warehouse |
| `schedule[].completedOn` | `string` | Consignment completed date |
| `schedule[].cancelledOn` | `string` | Consignment cancelled date |
### The `itemSummary` object
| Attribute | Type | Description |
| -------------------------------------- | --------- | ----------------------------------------------------- |
| `itemSummary[].consignmentQty` | `string` | Consignment total quantity |
| `itemsSummary[].receivedQty` | `string` | Consignment received quantity at `Eshopbox` warehouse |
| `itemSummary[].pendingQty` | `string` | Consignment pending quantity |
| `itemSummary[].qcAcceptedQty` | `string` | Accepted quantity in quality checked |
| `itemSummary[].qcRejectedQty` | `string` | Rejected quantity in quality checked |
| `itemSummary[].unexpectedQty` | `string` | Unexpected quantity received at `Eshopbox` warehouse |
| `itemSummary[].shortageQty` | `string` | Shortage quantity |
| `itemSummary[].damagedQty` | `string` | Total damaged quantity |
| `itemSummary[].boxQty` | `integer` | Total box quantity |
| `itemsSummary[].rejectedImagesUrl` | `object` | Rejected items |
| `itemsSummary[].acknowledgmentSlipUrl` | `string` | Acknowledgment slip URL |
### The `document` object
| Attribute | Type | Description |
| ----------------------------- | -------- | --------------------------- |
| `document[].document_type` | `string` | Consignment document type |
| `documents[].document_number` | `string` | Consignment document number |
| `documents[].document_url` | `string` | Consignment document URL |
### The `trackingDetails` object
| Attribute | Type | Description |
| -------------------------------------- | -------- | ------------------------------------------------------------------------------------------- |
| `trackingDetails[].sealID` | `string` | Seal id of vehicle which which will deliver consignment delivered at `Eshopbox` warehouse |
| `trackingDetails[].trackingNumber` | `string` | Tracking number of consignment delivered at `Eshopbox` warehouse |
| `trackingDetails[].vehiclePlateNumber` | string | Vehicle plate number name of consignment delivered at `Eshopbox` warehouse |
| `trackingDetails[].transportBy` | `string` | Transport info of consignment delivered at `Eshopbox` warehouse |
| `trackingDetails[].courierName` | `string` | Courier name of consignment delivered at `Eshopbox` warehouse |
### The `uploadDetails` object
| Attribute | Type | Description |
| ------------------------------ | --------- | ------------------------- |
| `uploadDetails[].successCount` | `integer` | Consignment success count |
| `uploadDetails[].failureCount` | `integer` | Consignment failure count |
---
# 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.md?ask=
```
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.