Shipping API

Our RESTful shipping API helps developers to quickly build up a professional shipping module for their online stores or applications.

Global Address Validation

Detect deliverability issues, correct minor errors in spelling or format, and determine if an address is residential or not

Multi-Carrier Support

Have full access to all types of carrier services by FedEx, UPS, and USPS, and easily compare rates across carriers

Discount on Shipping

Save up to 80% off on shipping labels with our negotiated carrier rates, or bring your own accounts

Real-time Tracking

Update the status of your shipments. Easily integrate tracking information of shipments into your websites or applications

Simple. Powerful. Flexible.

With comprehensive documentation and examples, developers can quickly understand and get started with our shipping API. Our APIs can work alone or in conjunction with each other to realize shipping functionality for application or service.

Shipping
Rating
Address
Tracking

POST : https://api.circle.us/ShipmentServer/create
    {
        "toAddress": {
            "fullName": "RES",
            "company": "RES",
            "country": "US",
            "zipcode": "96007-9193",
            "state": "CA",
            "city": "ANDERSON",
            "street1": "18596 SILHOUETTE LN",
            "phoneNumber": "8678289762",
            "isRes": "1",
            "isApo": "0",
            "isVerify": "1",
            "key": "5a4e2ebc65f9d8b2353ac39ad75d7347"
        },
        "fromAddress": {
            "fullName": "Circle.Us",
            "company": "Circle US",
            "country": "US",
            "zipcode": "19711",
            "state": "DE",
            "city": "Newark",
            "street1": "201 Ruthar Drive, Suite 7",
            "phoneNumber": "302-283-9881",
            "isRes": "0",
            "isApo": "0",
            "isVerify": "0",
            "key": "032a498677a724c0e65c55f19fe35aaf"
        },
        "server": "FedEx",
        "serverLevel": "FedExGround",
        "packageType": "FedExPackage",
        "dropOffType": "DropBox",
        "confirmation": "FedExNonespecified",
        "reference": "test",
        "lableSize": "SIZE4_6",
        "labelFileType": "PDF",
        "account": {
            "payorType": "circleus",
            "paymentType": "SENDER"
        },
        "shipDate": "2016-01-01T00:00:00+00:00",
        "packages": [
            {
                "weight": 10,
                "weightUnit": "LB"
            }
        ]
    }
Response :
    {
        "key": "ship_DAG06AG2I55J7H97E1",
        "status": "ShipmentReady",
        "toAddress": {
            "fullName": "RES",
            "company": "RES",
            "country": "US",
            "zipcode": "96007-9193",
            "state": "CA",
            "city": "ANDERSON",
            "street1": "18596 SILHOUETTE LN",
            "phoneNumber": "8678289762",
            "isRes": "1",
            "isApo": "0",
            "isVerify": "1",
            "key": "5a4e2ebc65f9d8b2353ac39ad75d7347"
        },
        "fromAddress": {
            "fullName": "Circle.Us",
            "company": "Circle US",
            "country": "US",
            "zipcode": "19711",
            "state": "DE",
            "city": "Newark",
            "street1": "201 Ruthar Drive, Suite 7",
            "phoneNumber": "302-283-9881",
            "isRes": "0",
            "isApo": "0",
            "isVerify": "0",
            "key": "032a498677a724c0e65c55f19fe35aaf"
        },
        "server": "FedEx",
        "serverLevel": "FedExGround",
        "packageType": "FedExPackage",
        "dropOffType": "DropBox",
        "confirmation": "FedExNonespecified",
        "reference": "test",
        "account": {
            "payorType": "circleus",
            "paymentType": "SENDER"
        },
        "shipDate": "2016-01-01T00:00:00+00:00",
        "packages": [
            {
                "weight": 10,
                "weightUnit": "LB"
            }
        ]
    }

POST : https://api.circle.us/RateServer/rate?shipKey={your_shipment_key}
Response:
    {
        "id": 123456789,
        "createdDate": "2017-01-22T06:05:26+00:00",
        "ownerId": "06452",
        "shipId": 43,
        "modifiedDate": "2017-01-22T06:05:26+00:00",
        "modifior": "06452",
        "transitTime": "4",
        "baseRate": 16.03,
        "customerRate": 12.66,
        "baseCharge": 20.2,
        "customerCharge": 16.05,
        "baseFuelSurcharge": 0.78,
        "fuelPercentage": 0.04,
        "customerFuelSurcharge": 0.61,
        "baseSurchargeTransport": 3.45,
        "baseSurchargeTransportDetail": "Residential delivery:3.45;",
        "customerSurchargeTransport": 2.76,
        "customerSurchargeTransportDetail": "Residential delivery:2.76;"
    }
                

POST : https://api.circle.us/AddressServer/create

    {
        "fullName": "RES",
        "company": "RES",
        "country": "US",
        "zipcode": "96007-9193",
        "state": "CA",
        "city": "ANDERSON",
        "street1": "18596 SILHOUETTE LN",
        "phoneNumber": "8678289762"
    }
Response :
    {
        "fullName": "RES",
        "company": "RES",
        "country": "US",
        "zipcode": "96007-9193",
        "state": "CA",
        "city": "ANDERSON",
        "street1": "18596 SILHOUETTE LN",
        "street2": "SILHOUETTE",
        "phoneNumber": "8678289762",
        "email": "support@circle.us",
        "isRes": "1",
        "isApo": "0",
        "isVerify": "1",
        "key": "5a4e2ebc65f9d8b2353ac39ad75d7347"

    }
                

GET : https://api.circle.us/LabelServer/tracking?shipKey=ship_DAG06AG2I55J7H97E1
Response :
    {
        "key": "ship_14H98A66F7BF33D25A",
        "createdDate": "2016-11-22T11:48:53+08:00",
        "status": "ShipmentReady",
        "toAddress": {
            "fullName": "Client",
            "company": "Circle US",
            "country": "US",
            "zipcode": "10001",
            "state": "DE",
            "city": "Newark",
            "street1": "201 Ruthar Drive, Suite 7",
            "phoneNumber": "302-283-9881",
            "isRes": "0",
            "isApo": "0",
            "isVerify": "0",
            "key": "8754ef1cc2b95ccf8afbd8be9aa5cb6b"
        },
        "fromAddress": {
            "fullName": "Circle.Us",
            "company": "Circle US",
            "country": "US",
            "zipcode": "19711",
            "state": "DE",
            "city": "Newark",
            "street1": "201 Ruthar Drive, Suite 7",
            "phoneNumber": "302-283-9881",
            "isRes": "0",
            "isApo": "0",
            "isVerify": "0",
            "key": "032a498677a724c0e65c55f19fe35aaf"
        },
        "server": "UPS",
        "serverLevel": "UPSGround",
        "packageType": "UPSPackage",
        "dropOffType": "DropBox",
        "confirmation": "UPSNoConfirmation",
        "shipmentNo": "XXXXXXXXXXXXXXXXXX",
        "account": {
            "payorType": "circleus",
            "paymentType": "SENDER"
        },
        "shipDate": "2016-01-01T00:00:00+00:00",
        "packages": [
            {
                "weight": 10,
                "weightUnit": "LB",
                "trackingNumber": "XXXXXXXXXXXXXXXXXX",
                "trackDetails": [
                    {
                        "time": "102500",
                        "date": "20161121",
                        "message": "Delivered",
                        "type": "D",
                        "code": "KB",
                        "city": "CHANTILLY",
                        "state": "VA",
                        "zipcode": "20151",
                        "country": "US",
                        "street1": "14900 CONFERENCE CENTER DR",
                        "street2": "250"
                    },
                    {
                        "time": "032100",
                        "date": "20161121",
                        "message": "Out For Delivery",
                        "type": "I",
                        "code": "DS",
                        "city": "CHANTILLY",
                        "state": "VA",
                        "country": "US"
                    },
                    {
                        "time": "015800",
                        "date": "20161119",
                        "message": "Arrival Scan",
                        "type": "I",
                        "code": "AR",
                        "city": "CHANTILLY",
                        "state": "VA",
                        "country": "US"
                    },
                    {
                        "time": "004900",
                        "date": "20161119",
                        "message": "Departure Scan",
                        "type": "I",
                        "code": "DP",
                        "city": "BALTIMORE",
                        "state": "MD",
                        "country": "US"
                    },
                    {
                        "time": "232300",
                        "date": "20161118",
                        "message": "Arrival Scan",
                        "type": "I",
                        "code": "AR",
                        "city": "BALTIMORE",
                        "state": "MD",
                        "country": "US"
                    },
                    {
                        "time": "204700",
                        "date": "20161118",
                        "message": "Departure Scan",
                        "type": "I",
                        "code": "DP",
                        "city": "NEW CASTLE",
                        "state": "DE",
                        "country": "US"
                    },
                    {
                        "time": "164400",
                        "date": "20161118",
                        "message": "Pickup Scan",
                        "type": "P",
                        "code": "PU",
                        "city": "NEW CASTLE",
                        "state": "DE",
                        "country": "US"
                    },
                    {
                        "time": "145058",
                        "date": "20161118",
                        "message": "Order Processed: Ready for UPS",
                        "type": "M",
                        "code": "MP",
                        "country": "US"
                    }
                ]
            }
        ]
    }
                

Ready to get started?

Create your account, or get in touch.