api Web Service Documentation

Web Service Documentation

Service: api

Method: customer_address_list

Retrieves billing and shipping addresses for a specific customer.

You must be logged in to use this method.
Basic Authentication is supported.

Parameters

Group: request

localcustomerid

(string[60])

customerid

(string[60])

This parameter is Optional

Possible Return Data

List: ErrorQueue

ErrorNumber

(long integer)

ErrorPosition

(string[255])

ErrorRecordId

(string[255])

ErrorDescription

(string[255])

ErrorRecommendation

(string[255])

Group: result

status

(string[5000])

localcustomerid

(string[60])

customerid

(long integer)

Group: billing

localaddressid

(long integer)

addressid

(long integer)

company

(string[60])

contact

(string[60])

type

(string[60])

defaultaddress

(string[5])

address1

(string[35])

address2

(string[35])

address3

(string[35])

city

(string[30])

region

(string[30])

postcode

(string[10])

countrycode

(string[10])

(string[160])

phone

(string[20])

taxgroupid

(long integer)

List: shipping

localaddressid

(long integer)

addressid

(long integer)

company

(string[60])

contact

(string[60])

type

(string[60])

defaultaddress

(string[5])

address1

(string[35])

address2

(string[35])

address3

(string[35])

city

(string[30])

region

(string[30])

postcode

(string[10])

countrycode

(string[10])

(string[160])

phone

(string[20])

taxgroupid

(long integer)

JSON POST (JSON Response)

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

Example Request

POST /customer_address_list HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Content-Type: application/json
Content-Length: length

{
  "request" : {
    "localcustomerid" : "value",
    "customerid" : "value"
  }
}

Example Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

{
  "customer_address_list_response" : {
    "result" : {
      "status" : "value",
      "localcustomerid" : "value",
      "customerid" : value
    },
    "billing" : {
      "localaddressid" : "value",
      "addressid" : "value",
      "company" : "value",
      "contact" : "value",
      "type" : "value",
      "defaultaddress" : "value",
      "address1" : "value",
      "address2" : "value",
      "address3" : "value",
      "city" : "value",
      "region" : "value",
      "postcode" : "value",
      "countrycode" : "value",
      "email" : "value",
      "phone" : "value",
      "taxgroupid" : "value"
    },
    "shipping" : [
      {
        "localaddressid" : "value",
        "addressid" : "value",
        "company" : "value",
        "contact" : "value",
        "type" : "value",
        "defaultaddress" : "value",
        "address1" : "value",
        "address2" : "value",
        "address3" : "value",
        "city" : "value",
        "region" : "value",
        "postcode" : "value",
        "countrycode" : "value",
        "email" : "value",
        "phone" : "value",
        "taxgroupid" : "value"
      }
    ]
  }
}

Example Code - JavaScript

function customer_address_list_jsonpost(host,jsondata,username,password,result){
  fetch(host + "/customer_address_list", {
    method: "POST",
    credentials: "include",
    headers: {
      "Authorization": "Basic " + btoa(username + ":" + password),
      "Content-Type": "application/json",
      "Accept": "application/json;",
    },
    body: jsondata
  }).then(function(response){ // get the text out of the reply
    return response.text()
  }).then( function(text){
    // do something with the text reply
    textToTextarea(text,result)  })
}
var host = "https://localhost:2293"

Example Code - CURL

CURL --user Username:Password --header "Content-Type: application/json" --header "Accept: application/json" --data-binary @jsonDataFile.json https://localhost:2293/customer_address_list

Example Code - Clarion with NetTalk

net NetWebClient

  net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
  net.ContentType = 'application/json'
  net.SetAccept('application/json')
  net.Post('https://localhost:2293/customer_address_list',jsonData)

Try It - Live

User Name

Password

jsondata

result

HTTP GET (JSON Response)

The following is a sample JSON GET request and response. The placeholders shown need to be replaced with actual values.

Example Request

GET /customer_address_list?request-localcustomerid=value&request-customerid=value HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json

Example Response

Example Code - JavaScript

function customer_address_list_getjson(host,urldata,username,password,result){
  fetch(host + "/customer_address_list" +"?" + urldata, {
    credentials: "include",
    headers: {
      "Authorization": "Basic " + btoa(username + ":" + password),
      "Accept": "application/json;",
    }
  }).then(function(response){ // get the text out of the reply
    return response.text()
  }).then( function(text){
    // do something with the text reply
  })
}
var host = "https://localhost:2293"

Example Code - CURL

CURL --user Username:Password --header "Accept: application/json" --get --data "request-localcustomerid=value&request-customerid=value" https://localhost:2293/customer_address_list

Example Code - Clarion with NetTalk

net NetWebClient

  net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
  net.SetAccept('application/json')
  net.Get('https://localhost:2293/customer_address_list?request-localcustomerid=value&request-customerid=value')

Try It - Live

User Name

Password

request-localcustomerid

request-customerid

result

REST GET (JSON Response)

The following is a sample REST request and response. The placeholders shown need to be replaced with actual values.

Example Request

GET /api/customer_address_list? HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json

Example Response

Example Code - JavaScript

function customer_address_list_restjson(host,id,username,password,result){
  fetch(host + "/api/customer_address_list/" + id, {
    credentials: "include",
    headers: {
      "Authorization": "Basic " + btoa(username + ":" + password),
      "Accept": "application/json;",
    }
  }).then(function(response){ // get the text out of the reply
    return response.text()
  }).then( function(text){
    // do something with the text reply
  })
}
var host = "https://localhost:2293"

Example Code - CURL

CURL --user Username:Password --header "Accept: application/json" https://localhost:2293/api/customer_address_list/5

Example Code - Clarion with NetTalk

Try It - Live

User Name

Password

result

POSitive Anywhere