ShipShow External API

https://www.shipshow.net/api
Admin
ShipShow External API allows customers to programmatically access their tracking data for...
Tokens:3,604
Snippets:22
Trust Score:4.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### GET Request Example for Get Trackings

Source: https://www.shipshow.net/api

This is an example of a GET request to retrieve tracking information. Ensure you replace YOUR_API_KEY with your actual generated API key.

```http
GET /external/getTrackings?apikey=YOUR_API_KEY
```

--------------------------------

### API Pagination Example

Source: https://www.shipshow.net/api

These `curl` commands illustrate how to paginate through large result sets. Use 'limit' to set the page size and 'offset' to specify the starting point for subsequent requests. Continue requesting until 'hasmoredata' is false.

```bash
# Get first 20 results
curl "https://api.shipshow.net/external/getTrackings?apikey=your-api-key&limit=20&offset=0"

# Get next 20 results  
curl "https://api.shipshow.net/external/getTrackings?apikey=your-api-key&limit=20&offset=20"

# Continue until hasmoredata = false
```

--------------------------------

### Get Trackings API

Source: https://www.shipshow.net/api

Retrieves tracking information for your account. Requires an API key for authentication and supports filtering, sorting, and pagination.

```APIDOC
## GET /external/getTrackings

### Description
Retrieves tracking information for your account. This endpoint allows you to fetch tracking details with various filtering and sorting options.

### Method
GET

### Endpoint
https://api.shipshow.net/external/getTrackings

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your generated API key (UUID format).
- **category_id** (string) - Optional - Filter by specific category ID.
- **search** (string) - Optional - Search within tracking titles.
- **statusfilter** (string) - Optional - Filter by tracking status. Possible values: `inforeceived`, `transit`, `outfordelivery`, `delivered`.
- **limit** (integer) - Optional - Number of results per page (max: 50). Default: 10.
- **offset** (integer) - Optional - Number of results to skip. Default: 0.
- **sortby** (string) - Optional - Sort field. Options: `deliverydate`, `carrier`, `status`, `dateadded`, `lastactivity`, `alphabetical`. Default: `deliverydate`.
- **sortorder** (string) - Optional - Sort direction. Options: `asc`, `desc`. Default: `desc`.

### Request Example
```
GET https://api.shipshow.net/external/getTrackings?apikey=YOUR_API_KEY&statusfilter=transit&limit=20
```

### Response
#### Success Response (200)
- **trackings** (array) - An array of tracking objects.
  - **tracking_id** (string) - Unique identifier for the tracking.
  - **title** (string) - Name or title of the shipment.
  - **carrier** (string) - Name of the shipping carrier.
  - **status** (string) - Current status of the shipment.
  - **last_update** (string) - Timestamp of the last status update.
  - **estimated_delivery** (string) - Estimated delivery date.

#### Response Example
```json
{
  "trackings": [
    {
      "tracking_id": "trk_12345abcde",
      "title": "Package from Amazon",
      "carrier": "amazon",
      "status": "transit",
      "last_update": "2023-10-27T10:30:00Z",
      "estimated_delivery": "2023-10-29"
    }
  ]
}
```
```

--------------------------------

### Example API Response JSON

Source: https://www.shipshow.net/api

This JSON object represents a typical response from the ShipShow API, detailing tracking information, categories, and pagination status.

```json
{
  "trackings": [
    {
      "scheduleddeliverydatestring": "2025-07-25",
      "totalcount": "1",
      "trackingnumber": "123456789012",
      "title": "Adidas Women Break Start Mid Shoes",
      "shorttitle": "Adidas Women Break Start Mid Shoes",
      "longtitle": "Adidas Women Break Start Mid Shoes",
      "scheduleddeliverydate": "2025-07-25",
      "scheduleddeliverytime": null,
      "category_id": "d6984a52-3f6f-4f6f-9c2c-9076981dcd81",
      "carrierurl": "https://www.fedex.com/apps/fedextrack/?tracknumbers=123456789012",
      "comments": [
        "Just what I needed, more ways to break my ankles. 👟 Thanks, Adidas! 🤕"
      ],
      "media": [
        "https://s3.us-east-1.amazonaws.com/media.shipshow.net/570a6a11-277b-4889-ab34-dfa232ea4b11.jpg"
      ],
      "history": [
        {
          "id": "67588ecd-0240-4549-88a4-1fe0838c38cd",
          "status": "transit",
          "message": "Arrived at FedEx location",
          "timestamp": "2025-07-23T17:47:00",
          "timezoneoffset": -240,
          "locationaddress": "SPARTANBURG, SC, 29301, US, United States",
          "locationlon": -81.9327167,
          "locationlat": 34.9515959,
          "timestamp_ts": 1753292820
        }
      ],
      "last_status": "transit",
      "last_status_message": "Arrived at FedEx location",
      "last_status_statustimestamp": "2025-07-23T17:47:00.000Z"
    }
  ],
  "categories": [
    {
      "id": "d6984a52-3f6f-4f6f-9c2c-9076981dcd81",
      "title": "Inbox",
      "isglobal": true
    },
    {
      "id": "08cf2a0f-74a8-4bad-a7ed-a1c86799b7e3",
      "title": "Archive",
      "isglobal": true
    }
  ],
  "hasmoredata": false
}
```

--------------------------------

### Get Trackings API

Source: https://www.shipshow.net/api

Retrieves tracking information for shipments. Supports filtering, searching, and pagination.

```APIDOC
## GET /external/getTrackings

### Description
Retrieves a list of tracking information for shipments. This endpoint supports various query parameters for filtering, searching, and controlling the pagination of results.

### Method
GET

### Endpoint
/external/getTrackings

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your unique API key for authentication.
- **statusfilter** (string) - Optional - Filters results by tracking status (e.g., 'transit', 'delivered').
- **limit** (integer) - Optional - The maximum number of tracking results to return per page. Default is 10, maximum is 50.
- **offset** (integer) - Optional - The number of tracking results to skip. Used for pagination, defaults to 0.
- **search** (string) - Optional - A search term to filter trackings by title or tracking number.
- **sortby** (string) - Optional - Specifies the order of results. Possible values include 'alphabetical', 'date'.

### Request Example
```bash
curl "https://api.shipshow.net/external/getTrackings?apikey=your-api-key&limit=20&offset=0"
```

### Response
#### Success Response (200)
- **trackings** (array) - Array of tracking objects.
- **categories** (array) - Array of all categories/folders.
- **hasmoredata** (boolean) - Indicates if there are more results available beyond the current page.

##### Tracking Object
- **tracking_id** (string (UUID)) - Unique identifier for the tracking.
- **trackingnumber** (string) - The actual tracking number from the carrier.
- **title** (string | null) - Custom user-set display title.
- **shorttitle** (string | null) - Auto-generated abbreviated title.
- **longtitle** (string | null) - Auto-generated full detailed title.
- **scheduleddeliverydate** (string | null) - Expected delivery date (YYYY-MM-DD format).
- **scheduleddeliverytime** (string | null) - Expected delivery time (ISO 8601 format).
- **latestscheduleddeliverytime** (string | null) - Latest possible delivery time (ISO 8601).
- **category_id** (string (UUID) | null) - ID of the assigned category.
- **created** (string) - When the tracking was added (ISO 8601 format).
- **extra** (object) - Additional metadata.
- **config** (object) - Tracking-specific configuration.
- **carrierurl** (string | null) - Direct link to the carrier's tracking page.
- **carrier** (object) - Carrier information.
- **media** (string[]) - Array of URLs to uploaded images.
- **comments** (string[]) - Array of user comments.
- **history** (object[]) - Complete status history.
- **last_status** (string) - Most recent status code.
- **last_status_message** (string) - Most recent human-readable status message.
- **last_status_statustimestamp** (string) - When the status was last updated (ISO 8601).

#### Response Example
```json
{
  "trackings": [
    {
      "scheduleddeliverydatestring": "2025-07-25",
      "totalcount": "1",
      "trackingnumber": "123456789012",
      "title": "Adidas Women Break Start Mid Shoes",
      "shorttitle": "Adidas Women Break Start Mid Shoes",
      "longtitle": "Adidas Women Break Start Mid Shoes",
      "scheduleddeliverydate": "2025-07-25",
      "scheduleddeliverytime": null,
      "category_id": "d6984a52-3f6f-4f6f-9c2c-9076981dcd81",
      "carrierurl": "https://www.fedex.com/apps/fedextrack/?tracknumbers=123456789012",
      "comments": [
        "Just what I needed, more ways to break my ankles. 👟 Thanks, Adidas! 🤕"
      ],
      "media": [
        "https://s3.us-east-1.amazonaws.com/media.shipshow.net/570a6a11-277b-4889-ab34-dfa232ea4b11.jpg"
      ],
      "history": [
        {
          "id": "67588ecd-0240-4549-88a4-1fe0838c38cd",
          "status": "transit",
          "message": "Arrived at FedEx location",
          "timestamp": "2025-07-23T17:47:00",
          "timezoneoffset": -240,
          "locationaddress": "SPARTANBURG, SC, 29301, US, United States",
          "locationlon": -81.9327167,
          "locationlat": 34.9515959,
          "timestamp_ts": 1753292820
        }
      ],
      "last_status": "transit",
      "last_status_message": "Arrived at FedEx location",
      "last_status_statustimestamp": "2025-07-23T17:47:00.000Z"
    }
  ],
  "categories": [
    {
      "id": "d6984a52-3f6f-4f6f-9c2c-9076981dcd81",
      "title": "Inbox",
      "isglobal": true
    },
    {
      "id": "08cf2a0f-74a8-4bad-a7ed-a1c86799b7e3",
      "title": "Archive",
      "isglobal": true
    }
  ],
  "hasmoredata": false
}
```

#### Error Responses
##### Missing API Key
```json
{
  "error": "API key is required"
}
```
Status Code: 400

##### Endpoint Not Found
```json
{
  "error": "Endpoint not found"
}
```
Status Code: 400

## Pagination
The API supports pagination for large result sets:
  * **Maximum limit:** 50 trackings per request
  * **Default limit:** 10 trackings per request
  * **Offset:** Use to skip results (0-based)
  * **Has more data:** Check the `hasmoredata` field to determine if more results exist

### Pagination Example
```bash
# Get first 20 results
curl "https://api.shipshow.net/external/getTrackings?apikey=your-api-key&limit=20&offset=0"

# Get next 20 results  
curl "https://api.shipshow.net/external/getTrackings?apikey=your-api-key&limit=20&offset=20"

# Continue until hasmoredata = false
```
```

--------------------------------

### Search API Request

Source: https://www.shipshow.net/api

This `curl` command demonstrates how to search for specific tracking items, such as 'laptop', and sort the results alphabetically. Customize the 'search' parameter for your needs.

```bash
curl "https://api.shipshow.net/external/getTrackings?apikey=your-api-key&search=laptop&sortby=alphabetical"
```

--------------------------------

### Basic API Request

Source: https://www.shipshow.net/api

This `curl` command demonstrates a basic request to the ShipShow API to retrieve tracking information. Replace 'your-api-key' with your actual API key.

```bash
curl "https://api.shipshow.net/external/getTrackings?apikey=your-api-key"
```

--------------------------------

### API Error Response: Missing API Key

Source: https://www.shipshow.net/api

This JSON object indicates an error due to a missing API key. Ensure your requests include a valid API key.

```json
{
  "error": "API key is required"
}
```

--------------------------------

### Filtered API Request

Source: https://www.shipshow.net/api

This `curl` command shows how to filter tracking results by status and limit the number of returned items. Use 'transit' for active shipments and adjust 'limit' as needed.

```bash
curl "https://api.shipshow.net/external/getTrackings?apikey=your-api-key&statusfilter=transit&limit=20"
```

--------------------------------

### API Error Response: Endpoint Not Found

Source: https://www.shipshow.net/api

This JSON object indicates that the requested endpoint was not found. Verify the API endpoint URL.

```json
{
  "error": "Endpoint not found"
}
```
Tokens:
Raw