# Recall Consignment

Consignment is a batch of goods created for the movement of inventory. 

**Recall consignment** represents Inventory is recalled from Eshopbox FC

A recall consignment consists of:

* The Eshobpox FC from which you want to remove the inventory.
* *Contact* to which you want to get the inventory delivered after pick up.
* Inventory details like requested, out of stock, packed quantity.
* Important dates like:
  * Created on: Date on which the consignment is created.
  * Estimated Completion by: Date by which Eshopbox will complete the packing of the items.
  * Packed on: Actual date on which packing of the items is completed.
  * Scheduled for: Date for which the pickup appointment is taken for the consignment.
  * Dispatched on: Actual date on which the pickup of the consignment is done..

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

| **Attribute**       | Type                                            | **Description**                                                     |
| ------------------- | ----------------------------------------------- | ------------------------------------------------------------------- |
| `id`                | `integer`                                       | The unique identifier for this recall consignment                   |
| `accountId`         | `integer`                                       | Account id of that particular recall consignment                    |
| `fromWarehouseId`   | `integer`                                       | This is the warehouse id from where your items will return.         |
| `toPartyId`         | `integer`                                       | This is the party id where your items will be received.             |
| `consignmentNumber` | `string`                                        | `Eshopbox`  generated unique Identifier for this recall consignment |
| `inventoryType`     | `string`                                        | Inventory type  [`Enum`](#enum-inventory-type)                      |
| `itemsFileUrl`      | `string`                                        | Items url                                                           |
| `failedItemsUrl`    | `string`                                        | Failed item url                                                     |
| `status`            | `string`                                        | Recall consignment status [`Enum`](#enum-status)                    |
| `successCount`      | `integer`                                       | Success count                                                       |
| `failureCount`      | `integer`                                       | Failure count                                                       |
| `containersQty`     | `integer`                                       | Number of boxes                                                     |
| `scheduledDetails`  | [`array[object]`](#the-scheduleddetails-object) | Scheduled details of recall consignment                             |
| `createdAt`         | `string`                                        | The time at which a recall consignment is created                   |
| `updated`           | `string`                                        | The time at which a recall consignment is updated                   |
| {% endtab %}        |                                                 |                                                                     |

{% tab title="Sample object" %}

```
{
    "id": 1,
    "accountId": 12,
    "fromWarehouseId": 1,
    "toPartyId": 2,
    "consignmentNumber": "CON/45/873",
    "inventoryType":"GOOD",
    "itemsFileUrl": "https://storage.cloud.google.com/fileItems.appspot.com/items.pdf",
    "failedItemsUrl": "https://storage.cloud.google.com/failedItems.appspot.com/itemsFailed.pdf",
    "status": "COMPLETED",
    "successCount": 20,
    "failureCount": 0,
    "containersQty": 2,
    "scheduledDetails": {
        "pickingType": "ESHOPBOX",
        "scheduledTimeSlotFrom": "2019-09-01 09:23:02",
        "scheduledTimeSlotTo": "2019-09-02 02:23:02",
        "stockTransferNoteUrl": "https://storage.cloud.google.com/stockTransfer.appspot.com/transfer.pdf",
        "ewayBillUrl": "https://storage.cloud.google.com/ewayBill.appspot.com/bill.pdf",
        "invoiceUrl": "https://storage.cloud.google.com/invoice.appspot.com/invoice.pdf"
    },
    "createdAt": "2019-04-08T12:41:05.000+05:30",
    "updatedAt": "2019-04-08T12:41:05.000+05:30"
}
```

{% endtab %}
{% endtabs %}

### Enum: Inventory type

| **Attribute** | **Description**                                    |
| ------------- | -------------------------------------------------- |
| `GOOD`        | Inventory which is available for sale              |
| `QC_REJECTED` | Quality rejected at the time of inward consignment |
| `BAD`         | Not suitable for resale                            |

### Enum: status

| **Attribute** | **Description**                                     |
| ------------- | --------------------------------------------------- |
| `PENDING`     | Recall consignment creating under process           |
| `CREATED`     | Recall consignment created                          |
| `PROCESSING`  | Recall consignment, processing started at warehouse |
| `PACKED`      | Recall consignment packed at warehouse              |
| `DISPATCHED`  | Recall consignment dispatched from warehouse        |
| `CANCELLED`   | Recall consignment cancelled                        |
| `FAILED`      | Recall consignment failed                           |

### The `scheduledDetails` object

| **Attribute**                              | Type     | **Description**                      |
| ------------------------------------------ | -------- | ------------------------------------ |
| `scheduledDetails[].pickingType`           | `string` | consignment pickup type              |
| `scheduledDetails[].scheduledTimeSlotFrom` | `string` | From date to pick up the consignment |
| `scheduledDetails[].scheduledTimeSlotTo`   | `string` | To date to pick up the consignment   |
| `scheduledDetails[].stockTransferNoteUrl`  | `string` | Stock transfer note URL              |
| `scheduledDetails[].ewayBillUrl`           | `string` | Eway bill URL                        |
| `scheduledDetails[].invoiceUrl`            | `string` | Invoice URL                          |