Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.goshippo.com/llms.txt

Use this file to discover all available pages before exploring further.

Use this quickstart guide to help understand what Shipping Elements is, see how it looks and works, and quickly setup your own application. This is one example implementation created in React using the CreateReactApp. For more information on integrating Shipping Elements into your own website, follow the rest of the Shipping Elements guide.

​
Try Shipping Elements

You can use a working example of Shipping Elements in our demo site.
  1. Using the Shippo web app, get your Shippo token. For testing, we recommend you use your Shippo test token
  2. Use your Shippo token to create a JWT using the authz endpoint. Replace <API_TOKEN> with your token
curl --location --request POST 'https://api.goshippo.com/embedded/authz/' \
--header 'Authorization: ShippoToken <API_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "scope": "embedded:carriers"
}'
For more information on authorization in Shipping Elements, see our authorization guide 3. Paste your generated JWT into our demo site 4. Select Purchase Label to view and interact with the application

​
Run Shipping Elements locally

You can also run Shipping Elements on your local system. Before you begin, you must have Node installed. Complete the following steps to run Shipping Elements locally.
  1. Clone or download the following repository to local system https://github.com/goshippo/shipping-elements-react-demo
  2. Using your console, navigate to the project directory
  3. Run the following command to install the project dependencies
npm install
  1. Run the following command to run the application in development mode
npm start
  1. Open http://localhost:3000 in your browser to view and interact with the application