# Get Bulk Pincode Serviceability

## Bulk Pincode Serviceability API

```
GET: https://wms.eshopbox.com/shipping-wms/api/v1/bulkPincodeServiceability
```

### Header

| Name          | Value              |
| ------------- | ------------------ |
| Content-Type  | `application/json` |
| Authorization | `Bearer <token`    |

### Body

| Name         | Type   | Description                                                                                                    | Required |
| ------------ | ------ | -------------------------------------------------------------------------------------------------------------- | -------- |
| shippingMode | String | Optional filter to specify the shipping mode (e.g., prime, express, standard). Multiple modes can be provided. | No       |

**Get All Serviceable Pincodes**

This request returns serviceability details for **all pincodes** across **all available shipping modes**.

```
GET https://wms.eshopbox.com/shipping-wms/api/v1/bulkPincodeServiceability
```

#### Get Pincodes for Specified Shipping Mode

This request retrieves serviceability details for **multiple specified shipping modes** (e.g., `"express"` and `"standard"`).

```
GET https://wms.eshopbox.com/shipping-wms/api/v1/bulkPincodeServiceability?shippingMode=express
```

### Response

```json
```

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

```json
{
    "eshopboxPrime": {
        "shippingMode": "prime",
        "totalPickupPincodes": 4,
        "totalCODPincodes": 3,
        "totalPrepaidPincodes": 4,
        "pickupPincode": [
            "110019",
            "110020",
            "110021",
            "110061"
        ],
        "codPincode": [
            "110020",
            "110021",
            "110061"
        ],
        "prepaidPincode": [
            "110019",
            "110020",
            "110021",
            "110061"
        ]
    },
    "eshopboxExpress": {
        "shippingMode": "express",
        "totalPickupPincodes": 5,
        "totalCODPincodes": 4,
        "totalPrepaidPincodes": 5,
        "pickupPincode": [
            "110001",
            "110002",
            "110003",
            "110004",
            "110005"
        ],
        "codPincode": [
            "110002",
            "110003",
            "110004",
            "110005"
        ],
        "prepaidPincode": [
            "110001",
            "110002",
            "110003",
            "110004",
            "110005"
        ]
    },
    "eshopboxStandard": {
        "shippingMode": "standard",
        "totalPickupPincodes": 3,
        "totalCODPincodes": 2,
        "totalPrepaidPincodes": 3,
        "totalReversePickupPincodes": 3,
        "totalReversePickupDoorstepQcPincodes": 2,
        "pickupPincode": [
            "120001",
            "120002",
            "120003"
        ],
        "codPincode": [
            "120002",
            "120003"
        ],
        "prepaidPincode": [
            "120001",
            "120002",
            "120003"
        ],
        "reversePickupPincode": [
            "130001",
            "130002",
            "130003"
        ],
        "reversePickupDoorstepQcPincode": [
            "140001",
            "140002"
        ]
    },
    "eshopboxHyperlocal": {
        "shippingMode": "hyperlocal",
        "totalPickupPincodes": 6,
        "totalCODPincodes": 5,
        "totalPrepaidPincodes": 6,
        "pickupPincode": [
            "150001",
            "150002",
            "150003",
            "150004",
            "150005",
            "150006"
        ],
        "codPincode": [
            "150002",
            "150003",
            "150004",
            "150005",
            "150006"
        ],
        "prepaidPincode": [
            "150001",
            "150002",
            "150003",
            "150004",
            "150005",
            "150006"
        ]
    }
}

```

{% endtab %}

{% tab title="400" %}

```json
{
  "error": {
    "code": 400,
    "message": "Invalid shipping mode value: prim. Please provide a valid value.",
    "errors": [
      {
        "reason": "BAD_REQUEST",
        "domain": "global",
        "message": "Invalid shipping mode value: prim. Please provide a valid value."
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

```bash
curl --location 'https://wms.eshopbox.com/shipping-wms/api/v1/bulkPincodeServiceability?shippingMode=express' \
  --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlJVVXdSREZCUVRSRFFqQkdORFUxTVVZeE16ZEdPRFJHTnpORk5EaEJSVEU0TVVORk5qVTJOdyJ9.eyJodHRwczovL2FwcERhdGEiOnt9LCJodHRwczovL2FjY291bnRzIjpbInFhc3RhZ2luZzEwMDIwMCIsInFhc3RhZ2luZyJdLCJodHRwczovL3dhcmVob3VzZVdvcmtzcGFjZXMiOlsicWFzdGFnaW5nMTAwMjAwIl0sImh0dHBzOi8vd2FyZWhvdXNlcyI6W10sImh0dHBzOi8vcGFydG5lcnMiOltdLCJodHRwczovL3VzZXJEZXRhaWxzIjp7ImVtYWlsIjoiZGVlcGFrLmdvc3dhbWlAZXNob3Bib3guY29tIiwiaWQiOjU3NjcsInVzZXJUeXBlIjoiZGVmYXVsdCJ9LCJpc3MiOiJodHRwczovL2xvZ2luLmF1cGVyYXRvci5jby8iLCJzdWIiOiJlbWFpbHw2NzA2MjFkN2Y4ZjA2YjdkZThjNjdiODciLCJhdWQiOlsiaHR0cHM6Ly9lc2hvcGJveC1wb3J0YWwtZGV2LmFwcHNwb3QuY29tIiwiaHR0cHM6Ly9lc2hvcGJveC1wYXltZW50LXJlY28uYXV0aDAuY29tL3VzZXJpbmZvIl0sImlhdCI6MTczNTI4MjU2NiwiZXhwIjoxNzM1MzY4OTY0LCJzY29wZSI6Im9wZW5pZCBwcm9maWxlIGVtYWlsIiwiYXpwIjoiVFNIMlRYeDdXdmZ4NmhwcElGZnpsNWNiMU1HcXY5VnAifQ.u_QZ13mJKMggNYPIw3KTb9QHYlCv2DtVJohXbRxuC0rlMoRGxAbIbknAvIaCjMKk063-mSSSceb_fu2T715ug6aLgw0Ucuq778PR4IS3HpTK1_pWrUrVJ5RpWdop9EzYcavA9OH42bW6u6O-FuwAa95BdzTgfXI6_PARqAh60SlIT0FbEFAjpe-KP6b0hq0WlKwgC8lJPwuJTGrJ3hHJg9xZ4k00WjKa0XxWxyb_2UGLv2f__V-xBh31PHJ7au9X5DMZs-jX54l10clmy02pjJoAQt4bwJMGsHPzX0IcBWD1DbsUZhr7O4PTA1pQWFQ66WKd4yVHjK-HgHfg4UfXdQ' \
  --header 'proxyHost: qastaging' \
  --header 'Cookie: JSESSIONID=B0F22459870472D9543FE460E2881E6D' \
  --data ''
```


---

# 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/advanced/pincode-serviceability-api/get-bulk-pincode-serviceability.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.