Check Address Serviceable

This api is used to find if the address is servicable by 1mg. Address is provided in the request body.

For checking address servicability via geodata latitude and longitude, provide city, state and street as mandatory, along with pincode in the address key.

::: requestmodel

Property	Type?	Required?
address	Object	Required
address.pincode	String	Required
address.street	String	Optional
address.city	String	Optional
address.state	String	Optional
address.landmark	String	Optional
address.locality	String	Optional

Header Parameters

• Content-Type string
  Example: application/json
• x-access-key string
  Example: 1mg_client_public_access_key
• X-Authorization string
  Example: {{X-Authorization}}

application/json

Request Body

• object

Responses

• 200

---

OK

Response Headers

• Date string
• Content-Type string
• Transfer-Encoding string
• Connection string
• vary string
• x-request-id string
• set-cookie string
• visitor-id string
• x-visitor-id string
• access-control-allow-methods string
• access-control-allow-headers string
• access-control-allow-origin string
• CF-Cache-Status string
• Server string
• CF-RAY string
• Content-Encoding string

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• object

{}

{
  "data": {
    "serviceable": true
  },
  "partial_complete": false,
  "is_success": true,
  "status_code": 200
}

Loading...