ShipStation API V2

https://docs.shipstation.com
Admin
ShipStation API V2 is a REST API for shipping and inventory management that enables rate shopping,...
Tokens:755,642
Snippets:6,558
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example GET Request with Query Parameters

Source: https://docs.shipstation.com/apis/shipengine/docs/getting-started/rest.md

Demonstrates a GET request to retrieve labels, utilizing query parameters to filter by creation date. Includes Host, API-Key, and Content-Type headers.

```http
GET /v1/labels?created_at_start=2020-11-09T00:37:54.14212Z&created_at_end=2020-11-09T22:37:54.14212Z HTTP/1.1
Host: https://api-stage.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
```

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

### List Batches Request Example

Source: https://docs.shipstation.com/apis/shipengine/docs/reference/list-batches.md

Demonstrates how to make a GET request to the /v1/batches endpoint to retrieve batches with a specific status. Ensure you replace '__YOUR_API_KEY_HERE__' with your actual API key.

```http
GET /v1/batches?status=open HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
```

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

### Get Shipping Rates

Source: https://docs.shipstation.com/apis/shipengine/docs/rates/advanced-features.md

This example demonstrates how to request shipping rates for a shipment. It includes the necessary shipment details and rate options.

```APIDOC
## POST /v1/rates

### Description
Requests shipping rates for a given shipment based on specified criteria.

### Method
POST

### Endpoint
/v1/rates

### Parameters
#### Request Body
- **shipment** (object) - Required - Details of the shipment, including origin, destination, and package information.
  - **comparison_rate_type** (string) - Optional - The type of rate to compare (e.g., "retail").
  - **ship_to** (object) - Required - Information about the recipient.
    - **name** (string) - Required - Recipient's name.
    - **phone** (string) - Required - Recipient's phone number.
    - **company_name** (string) - Optional - Recipient's company name.
    - **address_line1** (string) - Required - First line of the recipient's address.
    - **city_locality** (string) - Required - Recipient's city.
    - **state_province** (string) - Required - Recipient's state or province.
    - **postal_code** (string) - Required - Recipient's postal code.
    - **country_code** (string) - Required - Recipient's country code (e.g., "US").
    - **address_residential_indicator** (string) - Required - Indicates if the address is residential ('yes' or 'no').
  - **ship_from** (object) - Required - Information about the sender.
    - **name** (string) - Required - Sender's name.
    - **phone** (string) - Required - Sender's phone number.
    - **company_name** (string) - Optional - Sender's company name.
    - **address_line1** (string) - Required - First line of the sender's address.
    - **city_locality** (string) - Required - Sender's city.
    - **state_province** (string) - Required - Sender's state or province.
    - **postal_code** (string) - Required - Sender's postal code.
    - **country_code** (string) - Required - Sender's country code (e.g., "US").
    - **address_residential_indicator** (string) - Required - Indicates if the address is residential ('yes' or 'no').
  - **packages** (array) - Required - An array of package objects.
    - **package_code** (string) - Required - The code for the package type.
    - **weight** (object) - Required - The weight of the package.
      - **value** (number) - Required - The weight value.
      - **unit** (string) - Required - The unit of weight (e.g., "ounce").
- **rate_options** (object) - Optional - Options for rate calculation.
  - **carrier_ids** (array) - Optional - An array of carrier IDs to filter rates by.

### Request Example
```json
{
    "shipment": {
        "comparison_rate_type": "retail",
        "ship_to": {
            "name": "The President",
            "phone": "222-333-4444",
            "company_name": "",
            "address_line1": "1600 Pennsylvania Avenue NW",
            "city_locality": "Washington",
            "state_province": "DC",
            "postal_code": "20500",
            "country_code": "US",
            "address_residential_indicator": "no"
        },
        "ship_from": {
            "name": "ShipStation API Team",
            "phone": "222-333-4444",
            "company_name": "ShipStation API",
            "address_line1": "4301 Bull Creek Road",
            "city_locality": "Austin",
            "state_province": "TX",
            "postal_code": "78731",
            "country_code": "US",
            "address_residential_indicator": "no"
        },
        "packages": [
            {
                "package_code": "package",
                "weight": {
                    "value": 6,
                    "unit": "ounce"
                }
            }
        ]
    },
    "rate_options": {
        "carrier_ids": [
            "se-12345"
        ]
    }
}
```

### Response
#### Success Response (200)
- **rate_response** (object) - Contains the calculated rates and related information.
  - **rates** (array) - A list of available shipping rates.
    - **rate_id** (string) - Unique identifier for the rate.
    - **rate_type** (string) - Type of rate (e.g., "shipment").
    - **carrier_id** (string) - ID of the carrier providing the rate.
    - **shipping_amount** (object) - The cost of shipping.
      - **currency** (string) - Currency code (e.g., "usd").
      - **amount** (number) - The shipping cost.
    - **insurance_amount** (object) - Cost of insurance.
    - **confirmation_amount** (object) - Cost of confirmation.
    - **other_amount** (object) - Cost of other services.
    - **requested_comparison_amount** (object) - The comparison amount requested.
    - **rate_details** (array) - Details about the rate.
    - **zone** (number) - The shipping zone.
    - **package_type** (string) - The type of package.
    - **delivery_days** (number) - Estimated delivery days.
    - **guaranteed_service** (boolean) - Indicates if the service is guaranteed.
    - **estimated_delivery_date** (string) - The estimated delivery date.
    - **carrier_delivery_days** (string) - Carrier's estimated delivery days.
    - **ship_date** (string) - The ship date.
    - **negotiated_rate** (boolean) - Indicates if it's a negotiated rate.
    - **service_type** (string) - The type of service (e.g., "USPS Priority Mail").
    - **service_code** (string) - The code for the service.
    - **trackable** (boolean) - Indicates if the shipment is trackable.
    - **carrier_code** (string) - The carrier's code.
    - **carrier_nickname** (string) - The carrier's nickname.
    - **carrier_friendly_name** (string) - A user-friendly name for the carrier.
    - **validation_status** (string) - The validation status of the rate.
    - **warning_messages** (array) - Any warning messages.
    - **error_messages** (array) - Any error messages.
  - **invalid_rates** (array) - A list of invalid rates.
  - **rate_request_id** (string) - The ID of the rate request.
  - **shipment_id** (string) - The ID of the shipment.
  - **created_at** (string) - Timestamp of when the rate was created.
  - **status** (string) - The status of the rate request.
  - **errors** (array) - Any errors encountered during the rate request.

#### Response Example
```json
{
    "rate_response": {
        "rates": [
            {
                "rate_id": "se-6384266",
                "rate_type": "shipment",
                "carrier_id": "se-204152",
                "shipping_amount": {
                    "currency": "usd",
                    "amount": 6.7300
                },
                "insurance_amount": {
                    "currency": "usd",
                    "amount": 0.0
                },
                "confirmation_amount": {
                    "currency": "usd",
                    "amount": 0.0
                },
                "other_amount": {
                    "currency": "usd",
                    "amount": 0.0
                },
                "requested_comparison_amount": {
                    "currency": "usd",
                    "amount": 9.3500
                },
                "rate_details": [],
                "zone": 1,
                "package_type": "package",
                "delivery_days": 1,
                "guaranteed_service": false,
                "estimated_delivery_date": "2023-11-02T00:00:00Z",
                "carrier_delivery_days": "1",
                "ship_date": "2023-11-01T00:00:00Z",
                "negotiated_rate": false,
                "service_type": "USPS Priority Mail",
                "service_code": "usps_priority_mail",
                "trackable": true,
                "carrier_code": "usps",
                "carrier_nickname": "My Stamps account",
                "carrier_friendly_name": "USPS",
                "validation_status": "valid",
                "warning_messages": [],
                "error_messages": []
            }
        ],
        "invalid_rates": [],
        "rate_request_id": "se-12345",
        "shipment_id": "se-12345",
        "created_at": "2023-11-01T15:53:03.8069761Z",
        "status": "completed",
        "errors": []
    },
    "shipment_id": "se-12345",
    "carrier_id": null,
    "service_code": null,
    "external_shipment_id": null,
    "shipment_number": null,
    "ship_date": "2023-11-01T00:00:00Z",
    "created_at": "2023-11-01T15:52:52.833Z",
    "modified_at": "2023-11-01T15:52:52.773Z",
    "shipment_status": "pending",
    "ship_to": {
        "instructions": null,
        "name": "Bruce Wayne",
        "phone": "222-333-4444",
        "email": null,
        "company_name": "Wayne Enterprises",
        "address_line1": "1990 E. Grand Ave",
        "address_line2": null,
        "address_line3": null,
        "city_locality": "El Segundo",
        "state_province": "CA",
        "postal_code": "90245",
        "country_code": "US",
        "address_residential_indicator": "no"
    },
    "ship_from": {
        "instructions": null,
        "name": "Bruce Wayne",
        "phone": "222-333-4444",
        "email": null,
        "company_name": "Wayne Enterprises",
        "address_line1": "1990 E. Grand Ave",
        "address_line2": null,
        "address_line3": null,
        "city_locality": "El Segundo",
        "state_province": "CA",
        "postal_code": "90245",
        "country_code": "US",
        "address_residential_indicator": "no"
    },
    "warehouse_id": null,
    "return_to": {
        "instructions": null,
        "name": "Bruce Wayne",
        "phone": "222-333-4444",
        "email": null,
        "company_name": "Wayne Enterprises",
        "address_line1": "1990 E. Grand Ave",
        "address_line2": null,
        "address_line3": null,
        "city_locality": "El Segundo",
        "state_province": "CA",
    }
}
```
```

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

### Install @shipengine/elements

Source: https://docs.shipstation.com/apis/shipengine/docs/elements/elements-react.md

Install the ShipEngine Elements package using npm.

```bash
npm install @shipengine/elements
```

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

### Example Response for GET /v2/labels

Source: https://docs.shipstation.com/creating-manifests.md

This is an example response for the GET /v2/labels endpoint, showing two labels created within the specified time range. The response includes details for each label, such as ID, status, creation timestamp, and tracking information.

```json
{
 "labels": [
   {
     "label_id": "se-29602037",
     "status": "completed",
     "shipment_id": "se-6470112",
     "ship_date": "2023-11-05T00:00:00Z",
     "created_at": "2023-11-05T14:26:59.91Z",
     "shipment_cost": {
       "currency": "usd",
       "amount": 3.18
     },
     "insurance_cost": {
       "currency": "usd",
       "amount": 0.0
     },
     "tracking_number": "9400111899223674205955",
     "is_return_label": false,
     "rma_number": null,
     "is_international": false,
     "batch_id": "",
     "carrier_id": "se-82785",
     "service_code": "usps_first_class_mail",
     "package_code": "package",
     "voided": false,
     "voided_at": null,
     "label_format": "pdf",
     "display_scheme": "label",
     "label_layout": "4x6",
     "trackable": true,
     "label_image_id": null,
     "carrier_code": "stamps_com",
     "tracking_status": "in_transit",
     "label_download": {
       "pdf": "https://api.shipstation.com/v2/downloads/0/VIYxvqt0CEaeE6kVeQq7DQ/label-1049004.pdf",
       "png": "https://api.shipstation.com/v2/downloads/0/VIYxvqt0CEaeE6kVeQq7DQ/label-1049004.png",
       "zpl": "https://api.shipstation.com/v2/downloads/0/VIYxvqt0CEaeE6kVeQq7DQ/label-1049004.zpl",
       "href": "https://api.shipstation.com/v2/downloads/0/VIYxvqt0CEaeE6kVeQq7DQ/label-1049004.pdf"
     },
     "form_download": null,
     "insurance_claim": null,
     "packages": [
       {
         "package_code": "package",
         "weight": {
           "value": 1.00,
           "unit": "ounce"
         },
         "dimensions": {
           "unit": "inch",
           "length": 0.0,
           "width": 0.0,
           "height": 0.0
         },
         "insured_value": {
           "currency": "usd",
           "amount": 0.00
         },
         "tracking_number": "9400111899223674205955",
         "label_messages": {
           "reference1": null,
           "reference2": null,
           "reference3": null
         },
         "external_package_id": null
       }
     ],
     "charge_event": "carrier_default"
   },
   {
     "label_id": "se-29544722",
     "status": "completed",
     "shipment_id": "se-6470260",
     "ship_date": "2023-11-05T00:00:00Z",
     "created_at": "2023-11-05T16:53:41.127Z",
     "shipment_cost": {
       "currency": "usd",
       "amount": 3.18
     },
     "insurance_cost": {
       "currency": "usd",
       "amount": 0.0
     },
     "tracking_number": "9400111899223674665629",
     "is_return_label": false,
     "rma_number": null,
     "is_international": false,
     "batch_id": "",
     "carrier_id": "se-82785",
     "service_code": "usps_first_class_mail",
     "package_code": "package",
     "voided": false,
     "voided_at": null,
     "label_format": "pdf",
     "display_scheme": "label",
     "label_layout": "4x6",
     "trackable": true,
     "label_image_id": null,
     "carrier_code": "stamps_com",
     "tracking_status": "in_transit",
     "label_download": {
       "pdf": "https://api.shipstation.com/v2/downloads/0/KVAY5M7MG0GvNLCBFBbM9Q/label-1049067.pdf",
       "png": "https://api.shipstation.com/v2/downloads/0/KVAY5M7MG0GvNLCBFBbM9Q/label-1049067.png",
       "zpl": "https://api.shipstation.com/v2/downloads/0/KVAY5M7MG0GvNLCBFBbM9Q/label-1049067.zpl",
       "href": "https://api.shipstation.com/v2/downloads/0/KVAY5M7MG0GvNLCBFBbM9Q/label-1049067.pdf"
     },
     "form_download": null,
     "insurance_claim": null,
     "packages": [
       {
         "package_code": "package",
         "weight": {
           "value": 1.00,
           "unit": "ounce"
         },
         "dimensions": {
           "unit": "inch",
           "length": 0.0,
           "width": 0.0,
           "height": 0.0
         },
         "insured_value": {
           "currency": "usd",
           "amount": 0.00
         },
         "tracking_number": "9400111899223674665629",
         "label_messages": {
           "reference1": null,
           "reference2": null,
           "reference3": null
         },
         "external_package_id": null
       }
     ],
     "charge_event": "carrier_default"
   }
 ],
 "total": 2,
 "page": 1,
 "pages": 1,
 "links": {
   "first": {

```

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

### Initialize Onboarding Element with SDK

Source: https://docs.shipstation.com/apis/shipengine/docs/elements/onboarding/onboarding.md

Create an instance of the Elements SDK and initialize the onboarding component with the required configuration and carrier settings.

```js
// Creates a new instance of the Elements SDK.
const elements = new ElementsSDK(getToken, {
  onError: (err: Error) => console.error(err),
  themeConfig: themeConfig,
  locale: 'en-US',
  features: {
    globalFeatures: {
      enabledShipEngineCarriers: ['stamps_com', 'globalPost'],
    },
  },
});

const onboarding = elements.create('onboarding', {
  onComplete: () => console.log('complete'),
  defaultShipFromAddress: defaultShipFromAddress,
});
```

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

### Get Labels with Query Parameters Example

Source: https://docs.shipstation.com/apis/shipengine/docs/getting-started/rest.md

Demonstrates how to retrieve labels using GET request and filtering with URL query parameters.

```APIDOC
## GET /v1/labels

### Description
Retrieves a list of shipping labels, optionally filtered by query parameters.

### Method
GET

### Endpoint
https://api.shipengine.com/v1/labels

### Query Parameters
- **carrier_id** (string) - Optional - Filters labels by a specific carrier ID.
- **warehouse_id** (string) - Optional - Filters labels by a specific warehouse ID.
- **created_at_start** (string) - Optional - Filters labels created after this date/time (ISO 8601 format).
- **created_at_end** (string) - Optional - Filters labels created before this date/time (ISO 8601 format).

### Request Example
```http
GET /v1/labels?carrier_id=se-28529731&created_at_start=2020-11-09T00:37:54.14212Z HTTP/1.1
Host: https://api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
```

### Response
#### Success Response (200)
- **labels** (array) - An array of label objects.
  - **label_id** (string) - The unique identifier for the label.
  - **tracking_number** (string) - The tracking number for the shipment.
  - **created_at** (string) - The timestamp when the label was created.

#### Response Example
```json
{
  "labels": [
    {
      "label_id": "se-111111111",
      "tracking_number": "1ZABCDEFGHIJKLMN",
      "created_at": "2020-11-09T10:00:00.000Z"
    },
    {
      "label_id": "se-222222222",
      "tracking_number": "1ZOPQRSTUVWXYZ123",
      "created_at": "2020-11-09T11:00:00.000Z"
    }
  ]
}
```
```

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

### GET /stores

Source: https://docs.shipstation.com/_bundle/apis/%40shipstation-v1/openapi.json?download=

Retrieve the list of installed stores on the account.

```APIDOC
## GET /stores

### Description
Retrieve the list of installed stores on the account.

### Method
GET

### Endpoint
/stores

### Parameters
#### Query Parameters
- **showInactive** (boolean) - Optional - Whether to include inactive stores
- **marketplaceId** (integer) - Optional - Filter by marketplace type

### Response
#### Success Response (200)
- **storeId** (integer) - The unique store ID
- **storeName** (string) - The name of the store
- **marketplaceId** (integer) - The ID of the marketplace
- **marketplaceName** (string) - The name of the marketplace
- **active** (boolean) - Whether the store is active

#### Response Example
[
  {
    "storeId": 12345,
    "storeName": "My Shopify Store",
    "marketplaceId": 36,
    "marketplaceName": "Shopify",
    "active": true
  }
]
```

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

### Create a Theme

Source: https://docs.shipstation.com/apis/shipengine/docs/partners/customize-theme.md

Use the `themes` endpoint to create a new theme. You can create a maximum of 10 themes per partner. This endpoint allows customization of various onboarding elements like brand name, logo, start screen titles and text, and completion screen details.

```APIDOC
## POST /v1/partners/themes

### Description
Creates a new theme to customize the onboarding experience for your customers. A maximum of 10 themes can be created per partner.

### Method
POST

### Endpoint
`/v1/partners/themes`

### Request Body
- **name** (string) - Required - The name of the theme.
- **brand** (string) - Required - The brand name to display.
- **return_url** (string) - Required - The URL to return to after onboarding is complete.
- **logo** (object) - Required - The logo image details.
  - **content_type** (string) - Required - The MIME type of the logo image (e.g., `image/png`).
  - **image_data** (string) - Required - The base64 encoded image data.
- **onboarding** (object) - Optional - Customization for onboarding screens.
  - **start_title** (string) - Optional - The title for the onboarding start screen.
  - **start_text** (string) - Optional - The text for the onboarding start screen.
  - **complete_title** (string) - Optional - The title for the onboarding completion screen.
  - **complete_text** (string) - Optional - The text for the onboarding completion screen.
  - **skip_shipstation_api_carriers** (boolean) - Optional - Whether to skip ShipStation API carriers.

### Request Example
```json
{
  "name": "My theme",
  "brand": "Auctane brand",
  "return_url": "https://mydomain.com",
  "logo": {
    "content_type": "image/png",
    "image_data": "iVBORw0KGgoAAAANSUhEUg..."
  },
  "onboarding": {
    "start_title": "Start shippping today!",
    "start_text": "Simply follow the steps to configure your carriers.",
    "complete_title": "You are done!",
    "complete_text": "Click continue to start shipping.",
    "skip_shipstation_api_carriers": false
  }
}
```

### Response
#### Success Response (200)
- **theme_id** (string) - The unique identifier for the created theme.
- **name** (string) - The name of the theme.
- **brand** (string) - The brand name.
- **return_url** (string) - The return URL.
- **logo** (object) - The logo details.
  - **content_type** (string) - The MIME type of the logo image.
  - **image_data** (string) - The base64 encoded image data.
- **onboarding** (object) - The onboarding customization details.
  - **start_title** (string) - The title for the onboarding start screen.
  - **start_text** (string) - The text for the onboarding start screen.
  - **complete_title** (string) - The title for the onboarding completion screen.
  - **complete_text** (string) - The text for the onboarding completion screen.
  - **skip_shipstation_api_carriers** (boolean) - Whether to skip ShipStation API carriers.
- **created_at** (string) - The timestamp when the theme was created.
- **modified_at** (string) - The timestamp when the theme was last modified.

#### Response Example
```json
{
  "theme_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My theme",
  "brand": "Auctane brand",
  "return_url": "https://mydomain.com",
  "logo": {
    "content_type": "image/png",
    "image_data": "iVBORw0KGgoAAAANSUhEUg..."
  },
  "onboarding": {
    "start_title": "Start shippping today!",
    "start_text": "Simply follow the steps to configure your carriers.",
    "complete_title": "You are done!",
    "complete_text": "Click continue to start shipping.",
    "skip_shipstation_api_carriers": false
  },
  "created_at": "2024-01-25T03:06:20.933Z",
  "modified_at": "2024-01-25T03:06:20.933Z"
}
```
```

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

### Download Manifest PDF using HTTP GET

Source: https://docs.shipstation.com/apis/shipengine/docs/shipping/manifests/create-a-manifest.md

This example demonstrates how to programmatically download a manifest PDF using an HTTP GET request. Ensure the `Accept-Type` header is set to `application/pdf`.

```http
GET https://api.shipengine.com/v1/downloads/0/BpP_fo0d9EiiQJ7hqDQGmA/manifest-11112.pdf HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Accept-Type: application/pdf
```

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

### Initialize Account Settings with SDK

Source: https://docs.shipstation.com/apis/shipengine/docs/elements/account-settings/account-settings

This JavaScript snippet demonstrates how to create an instance of the Elements SDK and then instantiate the Account Settings element. It requires a getToken function and allows for feature configuration.

```js
// Creates a new instance of the Elements SDK.
const elements = new ElementsSDK(getToken, {
  onError: (err: Error) => console.error(err),
  themeConfig: themeConfig,
  locale: 'en-US',
  features: {
    globalFeatures: {
      // The list of all ShipEngine carriers available to be activated
      enabledShipEngineCarriers: ['stamps_com', 'dhl_express_worldwide'],
      // The list of external carriers that are available to be activated
      enabledExternalCarriers: [
        'apc',
        'asendia',
        'better_trucks',
        'courierpost',
        'dpd',
        'seko',
        'ups',
        'yodel',
      ],
    },
    accountSettingsFeatures: {
      showLabelLayout: false,
    },
  },
});

const accountSettings = elements.create('accountSettings');

```

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

### Download a Manifest

Source: https://docs.shipstation.com/apis/shipengine/docs/shipping/manifests/create-a-manifest.md

This example demonstrates how to download a manifest PDF using the provided URL. Ensure the `Accept-Type` header is set to `application/pdf`.

```APIDOC
## Download the Manifest

This example downloads the manifest using the URL returned in the response above. Notice that you
must change the `Content-Type` to `Accept-type: application/pdf`.

### Example Request

```http
GET https://api.shipengine.com/v1/downloads/0/BpP_fo0d9EiiQJ7hqDQGmA/manifest-11102.pdf HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Accept-Type: application/pdf
```
```

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

### List Freight Shipments Response

Source: https://docs.shipstation.com/apis/shipengine/docs/freight/freight-manage.md

Example JSON response structure returned by the GET /v1/freight/shipments endpoint.

```json
{
  "shipments": [
    {
      "freight_shipment_id": "se-98765432",
      "freight_provider_account_id": "se-4821",
      "freight_provider_name": "UNISHIPPERS",
      "status": "in_transit",
      "bol_number": "BOL-20260417-4821",
      "pro_number": "072-51293847",
      "documents": [
        {
          "type": "bill_of_lading",
          "url": "/v1/downloads/10/a1b2c3d4e5f6/bill_of_lading.pdf"
        }
      ]
    }
  ],
  "total": 137,
  "page": 1,
  "page_size": 25,
  "pages": 6
}
```

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

### Initialize Unit Settings with Elements SDK

Source: https://docs.shipstation.com/apis/shipengine/docs/elements/account-settings/unit-settings

This snippet demonstrates how to create a new instance of the Elements SDK and then create a 'unitSettings' component. It requires a getToken function and an optional configuration object for error handling, theme, and locale.

```js
// Creates a new instance of the Elements SDK.
const elements = new ElementsSDK(getToken, {
  onError: (err: Error) => console.error(err),
  themeConfig: themeConfig,
  locale: 'en-US',
});

const unitSettings = elements.create('unitSettings');

```

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

### Manifest Creation Response

Source: https://docs.shipstation.com/apis/shipengine/docs/shipping/manifests/create-a-manifest.md

This is an example response after creating a manifest. It includes details about the manifest, such as its ID, creation date, and a download link.

```json
{
  "manifests": [
    {
      "manifest_id": "se-11118",
      "form_id": "se-11118",
      "created_at": "2020-11-09T18:21:10.59Z",
      "ship_date": "2020-11-09T00:00:00Z",
      "shipments": 3,
      "label_ids": [
        "se-29602037",
        "se-29544722",
        "se-29475869"
      ],
      "warehouse_id": null,
      "submission_id": "1120014041604946070483",
      "carrier_id": "se-88270",
      "manifest_download": {
        "href": "https://api-stage.shipengine.com/v1/downloads/0/pj37Bb5hi0qdslHc7_wCVQ/manifest-11118.pdf"
      }
    }
  ],
  "manifest_requests": [
    {
      "manifest_request_id": "se-28529731",
      "status": "in_progress"
    }
  ],
    "manifest_id": "se-11118",
    "form_id": "se-11118",
    "created_at": "2020-11-09T18:21:10.59Z",
    "ship_date": "2020-11-09T00:00:00Z",
    "shipments": 1,
    "warehouse_id": null,
    "submission_id": "1120014041604946070483",
    "carrier_id": "se-88270",
    "manifest_download": {
     "href": "https://api-stage.shipengine.com/v1/downloads/0/pj37Bb5hi0qdslHc7_wCVQ/manifest-11118.pdf"
    },
    "label_ids": [
      "se-29602037",
      "se-29544722",
      "se-29475869"
    ],
    "request_id": "7de36d42-8343-4247-95ce-153d8b615d1f",
    "errors": []
}
```

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

### List Sales Orders HTTP Request

Source: https://docs.shipstation.com/apis/shipengine/docs/reference/list-sales-orders.md

Example of a GET request to the sales_orders endpoint with query parameters for filtering and pagination.

```http
GET /v-beta/sales_orders?order_source_id=__YOUR_ORDER_SOURCE_ID_HERE__&sort_dir=desc&sort_by=order_date&page=1&page_size=1 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
```

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

### Response with Multiple Manifests Example

Source: https://docs.shipstation.com/apis/shipengine/docs/shipping/manifests/create-a-manifest.md

This JSON response shows an example where multiple manifests are generated. Each manifest object includes a download URL and the specific label IDs it contains. A top-level href is also provided for the first manifest.

```json
{
  "manifests": [
    {
      "manifest_id": "se-11116",
      "form_id": "se-11116",
      "created_at": "2020-11-09T18:16:09.793Z",
      "ship_date": "2020-11-09T00:00:00Z",
      "shipments": 1,
      "label_ids": [
        "se-1050621"
      ],
      "warehouse_id": null,
      "submission_id": "9475711201080306528571",
      "carrier_id": "se-82785",
      "manifest_download": {
        "href": "https://api-stage.shipengine.com/v1/downloads/0/mQ3QZQL6-0SLESTz43Y8vw/manifest-11116.pdf"
      }
    },
    {
      "manifest_id": "se-11117",
      "form_id": "se-11117",
      "created_at": "2020-11-09T18:16:11.233Z",
      "ship_date": "2020-11-09T00:00:00Z",
      "shipments": 1,
      "label_ids": [
        "se-1050622"
      ],
      "warehouse_id": null,
      "submission_id": "1120014041604945770433",
      "carrier_id": "se-88270",
      "manifest_download": {
        "href": "https://api-stage.shipengine.com/v1/downloads/0/5GOUrT4TRkWgygJyvJt0kA/manifest-11117.pdf"
      }
    }
  ],
    "manifest_requests": [
     {
      "manifest_request_id": "se-28529731",
      "status": "in_progress"
     }
    ],
  "manifest_id": "se-11116",
  "form_id": "se-11116",
  "created_at": "2020-11-09T18:16:09.793Z",
  "ship_date": "2020-11-09T00:00:00Z",
  "shipments": 1,
  "warehouse_id": null,
  "submission_id": "9475711201080306528571",
  "carrier_id": "se-82785",
  "manifest_download": {
    "href": "https://api-stage.shipengine.com/v1/downloads/0/mQ3QZQL6-0SLESTz43Y8vw/manifest-11116.pdf"
  },
  "label_ids": [
    "se-1050621",
    "se-1050622"
  ],
  "request_id": "9367f24f-9aa6-4358-8dd7-a73bb38e8870",
  "errors": []
}
```

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

### List Shipments Request and Response

Source: https://docs.shipstation.com/apis/shipengine/docs/reference/list-shipments.md

An example of a GET request to retrieve shipments filtered by a tag, followed by the successful JSON response.

```http
GET /v1/shipments?tag=east_warehouse&page=1&page_size=1&sort_dir=desc&sort_by=created_at HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
```

```json
{
  "shipments": [
    {
      "shipment_id": "se-2102034",
      "carrier_id": "",
      "external_shipment_id": "1daa0c22-0519-46d0-8653-9f3dc62e7d2c",
      "ship_date": "2019-07-25T05:00:00.000Z",
      "created_at": "2019-07-25T15:24:46.657Z",
      "modified_at": "2019-07-25T15:24:46.657Z",
      "shipment_status": "pending",
      "ship_to": {
        "name": "Amanda Miller",
        "phone": "555-555-5555",
        "email": "recipient@example.com",
        "address_line1": "525 S Winchester Blvd",
        "city_locality": "San Jose",
        "state_province": "CA",
        "postal_code": "95128",
        "country_code": "US",
        "address_residential_indicator": "yes"
      },
      "ship_from": {
        "company_name": "Example Corp.",
        "name": "John Doe",
        "phone": "111-111-1111",
        "email": "sender@example.com",
        "address_line1": "4009 Marathon Blvd",
        "address_line2": "Suite 300",
        "city_locality": "Austin",
        "state_province": "TX",
        "postal_code": "78756",
        "country_code": "US",
        "address_residential_indicator": "no"
      },
      "return_to": {
        "company_name": "Example Corp.",
        "name": "John Doe",
        "phone": "111-111-1111",
        "address_line1": "4009 Marathon Blvd",
        "address_line2": "Suite 300",
        "city_locality": "Austin",
        "state_province": "TX",
        "postal_code": "78756",
        "country_code": "US",
        "address_residential_indicator": "no"
      },
      "confirmation": "none",
      "advanced_options": {
        "bill_to_account": null,
        "bill_to_country_code": null,
        "bill_to_party": null,
        "bill_to_postal_code": null,
        "contains_alcohol": false,
        "custom_field1": null,
        "custom_field2": null,
        "custom_field3": null,
        "non_machinable": false,
        "saturday_delivery": false
      },
      "insurance_provider": "",
      "tags": [
        {
          "name": "east_warehouse"
        }
      ],
      "total_weight": {
        "value": 9.60,
        "units": "ounce"
      },
      "packages": [
        {
          "weight": {
            "value": 9.60,
            "units": "ounce"
          },
          "dimensions": {
            "units": "inch",
            "length": 12.00,
            "width": 7.10,
            "height": 6.00
          },
          "insured_value": {
            "currency": "usd",
            "amount": 0.0
          }
        }
      ]
    }
  ],
  "total": 1,
  "page": 1,
  "pages": 2,
  "links": {
    "first": {
      "href": "https://api.shipengine.com/v1/shipments?tag=east_warehouse&shipment_status=any&sort_dir=desc&sort_by=created_at&page=1&page_size=1"
    },
    "last": {
      "href": "https://api.shipengine.com/v1/shipments?tag=east_warehouse&shipment_status=any&sort_dir=desc&sort_by=created_at&page=2&page_size=1"
    },
    "prev": {},
    "next": {
      "href": "https://api.shipengine.com/v1/shipments?tag=east_warehouse&shipment_status=any&sort_dir=desc&sort_by=created_at&page=2&page_size=1"
    }
  }
}
```

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

### Initialize Elements SDK and Create Label Workflow

Source: https://docs.shipstation.com/apis/shipengine/docs/elements/label-workflow/label-workflow

This snippet demonstrates how to initialize the Elements SDK with configuration options and then create a Label Workflow element. It includes setting up global features, purchase label features, and shipment summary features, along with defining callbacks for various events.

```javascript
const elements = new ElementsSDK(getToken, {
  onError: (err: Error) => console.error(err),
  themeConfig: themeConfig,
  locale: 'en-US',
  features: {
    globalFeatures: {
      // The list of all ShipEngine carriers available to be activated
      enabledShipEngineCarriers: ['ups', 'stamps_com'],
    },
    purchaseLabelFeatures: {
      rateForm: { enableFunding: true },
      shipmentForm: { shippingPresets: true },
    },
    shipmentSummaryFeatures: {
      schedulePickup: true,
    },
  },
});

const labelWorkflow = elements.create('labelWorkflow', {
  multiplexedId: {
    shipmentId: 'se-4352331',
  },
  onViewShipment: () => console.log('go to shipment summary.'),
  onVoidLabelSuccess: () => console.log('Label Voided!'),
  onLabelCreateSuccess: () => console.log('Label Purchased!'),
});
```

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

### Quick Rates Request Example

Source: https://docs.shipstation.com/apis/shipengine/docs/rates/advanced-features.md

This example demonstrates a POST request to the /v1/rates endpoint using the 'quick' rate_type. It includes shipment details and specifies carrier IDs for rate retrieval.

```http
POST /v1/rates/ HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
    "rate_options": {
        "rate_type": "quick",
        "carrier_ids": [
            "se-12345"
        ]
    },
    "shipment": {
        "ship_to": {
            "name": "The President",
            "phone": "222-333-4444",
            "company_name": "",
            "address_line1": "1600 Pennsylvania Avenue NW",
            "city_locality": "Washington",
            "state_province": "DC",
            "postal_code": "20500",
            "country_code": "US",
            "address_residential_indicator": "no"
        },
        "ship_from": {
            "name": "ShipStation API Team",
            "phone": "222-333-4444",
            "company_name": "ShipStation API",
            "address_line1": "4301 Bull Creek Road",
            "city_locality": "Austin",
            "state_province": "TX",
            "postal_code": "78731",
            "country_code": "US",
            "address_residential_indicator": "no"
        },
        "packages": [
            {
                "package_code": "package",
                "weight": {
                    "value": 6,
                    "unit": "ounce"
                }
            }
        ]
    }
}
```
Tokens:
Raw