geocodeAddressString

geocodeAddressString

Path Parameters

department_uuid string required

department_uuid

user_uuid string required

user_uuid

Header Parameters

authorization string required

authorization

application/json

Request Body required

geocodeRequest

address string
dealerDepartmentUUIDList string[]
lat string
lng string
requesterUserUUID string
source string

Possible values: [DEALER_APP, WEB, PND_API, EXTERNAL_CONTROLLER]

Responses

• 200
• 201
• 401
• 403
• 404

---

OK

*/*

Schema

Example (from schema)

---

Schema

results object[]
Array [
address_components object[]
Array [
long_name string
short_name string
types string[]
]
formatted_address string
geometry object
location object
address string
latitudeDouble double
longitude double
location_type string
viewport object
northeast object
lat double
lng double
southwest object
lat double
lng double
place_id string
types string[]
]
status string

{
  "results": [
    {
      "address_components": [
        {
          "long_name": "string",
          "short_name": "string",
          "types": [
            "string"
          ]
        }
      ],
      "formatted_address": "string",
      "geometry": {
        "location": {
          "address": "string",
          "latitudeDouble": 0,
          "longitude": 0
        },
        "location_type": "string",
        "viewport": {
          "northeast": {
            "lat": 0,
            "lng": 0
          },
          "southwest": {
            "lat": 0,
            "lng": 0
          }
        }
      },
      "place_id": "string",
      "types": [
        "string"
      ]
    }
  ],
  "status": "string"
}

Created

Unauthorized

Forbidden

Not Found

POST /v3/department/:department_uuid/user/:user_uuid/geocode/address

Request

Base URL

//api.mykaarma.com/pickupdelivery

department_uuid — path required

user_uuid — path required

authorization — header required

Body required

{
  "address": "string",
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "lat": "string",
  "lng": "string",
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}

curl / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:department_uuid/user/:user_uuid/geocode/address' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "address": "string",
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "lat": "string",
  "lng": "string",
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

python / requests

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:department_uuid/user/:user_uuid/geocode/address' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "address": "string",
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "lat": "string",
  "lng": "string",
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

go / native

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:department_uuid/user/:user_uuid/geocode/address' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "address": "string",
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "lat": "string",
  "lng": "string",
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:department_uuid/user/:user_uuid/geocode/address' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "address": "string",
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "lat": "string",
  "lng": "string",
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:department_uuid/user/:user_uuid/geocode/address' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "address": "string",
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "lat": "string",
  "lng": "string",
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:department_uuid/user/:user_uuid/geocode/address' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "address": "string",
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "lat": "string",
  "lng": "string",
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

php / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:department_uuid/user/:user_uuid/geocode/address' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "address": "string",
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "lat": "string",
  "lng": "string",
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:department_uuid/user/:user_uuid/geocode/address' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "address": "string",
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "lat": "string",
  "lng": "string",
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:department_uuid/user/:user_uuid/geocode/address' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "address": "string",
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "lat": "string",
  "lng": "string",
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'