Skip to content

AddressApi.md

Latest commit

 

History

History
160 lines (114 loc) · 5.96 KB

AddressApi.md

File metadata and controls

160 lines (114 loc) · 5.96 KB

AddressApi

All URIs are relative to https://api-sandbox.sendpro360.pitneybowes.com/shipping

Method HTTP request Description
addressSuggest POST /api/v1/address/suggest Address Suggest
addressValidate POST /api/v1/address/verify Address Validate

addressSuggest

AddressSuggestResponse addressSuggest(addressSuggestRequest)

Address Suggest

This operation displays a valid address to match the entered address, only if the address does not seem valid to the system address map. User can select the suggested address or edit the entered address to make it valid.

Example

// Import classes:
import com.pitneybowes.api360.ApiClient;
import com.pitneybowes.api360.ApiException;
import com.pitneybowes.api360.Configuration;
import com.pitneybowes.api360.auth.*;
import com.pitneybowes.api360.models.*;
import com.pitneybowes.api360.api.AddressApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api-sandbox.sendpro360.pitneybowes.com/shipping");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AddressApi apiInstance = new AddressApi(defaultClient);
        AddressSuggestRequest addressSuggestRequest = new AddressSuggestRequest(); // AddressSuggestRequest | 
        try {
            AddressSuggestResponse result = apiInstance.addressSuggest(addressSuggestRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#addressSuggest");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
addressSuggestRequest AddressSuggestRequest

Return type

AddressSuggestResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The address is suggested to use. -
400 Invalid request. -
401 The request could not be authorized. -
500 The request could not be completed due to an internal error. -

addressValidate

AddressValidateResponse addressValidate(addressValidateRequest, minimalAddressValidation)

Address Validate

This operation validates address. This improves postal addresses within the country (e.g., United States) to help ensure that parcels are rated accurately and shipments arrive at the final destination on time.<br> The verify address operation sends an address to be verified. The response indicates whether the address is valid.

Example

// Import classes:
import com.pitneybowes.api360.ApiClient;
import com.pitneybowes.api360.ApiException;
import com.pitneybowes.api360.Configuration;
import com.pitneybowes.api360.auth.*;
import com.pitneybowes.api360.models.*;
import com.pitneybowes.api360.api.AddressApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api-sandbox.sendpro360.pitneybowes.com/shipping");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AddressApi apiInstance = new AddressApi(defaultClient);
        AddressValidateRequest addressValidateRequest = new AddressValidateRequest(); // AddressValidateRequest | 
        Boolean minimalAddressValidation = true; // Boolean | If true, then only City, State, and PostalCode (zip) are validated. This option is specific for US domestic addresses only.
        try {
            AddressValidateResponse result = apiInstance.addressValidate(addressValidateRequest, minimalAddressValidation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AddressApi#addressValidate");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
addressValidateRequest AddressValidateRequest
minimalAddressValidation Boolean If true, then only City, State, and PostalCode (zip) are validated. This option is specific for US domestic addresses only. [optional]

Return type

AddressValidateResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The address has been verified. -
400 Invalid request. -
401 The request could not be authorized. -
500 The request could not be completed due to an internal error. -