Setup Sandbox Account

Our sandbox accounts allow you to test your integration with realistic, production-like data. Think of it as a practice run - everything works like the real thing, but no actual shipments are made.

Step 1: Create sandbox account

• Sign up for our Sandbox environment, here.
• Validate your email address to activate your account.

Step 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.

1. Navigate to Finances > Payment Methods in the ShipBob dashboard
2. Click Link Credit Card.
3. Enter the following details:
   • Card Number: 4111 1111 1111 1111
   • CVC: Any 3-digit number
   • Expiration Date: Any future MM/YY
   • Zip Code: Any valid zip code
4. Click Add Credit Card.

Credit card entry form

Step 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.

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.

GET https://sandbox-api.shipbob.com/2026-01/channel

1
[
2
  {
3
    "id": 100102,
4
    "name": "Privileged Access Token Wednesday, September 20, 2025",
5
    "application_name": "SMA",
6
    "scopes": [
7
      "fulfillments_write",
8
      "webhooks_read",
9
      "returns_read",
10
      "orders_read",
11
      "inventory_write",
12
      "inventory_read",
13
      "returns_write",
14
      "products_read",
15
      "webhooks_write",
16
      "receiving_write",
17
      "receiving_read",
18
      "channels_read",
19
      "products_write",
20
      "locations_read",
21
      "orders_write",
22
      "fulfillments_read",
23
      "locations_write"
24
    ]
25
  },
26
  {
27
    "id": 100101,
28
    "name": "ShipBob Default",
29
    "application_name": "ShipBob",
30
    "scopes": [
31
      "webhooks_read",
32
      "returns_read",
33
      "orders_read",
34
      "inventory_read",
35
      "products_read",
36
      "receiving_read",
37
      "channels_read",
38
      "locations_read",
39
      "fulfillments_read"
40
    ]
41
  }
42
]

Step 5: Create product

Below is a sample request to create a product:

1
{
2
  "name": "Light Roast Coffee",
3
  "type_id": 1,
4
  "variants": [
5
    {
6
      "name": "Light Roast Coffee",
7
      "sku": "LIGHT-ROAST",
8
      "packaging_requirement_id": 1,
9
      "packaging_material_type_id": 1
10
    }
11
  ]
12
}

Step 6: Create Order

Below is a sample request to create a order:

1
{
2
  "shipping_method": "Standard",
3
  "recipient": {
4
    "name": "John Doe",
5
    "address": {
6
      "address1": "100 Nowhere Blvd",
7
      "address2": "Suite 100",
8
      "city": "Gotham City",
9
      "state": "NJ",
10
      "country": "US",
11
      "zip_code": "07093"
12
    },
13
    "email": "john@example.com",
14
    "phone_number": "555-555-5555"
15
  },
16
  "products": [
17
    {
18
      "reference_id": "LIGHT-ROAST",
19
      "name": "Light Roast Coffee",
20
      "quantity": 1,
21
    }
22
  ],
23
  "reference_id": "840343901234", // the reference_id can be the same as the order_number
24
  "order_number": "1001",
25
  "type": "DTC",
26
}

You can also test making this request in our API Playground here.

Step 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.

Step 8: Add packaging preferences (optional)

Set these up in the ShipBob dashboard under Products > [Your Product] > Packaging Preferences.

✅ Next Steps

Ready to test fulfillment workflows?

Check out our Sandbox Simulations guide to simulate order shipping and delivery events in your sandbox environment.