# Overview

First-time users and those looking for specific integration tutorials, see our full API documentation and guides.
Download the API Specification yaml file

API Resources

All API URLs listed in this documentation are relative to https://api.goshippo.com/. For example, the `/addresses/` resource is reachable at `https://api.goshippo.com/addresses/`.

Authentication

The API requires Shippo's token HTTP Authentication with your Shippo token (live or test). In order to authenticate properly, please put `Authorization: ShippoToken ` in your header. You can find your token on the Shippo API settings page. For more information about authentication and test mode, please visit our Authentication guide. The API is available via Secure Socket Layer (SSL) only. All requests to the Shippo API must use TLS version 1.2 or higher.

Request & Response Data

Request data is passed to the API by POSTing JSON objects with the appropriate key/value-pairs to the respective resource. The documentation for each API resource contains more details on the values accepted by a given resource. Response data also formatted as JSON object. You can specify how many results per page are to be returned. For instance, `/rates/?results=25` will return up to 25 results.

REST & Disposable Objects

The Shippo API is built around REST principles. Use POST requests to create objects, GET requests to retrieve objects, and PUT requests to update objects. Only the Carrier Accounts object can be updated via PUT requests. All other objects such as Addresses, Parcels, Shipments, Rates, Transactions, Refunds, Customs Items, and Customs Declarations are disposable. This means that once you have created an object, you cannot change it. Instead, create a new one with the desired values.

API Version

This reference guide supports the Shippo API version: `2018-02-08` . To see reference guides for older API versions, see our legacy reference guide. For more information about Shippo API versions, see our API versions guide.