Addresses

The addresses object represents the customer's billing and/or shipping addresses and includes the physical_address sub-object. NOTE: For token payments, Forte will use the default shipping and billing addresses. Set the customers default shipping and billing addresses prior to creating a token payment.

Addresses Object

Parameter

Description

Type

Req

address_token

A unique string used to represent an address. For example, add_tq0hemmmtf-zsxgq689rew. [max length = 26]

string

R

customer_token

A unique string used to represent a customer. For example, cst_SoGUG6mcLUS1nVzYBIbk3g. [max length = 26]

string

R

organization_id

The identification number of the associated organization. For example, org_5551236.

string

R

location_id

The identification number of the associated location. For example, loc_1234568.

string

R

first_name

The first name of the user associated with this billing or shipping address [max length = 25]. NOTE: Either the first_name, last_name, or company_name parameters are required when creating addresses.

string

O

last_name

The last name of the user associated with this billing or shipping address [max length = 25]. NOTE: Either the first_name, last_name, or company_name parameters are required when creating addresses.

string

O

company_name

The name of the company associated with this billing or shipping address [max length = 20]. NOTE: Either the first_name, last_name, or company_name parameters are required when creating addresses.

string

O

phone

The phone number associated with this billing or shipping address. This field supports both U.S. and Canadian phone numbers. [max length = 15]

string

O

email

The email address associated with this billing or shipping address [max length = 50]

string

O

label

A label that succinctly identifies the address. For example, "Work" or "Home." [max length = 50]

string

O

address_type

The type of address. Use one of the following values:
default_billing - The default billing address
 

default_shipping - The default shipping address
 

none - The address is not a default address)
 

both - The address is both a default shipping and default billing address

string

O

shipping_address_type

Indicates whether the address is a residential or commercial address.

string

R

physical_address

The Physical Address Object.

object

O

physical_address.street_line1

The first line of the street address [max length = 35]

string

O

physical_address.street_line2

The second line of the street address [max length = 35]

string

O

physical_address.locality

Locality or city/town/village [max length = 25]

string

O

physical_address.region

Region or state/province. [max length = 10]

string

O

physical_address.country

The ISO 3166-1 alpha-2 country abbreviation. [max length = 2]

string

O

physical_address.postal_code

Postal Code [max length = 15].

string

O

POST Customer Address (Simple)

				
					{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses

This URI creates a new address record for the customer and returns a new address_token.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}
 
Bodyraw
				
					{
       "physical_address": {
          "street_line1": "8003 Clock Tower Ln",
          "street_line2": "Suite 200",
          "locality": "Hill Valley",
          "region": "CA",
          "country": "US",
          "postal_code": "95420"
       }
}

Example Request

				
					curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--header 'Content-Type: application/json' \
--data '{
       "physical_address": {
          "street_line1": "8003 Clock Tower Ln",
          "street_line2": "Suite 200",
          "locality": "Hill Valley",
          "region": "CA",
          "postal_code": "95420"
       }
}'

Example Response

Edit Content 
				
					{
  "address_token": "add_kVu82mnKcUumx0qoWsBZzw",
  "location_id": "loc_192642",
  "customer_token": "cst_h_TrrHANEU6XjmMV_EMVrA",
  "physical_address": {
    "street_line1": "8003 Clock Tower Ln",
    "street_line2": "Suite 200",
    "locality": "Hill Valley",
    "region": "CA",
    "country": "US",
    "postal_code": "95420"
  },
  "response": {
    "environment": "live",
    "response_desc": "Create Successful."
  },
  "links": {
    "self": "https://api.forte.net/v3/addresses/add_kVu82mnKcUumx0qoWsBZzw"
  }
}
Edit Content
Headers (13)
access-control-allow-origin
 

*

cache-control

no-cache

connection

keep-alive

content-type

application/json; charset=utf-8

date

Tue, 24 Oct 2017 18:56:12 GMT

expires

-1

pragma

no-cache

server

Microsoft-IIS/8.5

transfer-encoding

chunked

x-aspnet-version

4.0.30319

x-cdn

Incapsula

x-iinfo

1-3593717-3660544 NNNN CT(48 39 0) RT(1508870937210 435264) q(0 0 1 -1) r(2 2) U6

x-powered-by

ASP.NET

POST Customer Address (Alternate URI)

				
					{{baseURI}}/organizations/org_{{organizationID}}/customers/cst_{{customertoken}}/addresses

This URI creates a new address for the customer and returns a new address_token; however, you must include the location_id in the body of the request since this value is not included in the specified route. The Location ID identifies the location from where you are processing transactions.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}
 
Bodyraw
				
					{
       "location_id": "loc_192642"
       "physical_address": {
          "street_line1": "8003 Clock Tower Ln",
          "street_line2": "Suite 200",
          "locality": "Hill Valley",
          "region": "CA",
          "country": "US",
          "postal_code": "95420"
       }
}

Example Request

				
					curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/customers/cst_{{customertoken}}/addresses' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--header 'Content-Type: application/json' \
--data '{
       "location_id": "loc_192642",
       "physical_address": {
          "street_line1": "8003 Clock Tower Ln",
          "street_line2": "Suite 200",
          "locality": "Hill Valley",
          "region": "CA",
          "postal_code": "95420"
       }
}'

Example Response

Edit Content 
				
					{
  "address_token": "add_rFNRVpagIEaUKPOD5-bqnQ",
  "location_id": "loc_192642",
  "customer_token": "cst_h_TrrHANEU6XjmMV_EMVrA",
  "physical_address": {
    "street_line1": "8003 Clock Tower Ln",
    "street_line2": "Suite 200",
    "locality": "Hill Valley",
    "region": "CA",
    "country": "US",
    "postal_code": "95420"
  },
  "response": {
    "environment": "live",
    "response_desc": "Create Successful."
  },
  "links": {
    "self": "https://api.forte.net/v3/addresses/add_rFNRVpagIEaUKPOD5-bqnQ"
  }
}
Edit Content
Headers (13)
Cache-Control

no-cache Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds

Connection

keep-alive Options that are desired for the connection
Content-Length

656 The length of the response body in octets (8-bit bytes)

 

content-type

application/json; charset=utf-8 The mime type of this content

date

Fri, 03 Aug 2018 17:29:00 GMT The date and time that the message was sent

expires

-1 Gives the date/time after which the response is considered stale

pragma

no-cache Implementation-specific headers that may have various effects anywhere along the request-response chain.

server

A name for the server

POST Customer Address 

				
					{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses

This URI creates a new address for the customer and returns a new address_token.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}
 
Bodyraw
				
					{
       "label": "Shipping",
       "first_name": "Marty",
       "last_name": "McFly",
       "company_name": "Brown Associates",
       "phone": "444-444-4444",
       "email": "m.mcfly@brown.net",
       "physical_address":{
          "street_line1": "8003 Clock Tower Ln",
          "street_line2": "Suite 200",
          "locality": "Hill Valley",
          "region": "CA",
          "country": "US",
          "postal_code": "95420"
       }
}

Example Request

				
					curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--header 'Content-Type: application/json' \
--data-raw '{
       "label": "Shipping",
       "first_name": "Marty",
       "last_name": "McFly",
       "company_name": "Brown Associates",
       "phone": "444-444-4444",
       "email": "m.mcfly@brown.net",
       "physical_address":{
          "street_line1": "8003 Clock Tower Ln",
          "street_line2": "Suite 200",
          "locality": "Hill Valley",
          "postal_code": "95420"
       }
} '

Example Response

Edit Content 
				
					{
  "address_token": "add_KDbwcbrv-Uu6eSSn1rBl6A",
  "organization_id": "org_334316",
  "location_id": "loc_192642",
  "customer_token": "cst_h_TrrHANEU6XjmMV_EMVrA",
  "first_name": "Jennifer",
  "last_name": "Parker-McFly",
  "company_name": "Brown Associates",
  "phone": "444-444-4444",
  "email": "j.mcfly@brown.net",
  "label": "Shipping",
  "address_type": "none",
  "shipping_address_type": "commercial",
  "physical_address": {
    "street_line1": "58003 Clock Tower Ln",
    "street_line2": "Suite 101",
    "locality": "Hill Valley",
    "region": "CA",
    "country": "US",
    "postal_code": "95420"
  },
  "response": {
    "environment": "live",
    "response_desc": "Get Successful."
  },
  "links": {
    "self": "https://api.forte.net/v3/addresses/add_KDbwcbrv-Uu6eSSn1rBl6A"
  }
}
Edit Content
Headers (13)
access-control-allow-origin
 

*

cache-control

no-cache

connection

keep-alive

content-type

application/json; charset=utf-8

date

Tue, 24 Oct 2017 18:51:58 GMT

expires

-1

pragma

no-cache

server

Microsoft-IIS/8.5

transfer-encoding

chunked

x-aspnet-version

4.0.30319

x-cdn

Incapsula

x-iinfo

1-3593717-3621569 NNNN CT(38 36 0) RT(1508870937210 180887) q(0 0 1 -1) r(2 2) U6

x-powered-by

ASP.NET

Get Address by ID

				
					{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/addresses/add_{{addresstoken}}

This URI returns detailed address data using the address_token.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}

Example Request

				
					curl --location -g 'https://api.forte.net/v3/organizations/org_{{organization}}/locations/loc_{{location}}/addresses/add_{{addresstoken}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'

Example Response

Edit Content 
				
					{
  "number_results": 2,
  "search_criteria": {
    "page_size": 50,
    "page_index": 0,
    "home_organization_id": "org_334316",
    "resource_specific": {
      "location_id": "loc_192642",
      "customer_token": "cst_h_TrrHANEU6XjmMV_EMVrA"
    }
  },
  "results": [
    {
      "address_token": "add_Qk4ZwL2QrUKf72LxHa2ZOQ",
      "organization_id": "org_334316",
      "location_id": "loc_192642",
      "customer_token": "cst_h_TrrHANEU6XjmMV_EMVrA",
      "first_name": "Marty",
      "last_name": "McFly",
      "company_name": "Brown and Associates",
      "address_type": "",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "8003 Clock Tower Ln",
        "street_line2": "Suite 200",
        "locality": "Hill Valley",
        "region": "CA",
        "country": "US",
        "postal_code": "95420"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_Qk4ZwL2QrUKf72LxHa2ZOQ"
      }
    },
    {
      "address_token": "add_0KGuO6nwZUeD8HepNxlJEg",
      "organization_id": "org_334316",
      "location_id": "loc_192642",
      "customer_token": "cst_h_TrrHANEU6XjmMV_EMVrA",
      "first_name": "Marty",
      "last_name": "McFly",
      "company_name": "Brown Associates",
      "phone": "444-444-4444",
      "email": "m.mcfly@brown.net",
      "label": "Shipping",
      "address_type": "none",
      "shipping_address_type": "commercial",
      "physical_address": {
        "street_line1": "8003 Clock Tower Ln",
        "street_line2": "Suite 200",
        "locality": "Hill Valley",
        "region": "CA",
        "country": "US",
        "postal_code": "95420"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_0KGuO6nwZUeD8HepNxlJEg"
      }
    }
  ],
  "response": {
    "environment": "live",
    "response_desc": "Get Successful."
  },
  "links": {
    "self": "https://api.forte.net/v3/addresses/",
    "next": "https://api.forte.net/v3/addresses/?page_index=1"
  }
}
Edit Content
Headers (13)
Cache-Control

no-cache Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds

Connection

keep-alive Options that are desired for the connection
Content-Length

656 The length of the response body in octets (8-bit bytes)

 

content-type

application/json; charset=utf-8 The mime type of this content

date

Fri, 03 Aug 2018 17:29:00 GMT The date and time that the message was sent

expires

-1 Gives the date/time after which the response is considered stale

pragma

no-cache Implementation-specific headers that may have various effects anywhere along the request-response chain.

server

A name for the server

Get Customer's Address(es)

				
					{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses/

This URI returns all address(es) associated with a customer based on the customer_token.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}

Example Request

				
					curl --location -g 'https://api.forte.net/v3/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses/' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'

Example Response

Edit Content 
				
					{
  "number_results": 7,
  "search_criteria": {
    "page_size": 50,
    "page_index": 0,
    "home_organization_id": "org_300005",
    "resource_specific": {
      "location_id": "loc_115161"
    }
  },
  "results": [
    {
      "address_token": "add_28067617",
      "organization_id": "org_300005",
      "location_id": "loc_115161",
      "customer_token": "cst_26557171",
      "first_name": "Marty",
      "last_name": "McFly",
      "label": "Default - Shipping",
      "address_type": "default_shipping",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "123 Fake Street",
        "street_line2": "Suite 500",
        "locality": "Plano",
        "region": "TX",
        "country": "US",
        "postal_code": "75555"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_28067617"
      }
    },
    {
      "address_token": "add_28067618",
      "organization_id": "org_300005",
      "location_id": "loc_115161",
      "customer_token": "cst_26557172",
      "first_name": "Jennifer",
      "last_name": "McFly",
      "phone": "444-444-4444",
      "email": "j.mcfly@brownenterprises",
      "label": "Default - Billing",
      "address_type": "default_billing",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "500 W Bethany DR",
        "street_line2": "Suite 200",
        "locality": "Allen",
        "region": "TX",
        "country": "US",
        "postal_code": "75033"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_28067618"
      }
    },
    {
      "address_token": "add_28067619",
      "organization_id": "org_300005",
      "location_id": "loc_115161",
      "customer_token": "cst_26557172",
      "first_name": "Emmett",
      "last_name": "Brown",
      "label": "Default - Shipping",
      "address_type": "default_shipping",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "550 E Bethany Dr",
        "street_line2": "Suite 500",
        "locality": "Plano",
        "region": "TX",
        "country": "US",
        "postal_code": "75555"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_28067619"
      }
    },
    {
      "address_token": "add_28067620",
      "organization_id": "org_300005",
      "location_id": "loc_115161",
      "customer_token": "cst_26557173",
      "first_name": "Griff",
      "last_name": "Tannen",
      "phone": "444-444-4444",
      "email": "TestUd@achdirect.com",
      "label": "Default - Billing",
      "address_type": "default_billing",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "500 W Bethany DR",
        "street_line2": "Suite 200",
        "locality": "Allen",
        "region": "TX",
        "country": "US",
        "postal_code": "75033"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_28067620"
      }
    },
    {
      "address_token": "add_28067621",
      "organization_id": "org_300005",
      "location_id": "loc_115161",
      "customer_token": "cst_26557173",
      "first_name": "Biff",
      "last_name": "Tannen",
      "label": "Default - Shipping",
      "address_type": "default_shipping",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "123 Fake Street",
        "street_line2": "Suite 500",
        "locality": "Allen",
        "region": "TX",
        "country": "US",
        "postal_code": "75555"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_28067621"
      }
    },
    {
      "address_token": "add_28067622",
      "organization_id": "org_300005",
      "location_id": "loc_115161",
      "customer_token": "cst_26557174",
      "first_name": "Martin",
      "last_name": "McFly",
      "phone": "444-444-4444",
      "email": "TestUd@achdirect.com",
      "label": "Default - Billing",
      "address_type": "default_billing",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "500 W Bethany DR",
        "street_line2": "Suite 200",
        "locality": "Allen",
        "region": "TX",
        "country": "US",
        "postal_code": "75033"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_28067622"
      }
    },
    {
      "address_token": "add_28067623",
      "organization_id": "org_300005",
      "location_id": "loc_115161",
      "customer_token": "cst_26557174",
      "first_name": "Shipping",
      "last_name": "NameUd",
      "label": "Default - Shipping",
      "address_type": "default_shipping",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "550 E Bethany DrUd",
        "street_line2": "Suite 500Ud",
        "locality": "PlanoUd",
        "region": "TX",
        "country": "US",
        "postal_code": "75555"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_28067623"
      }
    }
  ],
  "response": {
    "environment": "live",
    "response_desc": "Get Successful."
  },
  "links": {
    "self": "https://api.forte.net/v3/addresses/",
    "next": "https://api.forte.net/v3/addresses/?page_index=1"
  }
}
Edit Content
Headers (13)
Cache-Control

no-cache Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds

Connection

keep-alive Options that are desired for the connection
Content-Length

1534 The length of the response body in octets (8-bit bytes)

 

content-type

application/json; charset=utf-8 The mime type of this content

date

Fri, 03 Aug 2018 17:24:19 GMT The date and time that the message was sent

expires

-1 Gives the date/time after which the response is considered stale

pragma

no-cache Implementation-specific headers that may have various effects anywhere along the request-response chain.

server

A name for the server

Get All Addresses for a Location

				
					{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/addresses/

This URI returns all addresses owned by a location. Remember, a location is a processing endpoints that merchant organizations use to initiate transactions. To narrow your search data, use the customer_token parameter to filter your results.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}

Example Request

				
					curl --location -g 'https://api.forte.net/v3/organizations/org_{{organization}}/locations/loc_{{location}}/addresses/' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'

Example Response

Edit Content 
				
					{
  "number_results": 7,
  "search_criteria": {
    "page_size": 50,
    "page_index": 0,
    "home_organization_id": "org_300005",
    "resource_specific": {
      "location_id": "loc_115161"
    }
  },
  "results": [
    {
      "address_token": "add_28067617",
      "organization_id": "org_300005",
      "location_id": "loc_115161",
      "customer_token": "cst_26557171",
      "first_name": "Marty",
      "last_name": "McFly",
      "label": "Default - Shipping",
      "address_type": "default_shipping",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "123 Fake Street",
        "street_line2": "Suite 500",
        "locality": "Plano",
        "region": "TX",
        "country": "US",
        "postal_code": "75555"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_28067617"
      }
    },
    {
      "address_token": "add_28067618",
      "organization_id": "org_300005",
      "location_id": "loc_115161",
      "customer_token": "cst_26557172",
      "first_name": "Jennifer",
      "last_name": "McFly",
      "phone": "444-444-4444",
      "email": "j.mcfly@brownenterprises",
      "label": "Default - Billing",
      "address_type": "default_billing",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "500 W Bethany DR",
        "street_line2": "Suite 200",
        "locality": "Allen",
        "region": "TX",
        "country": "US",
        "postal_code": "75033"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_28067618"
      }
    },
    {
      "address_token": "add_28067619",
      "organization_id": "org_300005",
      "location_id": "loc_115161",
      "customer_token": "cst_26557172",
      "first_name": "Emmett",
      "last_name": "Brown",
      "label": "Default - Shipping",
      "address_type": "default_shipping",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "550 E Bethany Dr",
        "street_line2": "Suite 500",
        "locality": "Plano",
        "region": "TX",
        "country": "US",
        "postal_code": "75555"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_28067619"
      }
    },
    {
      "address_token": "add_28067620",
      "organization_id": "org_300005",
      "location_id": "loc_115161",
      "customer_token": "cst_26557173",
      "first_name": "Griff",
      "last_name": "Tannen",
      "phone": "444-444-4444",
      "email": "TestUd@achdirect.com",
      "label": "Default - Billing",
      "address_type": "default_billing",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "500 W Bethany DR",
        "street_line2": "Suite 200",
        "locality": "Allen",
        "region": "TX",
        "country": "US",
        "postal_code": "75033"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_28067620"
      }
    },
    {
      "address_token": "add_28067621",
      "organization_id": "org_300005",
      "location_id": "loc_115161",
      "customer_token": "cst_26557173",
      "first_name": "Biff",
      "last_name": "Tannen",
      "label": "Default - Shipping",
      "address_type": "default_shipping",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "123 Fake Street",
        "street_line2": "Suite 500",
        "locality": "Allen",
        "region": "TX",
        "country": "US",
        "postal_code": "75555"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_28067621"
      }
    },
    {
      "address_token": "add_28067622",
      "organization_id": "org_300005",
      "location_id": "loc_115161",
      "customer_token": "cst_26557174",
      "first_name": "Martin",
      "last_name": "McFly",
      "phone": "444-444-4444",
      "email": "TestUd@achdirect.com",
      "label": "Default - Billing",
      "address_type": "default_billing",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "500 W Bethany DR",
        "street_line2": "Suite 200",
        "locality": "Allen",
        "region": "TX",
        "country": "US",
        "postal_code": "75033"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_28067622"
      }
    },
    {
      "address_token": "add_28067623",
      "organization_id": "org_300005",
      "location_id": "loc_115161",
      "customer_token": "cst_26557174",
      "first_name": "Shipping",
      "last_name": "NameUd",
      "label": "Default - Shipping",
      "address_type": "default_shipping",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "550 E Bethany DrUd",
        "street_line2": "Suite 500Ud",
        "locality": "PlanoUd",
        "region": "TX",
        "country": "US",
        "postal_code": "75555"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_28067623"
      }
    }
  ],
  "response": {
    "environment": "live",
    "response_desc": "Get Successful."
  },
  "links": {
    "self": "https://api.forte.net/v3/addresses/",
    "next": "https://api.forte.net/v3/addresses/?page_index=1"
  }
}
Edit Content
Headers (13)
Cache-Control

no-cache Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds

Connection

keep-alive Options that are desired for the connection
Content-Length

25296 The length of the response body in octets (8-bit bytes)

 

content-type

application/json; charset=utf-8 The mime type of this content

date

Fri, 03 Aug 2018 17:13:46 GMT The date and time that the message was sent

expires

-1 Gives the date/time after which the response is considered stale

pragma

no-cache Implementation-specific headers that may have various effects anywhere along the request-response chain.

server

A name for the server

Get All Addresses for an Organization

				
					{{baseURI}}/organizations/org_{{organizationID}}/addresses/

This URI returns all address(es) owned by an Organization. To narrow your search data using specific criteria, use the following parameters to filter your results:

  • location_id

  • customer_token

Note: Please note that sending a request at the partner (org) level may result in a large data set and may cause timeout errors depending on the request. We recommend sending your GET request at the Merchant (Organization) level.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}}

Example Request

				
					curl --location -g 'https://api.forte.net/v3/organizations/org_{{organization}}/addresses' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}'

Example Response

Edit Content 
				
					{
  "number_results": 5,
  "search_criteria": {
    "page_size": 50,
    "page_index": 0,
    "home_organization_id": "org_334316",
    "resource_specific": {}
  },
  "results": [
    {
      "address_token": "add_cagThS8ehE61jwEpVSJJ1w",
      "organization_id": "org_334316",
      "location_id": "loc_192642",
      "customer_token": "cst_E5v1yG3AdkiVIe6TWKuxgQ",
      "first_name": "test",
      "last_name": "test",
      "label": "Default - Billing",
      "address_type": "default_billing",
      "shipping_address_type": "residential",
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_cagThS8ehE61jwEpVSJJ1w"
      }
    },
    {
      "address_token": "add_ipLhxWZzkU2p4dfDG_I0RA",
      "organization_id": "org_334316",
      "location_id": "loc_192642",
      "customer_token": "cst_ySC0CBRmWU64c_5fceYosg",
      "first_name": "test",
      "last_name": "test",
      "label": "Default - Billing",
      "address_type": "default_billing",
      "shipping_address_type": "residential",
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_ipLhxWZzkU2p4dfDG_I0RA"
      }
    },
    {
      "address_token": "add_g7gnKpd9aEGuN3s6qB8Tgg",
      "organization_id": "org_334316",
      "location_id": "loc_192642",
      "customer_token": "cst_NmI9Wlc3aUa9yYoLsBtbTw",
      "first_name": "Emmett",
      "last_name": "Brown",
      "company_name": "Brown Associates",
      "phone": "444-444-4444",
      "email": "e.brown@brown.net",
      "label": "Brown Shipping",
      "address_type": "default_shipping",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "123 Hill Valley Rd.",
        "street_line2": "APT 1001",
        "locality": "Hill Valley",
        "region": "CA",
        "country": "US",
        "postal_code": "95420"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_g7gnKpd9aEGuN3s6qB8Tgg"
      }
    },
    {
      "address_token": "add_0YP3dXBvEUupRmN8oBqzIg",
      "organization_id": "org_334316",
      "location_id": "loc_192642",
      "customer_token": "cst_N5I5RGuPu0u6IjZLw0Re5Q",
      "first_name": "Jennifer",
      "last_name": "McFly",
      "company_name": "McFly's McCreations",
      "phone": "444-444-4444",
      "email": "e.brown@brown.net",
      "label": "Brown Shipping",
      "address_type": "default_shipping",
      "shipping_address_type": "residential",
      "physical_address": {
        "street_line1": "123 Hill Valley Rd.",
        "street_line2": "APT 1001",
        "locality": "Hill Valley",
        "region": "CA",
        "country": "US",
        "postal_code": "95420"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_0YP3dXBvEUupRmN8oBqzIg"
      }
    },
    {
      "address_token": "add_6jpyQMMQ9UysAu7Gkh0JmA",
      "organization_id": "org_334316",
      "location_id": "loc_192642",
      "customer_token": "cst_h_TrrHANEU6XjmMV_EMVrA",
      "first_name": "Marty",
      "last_name": "McFly",
      "company_name": "Brown Associates",
      "phone": "444-444-4444",
      "email": "m.mcfly@brown.net",
      "label": "Shipping",
      "address_type": "none",
      "shipping_address_type": "commercial",
      "physical_address": {
        "street_line1": "8003 Clock Tower Ln",
        "street_line2": "Suite 200",
        "locality": "Hill Valley",
        "region": "CA",
        "country": "US",
        "postal_code": "95420"
      },
      "links": {
        "self": "https://api.forte.net/v3/addresses/add_6jpyQMMQ9UysAu7Gkh0JmA"
      }
    }
  ],
  "response": {
    "environment": "live",
    "response_desc": "Get Successful."
  },
  "links": {
    "self": "https://api.forte.net/v3/addresses/",
    "next": "https://api.forte.net/v3/addresses/?page_index=1"
  }
}
Edit Content
Headers (13)
Cache-Control

no-cache Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds

Connection

keep-alive Options that are desired for the connection
Content-Length

26049 The length of the response body in octets (8-bit bytes)

 

content-type

application/json; charset=utf-8 The mime type of this content

date

Fri, 03 Aug 2018 17:32:32 GMT The date and time that the message was sent

expires

-1 Gives the date/time after which the response is considered stale

pragma

no-cache Implementation-specific headers that may have various effects anywhere along the request-response chain.

server

A name for the server

PUT Update an Address (Simple)

				
					{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses/add_{{addresstoken}}

This URI updates the specified address record.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}
 
Bodyraw
				
					{
       "physical_address": {
          "street_line1": "8003 Clock Tower Ln",
          "street_line2": "Suite 101",
          "locality": "Hill Valley",
          "region": "CA",
          "country": "US"
       }
}

Example Request

				
					curl --location -g --request PUT 'https://api.forte.net/v3/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses/add_{{addresstoken}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--header 'Content-Type: application/json' \
--data '{
       "physical_address": {
          "street_line1": "8003 Clock Tower Ln",
          "street_line2": "Suite 101",
          "locality": "Hill Valley",
          "region": "CA",
          "country": "US"
       }
}'

Example Response

Edit Content 
				
					{
  "address_token": "add_KDbwcbrv-Uu6eSSn1rBl6A",
  "location_id": "loc_192642",
  "customer_token": "cst_h_TrrHANEU6XjmMV_EMVrA",
  "physical_address": {
    "street_line1": "8003 Clock Tower Ln",
    "street_line2": "Suite 101",
    "locality": "Hill Valley",
    "region": "CA",
    "country": "US"
  },
  "response": {
    "environment": "live",
    "response_desc": "Update Successful."
  },
  "links": {
    "self": "https://api.forte.net/v3/addresses/add_KDbwcbrv-Uu6eSSn1rBl6A"
  }
}
Edit Content
Headers (13)
access-control-allow-origin
 

*

cache-control

no-cache

connection

keep-alive

content-type

application/json; charset=utf-8

date

Tue, 24 Oct 2017 18:53:55 GMT

expires

-1

pragma

no-cache

server

Microsoft-IIS/8.5

transfer-encoding

chunked

x-aspnet-version

4.0.30319

x-cdn

Incapsula

x-iinfo

1-3593717-3660544 NNNN CT(48 39 0) RT(1508870937210 435264) q(0 0 1 -1) r(2 2) U6

x-powered-by

ASP.NET

PUT Update an Address

				
					{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses/add_{{addresstoken}}

This URI updates the specified address record.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}
 
Bodyraw
				
					{
       "label": "Shipping",
       "first_name": "Jennifer",
       "last_name": "Parker-McFly",
       "company_name": "Brown Associates",
       "phone": "444-444-4444",
       "email": "j.mcfly@brown.net",
       "shipping_address_type": "commercial",
       "address_type": "none",
       "physical_address": {
          "street_line1": "58003 Clock Tower Ln",
          "street_line2": "Suite 101",
          "locality": "Hill Valley",
          "region": "CA",
          "postal_code": "95420",
          "country": "US"
       }
}

Example Request

				
					curl --location -g --request PUT 'https://api.forte.net/v3/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/customers/cst_{{customertoken}}/addresses/add_{{addresstoken}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--header 'Content-Type: application/json' \
--data-raw '{
       "label": "Shipping",
       "first_name": "Jennifer",
       "last_name": "Parker-McFly",
       "company_name": "Brown Associates",
       "phone": "444-444-4444",
       "email": "j.mcfly@brown.net",
       "shipping_address_type": "commercial",
       "address_type": "none",
       "physical_address": {
          "street_line1": "58003 Clock Tower Ln",
          "street_line2": "Suite 101",
          "locality": "Hill Valley",
          "region": "CA",
          "postal_code": "95420",
          "country": "US"
       }
}'

Example Response

Edit Content 
				
					{
  "address_token": "add_KDbwcbrv-Uu6eSSn1rBl6A",
  "location_id": "loc_192642",
  "customer_token": "cst_h_TrrHANEU6XjmMV_EMVrA",
  "first_name": "Jennifer",
  "last_name": "Parker-McFly",
  "company_name": "Brown Associates",
  "phone": "444-444-4444",
  "email": "j.mcfly@brown.net",
  "label": "Shipping",
  "address_type": "none",
  "shipping_address_type": "commercial",
  "physical_address": {
    "street_line1": "58003 Clock Tower Ln",
    "street_line2": "Suite 101",
    "locality": "Hill Valley",
    "region": "CA",
    "postal_code": "95420",
    "country": "US"
  },
  "response": {
    "environment": "live",
    "response_desc": "Update Successful."
  },
  "links": {
    "self": "https://api.forte.net/v3/addresses/add_KDbwcbrv-Uu6eSSn1rBl6A"
  }
}
Edit Content
Headers (13)
access-control-allow-origin
 

*

cache-control

no-cache

connection

keep-alive

content-lenght

643

content-type

application/json; charset=utf-8

date

Tue, 24 Oct 2017 18:55:02 GMT

expires

-1

pragma

no-cache

server

Microsoft-IIS/8.5

transfer-encoding

chunked

x-aspnet-version

4.0.30319

x-cdn

Incapsula

x-iinfo

1-3593717-3649861 NNNN CT(31 32 0) RT(1508870937210 365361) q(0 0 1 -1) r(2 2) U6

x-powered-by

ASP.NET

DELETE Address

				
					{{baseURI}}/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/addresses/add_{{addresstoken}}

Deletes the address associated with the specified address_token.

AUTHORIZATION Basic Auth
 
Username     {{apiaccessid}}
Password      {{apisecurekey}

Example Request

				
					curl --location -g --request DELETE 'https://api.forte.net/v3/organizations/org_{{organizationID}}/locations/loc_{{locationID}}/addresses/add_{{addresstoken}}' \
--header 'Authorization: {{Authorization}}' \
--header 'Accept: application/json' \
--header 'X-Forte-Auth-Organization-Id: org_{{AuthOrganizationID}}' \
--data ''

Example Response

Edit Content 
				
					{
  "customer_token": "cst_D7AwlaDpL0OwwVJM9sTtDA",
  "location_id": "loc_192642",
  "first_name": "Emmett",
  "last_name": "Brown",
  "company_name": "Brown Associates",
  "display_name": "Brown Associates",
  "customer_id": "025897",
  "response": {
    "environment": "live",
    "response_desc": "Create Successful."
  },
  "links": {
    "addresses": "https://api.forte.net/v3/customers/cst_D7AwlaDpL0OwwVJM9sTtDA/addresses",
    "paymethods": "https://api.forte.net/v3/customers/cst_D7AwlaDpL0OwwVJM9sTtDA/paymethods",
    "transactions": "https://api.forte.net/v3/customers/cst_D7AwlaDpL0OwwVJM9sTtDA/transactions",
    "settlements": "https://api.forte.net/v3/customers/cst_D7AwlaDpL0OwwVJM9sTtDA/settlements",
    "schedules": "https://api.forte.net/v3/customers/cst_D7AwlaDpL0OwwVJM9sTtDA/schedules",
    "self": "https://api.forte.net/v3/customers/cst_D7AwlaDpL0OwwVJM9sTtDA"
  }
}
Edit Content
Headers (13)
access-control-allow-origin
 

*

cache-control

no-cache

connection

keep-alive

content-lenght

146

content-type

application/json; charset=utf-8

date

Tue, 05 Dec 2017 21:36:46 GMT

expires

-1

pragma

no-cache

server

Microsoft-IIS/8.5

transfer-encoding

chunked

x-aspnet-version

4.0.30319

x-cdn

Incapsula

x-iinfo

9-276075117-276104900 SNNN RT(1512509652758 153606) q(0 0 0 -1) r(2 2) U6

x-powered-by

ASP.NET
On this page