usps-webtools

    1.0.7 • Public • Published

    Installation:

    npm install usps-webtools

    Usage:

    Initializing the usps model with usps server url address, and user id.

    Example:

    const USPS = require('usps-webtools');
    
    const usps = new USPS({
      server: 'http://production.shippingapis.com/ShippingAPI.dll',
      userId: 'USPS User id',
      ttl: 10000 //TTL in milliseconds for request
    });

    verify(object, callback)

    Verify takes two parameters: object and callback.

    object: street1, street2, city, state, zip

    callback: err, address

    Example

    usps.verify({
      street1: '322 3rd st.',
      street2: 'Apt 2',
      city: 'San Francisco',
      state: 'CA',
      zip: '94103'
    }, function(err, address) {
      console.log(address);
    });

    zipCodeLookup(object, callback)

    zipCodeLookup takes two parameters: object and callback.

    object: street1, street2, city, state

    callback: err, address

    Example

    usps.zipCodeLookup({
      street1: '322 3rd st.',
      street2: 'Apt 2',
      city: 'San Francisco',
      state: 'CA'
    }, function(err, address) {
      console.log(address);
    });

    cityStateLookup(object, callback)

    cityStateLookup takes two parameters: zipcode and callback.

    zipcode: 5 digit zipcode

    callback: err, address

    Example

    usps.cityStateLookup('94107', function(err, result) {
      // result == { city: , state: , zip: }
    });

    Install

    npm i usps-webtools

    DownloadsWeekly Downloads

    2,432

    Version

    1.0.7

    License

    MIT

    Unpacked Size

    17.1 kB

    Total Files

    13

    Last publish

    Collaborators

    • scottspork
    • isurfbecause
    • madisonreedadmin