Our sandbox accounts are separate environments and data cannot be transferred over to production.
1
Create sandbox account
- Sign up for our Sandbox environment, here.
- Validate your email address to activate your account.
2
Add a test payment method
Add a test payment method so when you create new orders the orders do not go OnHold due to payment failure.
- Navigate to Finances > Payment Methods in the ShipBob dashboard
- Click Link Credit Card.
- Enter the following details:
- Card Number:
4242 4242 4242 4242
- CVC: Any 3-digit number
- Expiration Date: Any future MM/YY
- Zip Code: Any valid zip code
- Card Number:
- Click Add Credit Card.

3
Get API key
ShipBob verifies a user’s request by using a Bearer token in the header. We call this a Personal Access Token.On the ShipBob dashboard, go to Integrations > API Tokens. Click Generate New Token. Copy this token as we will use in next step.
4
Make your first API request
Use your PAT token to make a request to the GET Channels endpoint. You will need the channel ID to create products, orders and returns with the ShipBob API.
Example response
Example response
The channel ID to use when creating products, orders and returns would be
100102
since this is the channel that has scopes with _write
access.GET Channel 2.0/channel
5
Create product
Below is a sample request to create a product:
Make sure to pass the
shipbob_channel_id
in the header.6
Create Order
Below is a sample request to create a order:You can also test making this request in our API Playground here.
Make sure to pass the
shipbob_channel_id
in the header.7
Add inventory
If you want to add test inventory quantities to your products please email
techspecialists@shipbob.com
with your request and the email tied to your Sandbox account.8
Add packaging preferences (optional)
Set these up in the ShipBob dashboard under Products > [Your Product] > Packaging Preferences.
If you are using the 1.0/product endpoint you have to do this manually for each product in your sandbox account.