Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R12.3.0

Excerpt

This method is used to verify if a specific address is covered and can be used in order to deliver services or physical goods. Only one address can be verified through each call

...

Name

Type

Description

token

String

The token retrieved from the login method

area

(semi-optional)

String

The area of the address

district

(semi-optional)

String

The district of the address

town_city

(semi-optional)

String

The town / city of the address

postal_code

(semi-optional)

String

The postal code of the address

job_type_identifier

(mandatory)

Job Type Identifier

The identifier of the job type that will be used to deliver the services or physical goods on the specified address. The allowed job type identifier fields are the following:

Include Page
V4:job_type_identifier
V4:job_type_identifier

fields_set
(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "token":"{{token}}",
  "area":"Strovolos",
  "town_city":"Nicosia",
  "postal_code":"2035",
  "job_type_identifier":{"name":"Bill based on delivered items"}
}

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "data": {
        "verified": "true"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}
Expand
titleExample 2

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
  "token":"{{token}}",
  "town_city":"Nicosia",
  "postal_code":"4035",
  "job_type_identifier":{"name":"Bill based on delivered items"}
}

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "data": {
        "verified": "false"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}