Quickstart

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

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
}

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
      "unit_price": 19.99
22
    },
23
    {
24
      "reference_id": "DARK-ROAST",
25
      "name": "Dark Roast Coffee",
26
      "quantity": 1,
27
      "unit_price": 19.99
28
    }
29
  ],
30
  "reference_id": "840343901234", // the reference_id can be the same as the order_number
31
  "order_number": "1001",
32
  "type": "DTC",
33
  "financials": {
34
    "total_price": 45.99
35
  }
36
}

1
{
2
  "fulfillment_center": {
3
    "id": 8
4
  },
5
  "package_type": "Package",
6
  "box_packaging_type": "EverythingInOneBox",
7
  "boxes": [
8
    {
9
      "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC",
10
      "box_items": [
11
        {
12
          "quantity": 1,
13
          "inventory_id": 0 // get the inventory_id by making request to GET Products /2026-01/product?search=LIGHT-ROAST
14
        }
15
      ]
16
    }
17
  ],
18
  "expected_arrival_date": "2025-11-24T14:15:22Z",
19
  "purchase_order_number": "PO123"
20
}