# Get all Shipments

## Get All Shipments

<mark style="color:blue;">`GET`</mark> `https://wms.eshopbox.com/api/order/shipment`

This endpoint allows you to get All Shipments.

#### Query Parameters

| Name             | Type   | Description                                |
| ---------------- | ------ | ------------------------------------------ |
| page             | string | The number of page to offset the result by |
| perPage          | string | The number of items return per page        |
| status           | string | status of shipment                         |
| expectedShipDate | number | Expected ship date of shipments            |

#### Headers

| Name           | Type   | Description                          |
| -------------- | ------ | ------------------------------------ |
| Authentication | string | Bearer Token to grant access the API |

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

```php
{
    "current_page": 1,
    "data": [
        {
            "customerOrderNumber": "OD119208447831346000",
            "vendorOrderNumber": "11920832654052201",
            "externalShipmentID": "300884672-5-87",
            "externalWarehouseID": "W4585",
            "externalChannelID": "TATA CLIQ VELOCY KAPAS KRAFT",
            "defaultWarehouseCode": "2022",
            "orderDate": "2018-06-26 12:17:34",
            "portal_id": 16,
            "paymentType": "CreditCard",
            "expectedShipDate": "2018-07-03 12:20:05",
            "externalManifestNumber": null,
            "channelManifestNumber": null,
            "order_id": 4262,
            "channel_id": 5,
            "warehouse_id": 9,
            "channel_account_id": null,
            "account_id": 3,
            "region": "National",
            "picklistCode": null,
            "invoiceNumber": "GNCL182229",
            "boxType": "",
            "isPriorityShipment": "0",
            "isGift": "0",
            "invoice_url": "",
            "invoiceDate": "2018-06-28 18:52:37",
            "label_url": "",
            "labels": "",
            "shippingInfo": [],
            "boxAdditionalRecommendation": [],
            "dimension_length": "0",
            "dimension_width": "0",
            "dimension_height": "0",
            "weight": "0.867",
            "trackingID": "69608318146",
            "packageID": "",
            "barcode": "",
            "courierName": "Bluedart_Clarks",
            "created_at": "2018-10-19 10:26:39",
            "updated_at": "2019-04-07 00:17:50",
            "status": "created",
            "remarks": "",
            "customerName": "John Doe",
            "customerContactNumber": "9998889998",
            "email": "johndoe@gmail.com",
            "channelSlug": "clarks",
            "status_updated_at": "2018-10-19 10:26:39",
            "status_log": {
                "created": "2018-10-19 10:26:39"
            },
            "orderExternalCreatedAt": "2018-06-26 12:20:08",
            "shippingAddress": {
                "customerName": "John Doe",
                "addressLine1": "Kapas Kraft Apparels Limited",
                "addressLine2": "Banglore",
                "city": "bengluru",
                "state": "Karnataka",
                "postalCode": "560005",
                "countryCode": "91",
                "countryName": "India",
                "contactPhone": "9998889998",
                "email": "johndoe@gmail.com"
            },
            "id": 181411,
            "isCOD": "0",
            "track_payload": [],
            "items": []
        },
        {
          "customerOrderNumber": "OD119208447831346000",
            "vendorOrderNumber": "11920832654052201",
            "externalShipmentID": "300884672-5-87",
            "externalWarehouseID": "W4585",
            "externalChannelID": "TATA CLIQ VELOCY KAPAS KRAFT",
            "defaultWarehouseCode": "2022",
            "orderDate": "2018-06-26 12:17:31",
            "portal_id": 16,
            "paymentType": "NetBanking",
            "expectedShipDate": "2018-07-03 12:20:01",
            "externalManifestNumber": null,
            "channelManifestNumber": null,
            "order_id": 4261,
            "channel_id": 5,
            "warehouse_id": 9,
            "channel_account_id": null,
            "account_id": 3,
            "region": "National",
            "picklistCode": null,
            "invoiceNumber": "GNCL182227",
            "boxType": "",
            "isPriorityShipment": "0",
            "isGift": "0",
            "invoice_url": "",
            "invoiceDate": "2018-06-28 18:50:56",
            "label_url": "",
            "labels": "",
            "shippingInfo": [],
            "boxAdditionalRecommendation": [],
            "dimension_length": "0",
            "dimension_width": "0",
            "dimension_height": "0",
            "weight": "0.25",
            "trackingID": "69608317951",
            "packageID": "",
            "barcode": "",
            "courierName": "Bluedart_Clarks",
            "created_at": "2018-10-19 10:26:39",
            "updated_at": "2019-04-07 00:17:50",
            "status": "created",
            "remarks": "",
            "customerName": "sam",
            "customerContactNumber": "9999999999",
            "email": "sam@gmail.com",
            "channelSlug": "clarks",
            "status_updated_at": "2018-10-19 10:26:39",
            "status_log": {
                "created": "2018-10-19 10:26:39"
            },
            "orderExternalCreatedAt": "2018-06-26 12:20:04",
            "shippingAddress": {
                "customerName": "sam",
                "addressLine1": "Kapas Kraft Apparels Limited",
                "addressLine2": "bangalore",
                "city": "Bangalore",
                "state": "Karnataka",
                "postalCode": "560016",
                "countryCode": "IN",
                "countryName": "India",
                "contactPhone": "9999999999",
                "email": "sam@gmail.com"
            },
            "id": 181490,
            "isCOD": "0",
            "track_payload": [],
            "items": []
        },
        {
            "customerOrderNumber": "OD119208447831346000",
            "vendorOrderNumber": "11920832654052201",
            "externalShipmentID": "300884672-5-87",
            "externalWarehouseID": "W4585",
            "externalChannelID": "TATA CLIQ VELOCY KAPAS KRAFT",
            "defaultWarehouseCode": "2022",
            "orderDate": "2019-04-11 14:49:34",
            "portal_id": 16,
            "paymentType": "CreditCard",
            "expectedShipDate": null,
            "externalManifestNumber": null,
            "channelManifestNumber": null,
            "order_id": 536056,
            "channel_id": 5,
            "warehouse_id": 3,
            "channel_account_id": null,
            "account_id": 3,
            "region": "Local",
            "picklistCode": null,
            "invoiceNumber": "",
            "boxType": "UNKNOWN",
            "isPriorityShipment": "0",
            "isGift": "0",
            "invoice_url": "",
            "invoiceDate": null,
            "label_url": "",
            "labels": "",
            "shippingInfo": [],
            "boxAdditionalRecommendation": [],
            "dimension_length": "0",
            "dimension_width": "0",
            "dimension_height": "0",
            "weight": "0.7",
            "trackingID": "",
            "packageID": "",
            "barcode": "",
            "courierName": "",
            "created_at": "2019-04-11 14:55:51",
            "updated_at": "2019-04-11 15:02:06",
            "status": "created",
            "remarks": "",
            "customerName": "sam",
            "customerContactNumber": "9999999999",
            "email": "sam@gmail.in",
            "channelSlug": "clarks",
            "status_updated_at": "2019-04-11 14:55:51",
            "status_log": {
                "created": "2019-04-11 14:55:51"
            },
            "orderExternalCreatedAt": "2019-04-11 14:55:47",
            "shippingAddress": {
                "customerName": "sam",
                "addressLine1": "Kapas Kraft Apparels Limited",
                "addressLine2": "gurgaon",
                "city": "Gurgaon",
                "state": "Haryana",
                "postalCode": "122018",
                "countryCode": "IN",
                "countryName": "India",
                "contactPhone": "9999999999",
                "email": "sam@gmail.in"
            },
            "id": 549718,
            "isCOD": "0",
            "track_payload": [],
            "items": [
                {
                    "lineItemSequenceNumber": 33373,
                    "orderItemID": "11920832654052201",
                    "itemID": "DB9U03FMGWZ",
                    "sku": "123_S",
                    "asin": "91261298854040",
                    "productName": "Brinkley Lonna",
                    "quantity": 1,
                    "customerPrice": 1799,
                    "lineItemTotal": 0.10000000000000001,
                    "invoiceTotal": 150.09999999999999,
                    "discount": 1798.9000000000001,
                    "taxRate": 0,
                    "taxAmount": 0,
                    "giftMessage": "",
                    "giftLabelContent": "",
                    "lineItemOrderStatus": "",
                    "orderItemIDs": [
                        "300027859-1318430"
                    ],
                    "productImageUrl": null,
                    "productAdditionalInfo": null,
                    "expectedDeliveryDate": null,
                    "shippingCharges": 150,
                    "productUrl": null,
                    "originalOrderItemId": null
                }
            ]
        }
    ],
    "first_page_url": "https://eshopbox-wms-api-dot-eshopbox-2018.appspot.com/api/order/shipment?page=1&per_page=10&status=created",
    "from": 1,
    "last_page": 33,
    "last_page_url": "https://eshopbox-wms-api-dot-eshopbox-2018.appspot.com/api/order/shipment?page=33&per_page=10&status=created",
    "next_page_url": "https://eshopbox-wms-api-dot-eshopbox-2018.appspot.com/api/order/shipment?page=2&per_page=10&status=created",
    "path": "https://eshopbox-wms-api-dot-eshopbox-2018.appspot.com/api/order/shipment",
    "per_page": "10",
    "prev_page_url": null,
    "to": 10,
    "total": 327
}
```

{% endtab %}
{% endtabs %}

```
curl -X GET http://wms.eshopbox.com/api/order/shipment?page=1&per_page=10&status=created&expectedShipDate=2018-05-31 \
-H "Authorization: Bearer XXXX" \
    -H "Content-Type: application/json" \
    -d $'{}
```


---

# 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/order/shipments/get-all-shipments.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.
