UPS Capital Insurance Coverage API

API change history

This is the insurance coverage API for UPS Capital. It allows for customers to get quotes, purchase coverage and confirm shipment.

Create Quote

Create a new quote for insurance using shipment information. This method creates a quote in the system for insurance coverage

Try it

Request

Request URL

https://upscapital-api-portal.azure-api.net/coverage/quote/v1

Request headers

bearer

string

Authorization token provided for the partnerId
X-IBM-Client-ID

string

API Client Id
Content-Type (optional)

string

Media type of the body sent to the API.

Request body

Quote object needs to be sent to the API as a request payload

application/json

{
  "productId": 1,
  "locationId": 6565648056,
  "transactionID": 10031,
  "partnerId": "XXX001",
  "upscCustomerID": "XXX",
  "quoteShipmentInfo": {
    "shipmentType": 3,
    "shipperId": "W673366199002",
    "shipperName": "W1234SHIPPER",
    "carrier": "RLCA",
    "shipDate": "2019-06-06T00:00:00.0000000+00:00",
    "bol": 86603073,
    "insuredValue": 5000,
    "commodityCodeType": "UPSC",
    "commodityCode": 400,
    "oversize": "Y",
    "usedGoods": "N",
    "modeOfTransport": 2,
    "consigneeName": "John Doe",
    "insuranceAuthorization": "",
    "description": "Big pallet of stuff"
  },
  "destinationAddress": {
    "address1": "30520 SE 84th St.#",
    "address2": ".",
    "city": "Wombat",
    "state": "WA",
    "postalCode": 98010,
    "countryCode": "US"
  },
  "originAddress": {
    "address1": "5003 Wrightsboro Rd",
    "address2": ".",
    "city": "Preston",
    "state": "GA",
    "postalCode": 30290,
    "countryCode": "US"
  },
  "payablesAttentionTo": "Andy Dulin",
  "payablesAddress": {
    "address1": "100 N Central Expressway",
    "address2": "Ste 720",
    "city": "Atlanta",
    "state": "PA",
    "postalCode": 10101,
    "countryCode": "US"
  },
  "shipperPrincipal": "VIACHEMO",
  "shipperAddress": {
    "address1": "5003 Wrightsboro Rd",
    "address2": ".",
    "city": "Taylor",
    "state": "PA",
    "postalCode": 11133,
    "countryCode": "US"
  },
  "status": "UNCONFIRMED"
}

Responses

200 OK

successful operation

Representations

application/json

400 Bad Request

Bad Request

Representations

application/json

401 Unauthorized

Unauthorized

Representations

application/json

Code samples

@ECHO OFF

curl -v -X POST "https://upscapital-api-portal.azure-api.net/coverage/quote/v1"
-H "bearer: "
-H "X-IBM-Client-ID: "
-H "Content-Type: application/json"

--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("bearer", "");
            client.DefaultRequestHeaders.Add("X-IBM-Client-ID", "");

            var uri = "https://upscapital-api-portal.azure-api.net/coverage/quote/v1?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}

// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://upscapital-api-portal.azure-api.net/coverage/quote/v1");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("bearer", "");
            request.setHeader("X-IBM-Client-ID", "");
            request.setHeader("Content-Type", "application/json");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://upscapital-api-portal.azure-api.net/coverage/quote/v1?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("bearer","");
                xhrObj.setRequestHeader("X-IBM-Client-ID","");
                xhrObj.setRequestHeader("Content-Type","application/json");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://upscapital-api-portal.azure-api.net/coverage/quote/v1";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"bearer"];
    [_request setValue:@"" forHTTPHeaderField:@"X-IBM-Client-ID"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://upscapital-api-portal.azure-api.net/coverage/quote/v1');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'bearer' => '',
    'X-IBM-Client-ID' => '',
    'Content-Type' => 'application/json',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>

########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'bearer': '',
    'X-IBM-Client-ID': '',
    'Content-Type': 'application/json',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('upscapital-api-portal.azure-api.net')
    conn.request("POST", "/coverage/quote/v1?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'bearer': '',
    'X-IBM-Client-ID': '',
    'Content-Type': 'application/json',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('upscapital-api-portal.azure-api.net')
    conn.request("POST", "/coverage/quote/v1?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

require 'net/http'

uri = URI('https://upscapital-api-portal.azure-api.net/coverage/quote/v1')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['bearer'] = ''
# Request headers
request['X-IBM-Client-ID'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body