Rock Solid Internet eCommerce API

https://shipping.rocksolidinternet.com/restapi/
Admin
Rock Solid Internet eCommerce API enables integration with Shopping Cart, ERP, and Accounting...
Tokens:21,992
Snippets:96
Trust Score:7.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Request Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/retrieve-shipments

A concrete example of a GET request for a specific customer.

```http
GET /restapi/v1/customers/TEST00002/shipments?minBookNumber=2317947&limit=100
```

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

### List Services Request Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/list-services

Example of a GET request to the list services endpoint for a specific customer ID.

```http
GET /restapi/v1/customers/TEST00002/services
```

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

### Example Get Orders Query

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/odbc/get-orders-query

This SQL query demonstrates how to select order data from SalesOrder, Address, and OrderItem tables, mapping them to the required Webship field names. Ensure your query filters for orders ready to be shipped.

```sql
SELECT
  SalesOrder.ID AS orderId,
  SalesOrder.InvoiceNumber AS orderNumber,
  SalesOrder.OrderDate AS orderDate,
  SalesOrder.ShippingMethod AS shippingService,
  CONCAT(Address.FirstName, ' ' , Address.LastName) AS name,
  Address.Company AS company,
  Address.Address1 AS address1,
  Address.Address2 AS address2,
  Address.Address3 AS address3,
  Address.City AS city,
  Address.StateOrProvince AS state,
  Address.PostalCode AS zip,
  Address.CountryCode AS country,
  OrderItem.SKU AS itemSku,
  OrderItem.Title AS itemTitle,
  OrderItem.Quantity AS itemQuantity,
  OrderItem.UnitPrice AS itemPrice,
  OrderItem.UnitWeight AS itemWeight
FROM
  SalesOrder, Address, OrderItem
WHERE
  SalesOrder.OrderStatus = 'Processing'
AND
  Address.ID = SalesOrder.AddressID
AND
  OrderItem.SalesOrderID = SalesOrder.ID

```

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

### Response JSON Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/webhooks/get-order

This is an example of the JSON structure returned by the Get Order endpoint, containing details of a single order.

```json
{
    "order": {
        "orderId": "5210320",
        "status": "pending",
        "dueByDate": "2015-11-30",
        "orderNumber": null,
        "orderDate": 1444148650,
        "receiver": {
            "name": "Al Borland",
            "address1": "4020 N Williams Ave",
            "city": "Claremont",
            "state": "California",
            "zip": 91711,
            "country": "US",
            "phone": "8888881234"
        },
        "shippingService": "Priority Overnight",
        "shipping_total": "15.89",
        "weightUnit": "lb",
        "items": [
            {
                "productId": "1234",
                "sku": "1234",
                "title": "Wiffle Balls",
                "price": "9.99",
                "quantity": "3",
                "weight": "5",
                "imgUrl": "http://example.com/balls.jpg"
            },
            {
                "productId": "4321",
                "sku": "4321",
                "title": "Junk",
                "price": "4.99",
                "quantity": "20",
                "weight": "2",
                "imgUrl": "http://example.com/junk.jpg"
            },
            {
                "productId": "777",
                "sku": "777",
                "title": "Lucky",
                "price": ".77",
                "quantity": "1",
                "weight": "7",
                "imgUrl": null
            }
        ]
    }
}
```

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

### Retrieve Shipment Request Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/retrieve-shipment

Example of a GET request to retrieve a specific shipment.

```http
GET /restapi/v1/customers/TEST00002/shipments/2317948
```

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

### Request JSON Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/quote

An example of the request payload and the corresponding endpoint call.

```text
POST /restapi/v1/customers/TEST00002/quote
```

```json
{
  "carrierCode": "ups",
  "serviceCode": "ups_ground",
  "packageTypeCode": "ups_custom_package",
  "sender": {
    "country": "US",
    "zip": "84117"
  },
  "receiver": {
    "city": "Salt Lake City",
    "country": "US",
    "zip": "84106",
    "email":"foo@bar.com"
  },
  "residential": true,
  "signatureOptionCode": "DIRECT",
  "contentDescription": "stuff and things",
  "weightUnit": "lb",
  "dimUnit": "in",
  "currency": "USD",
  "customsCurrency": "USD",
  "pieces": [
    {
      "weight": "1.4",
      "length": "5.1",
      "width": "4",
      "height": "2.5",
      "insuranceAmount": "12.15",
      "declaredValue": null
    }
  ],
  "billing": {
    "party": "sender"
  },
  "providerAccountId": null
}
```

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

### Request JSON Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/assign-tags-to-order

An example payload containing an array of tag IDs to be assigned.

```json
{
    "tagIds": [
      "1234",
      "4567"
    ]
}
```

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

### Integrated Quoting Options Request Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/list-integrated-quoting-options

Example request targeting a specific customer ID.

```http
GET /restapi/v1/customers/TEST00002/integratedQuotingOptions
```

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

### Response JSON Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/quote

An example of the JSON response returned after a successful quote request.

```json
{
  "carrierCode": "ups",
  "serviceCode": "ups_ground",
  "packageTypeCode": "ups_custom_package",
  "currency": "USD",
  "customsCurrency": "USD",
  "totalAmount": "16.27",
  "baseAmount": "12.15",
  "surcharges": [
    {
      "description": "Residential surcharge",
      "amount": "4.12"
    }
  ],
  "zone": "2",
  "quotedWeight": "2",
  "quotedWeightType": "Actual"
}
```

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

### Request POST Body Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/webhooks/update-order

This example demonstrates the format of the POST body for updating an order. It is form-urlencoded and includes order details, items, receiver information, and quote details.

```HTTP
orderId=12345
&carrier=ups
&trackingNumbers=AAAA,BBBB,CCCC
&items[0][id]=1234
&items[0][quantity]=2
&items[1][id]=4321
&items[1][quantity]=1
&receiver[company]=Rocksolid+Internet
&receiver[name]=Al+Borland
&receiver[address1]=1880+FooBar+Dr
&receiver[address2]=
&receiver[city]=La+Cucaracha
&receiver[state]=California
&receiver[zip]=91711
&receiver[country]=US
&receiver[phone]=8888881234
&receiver[email]=foo@bar.com
```

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

### List Services Response JSON Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/list-services

Example JSON response detailing available shipping services, including carrier and package type information.

```json
{
  "services": [
    {
      "carrierCode": "ups",
      "carrierLabel": "UPS",
      "serviceCode": "ups_ground",
      "serviceLabel": "UPS Ground",
      "inbound": false,
      "supportedCountries": ["US"],
      "unsupportedCountries": null,
      "signatureOptions": [
        {
          "signatureOptionCode": "direct",
          "signatureOptionLabel": "Signature Required"
        },
        {
          "signatureOptionCode": "adult",
          "signatureOptionLabel": "Adult Signature Required"
        }
      ],
      "supportedDangerousGoodsCodes": null,
      "packageTypes": [
        {
          "packageTypeCode": "ups_large_box",
          "packageTypeLabel": "UPS Large Box",
          "multipieceSupported": true,
          "weightUnit": "lb",
          "maxWeightPerPiece": "40.0",
          "dimType": "preset",
          "dimUnit": "in",
          "presetLength": "10",
          "presetWidth": "5",
          "presetHeight": "5"
        },
        {
          "packageTypeCode": "customer_packaging",
          "packageTypeLabel": "Customer Supplied Packaging",
          "multipieceSupported": true,
          "weightUnit": "lb",
          "maxWeightPerPiece": "105.25",
          "dimType": "custom",
          "dimUnit": null,
          "presetLength": null,
          "presetWidth": null,
          "presetHeight": null
        }
      ]
    },
    {
      "carrierCode": "dhl",
      "carrierLabel": "DHL",
      "serviceCode": "dhl_express_worldwide",
      "serviceLabel": "DHL Express Worldwide",
      "inbound": false,
      "supportedCountries": null,
      "unsupportedCountries": ["US"],
      "signatureOptions": [
        {
          "signatureOptionCode": "direct",
          "signatureOptionLabel": "Signature Required"
        }
      ],
      "supportedDangerousGoodsCodes": null,
      "packageTypes": [
        {
          "packageTypeCode": "customer_packaging",
          "packageTypeLabel": "Customer Supplied Packaging",
          "multipieceSupported": true,
          "weightUnit": "kg",
          "maxWeightPerPiece": "50.00",
          "dimType": "custom",
          "dimUnit": null,
          "presetLength": null,
          "presetWidth": null,
          "presetHeight": null
        }
      ]
    }
  ]
}
```

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

### List Order Tags JSON Response Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/list-order-tags

Example structure of the JSON response containing a list of tag objects.

```json
{
  "tags" : [
    {
        "id": "1234567890",
        "tagName": "test tag 2",
        "tagColor": "#e91e63"
    }
  ]
}
```

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

### Response JSON Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/assign-tags-to-order

The standard JSON response indicating success.

```json
{
  "ok": true
}
```

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

### Request JSON Example for Put Order

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/put-order

This is an example of the JSON payload required for the Put Order endpoint. It includes order details, sender, receiver, items, and package information.

```json
{
  "orderId": "123ABC",
  "orderDate": "2016-04-24",
  "orderNumber": "abc123",
  "fulfillmentStatus": "pending",
  "shippingService": "Standard",
  "shippingTotal": "8.24",
  "weightUnit": "lb",
  "dimUnit": "in",
  "dueByDate": "2016-04-26",
  "orderGroup": "Workstation 1",
  "contentDescription": "Stuff and things",
  "sender": {
    "name": "Albert Jones",
    "company": "Jones Co.",
    "address1": "123 Some Street",
    "address2": "#54",
    "city": "Holladay",
    "state": "UT",
    "zip": "84117",
    "country": "US",
    "phone": "8015042351",
    "email": "albert@jones.egg"
  },
  "returnTo": {
    "name": "Steve Smith",
    "company": "Smith Co.",
    "address1": "123 A street",
    "address2": "Apt 7",
    "city": "American Fork",
    "state": "UT",
    "zip": "84115",
    "country": "US",
    "phone": "8015555555",
    "email": "steve@smith.egg"
  },
  "receiver": {
    "name": "Alice Janson",
    "company": "",
    "address1": "54 Green St.",
    "address2": "",
    "city": "Salt Lake City",
    "state": "UT",
    "zip": "84106",
    "country": "US",
    "phone": "8013920046",
    "email": "alice@jensen.egg"
  },
  "items": [
    {
      "productId": "856673",
      "sku": "ade3-fe21-bb9a",
      "title": "Socks",
      "price": "3.99",
      "quantity": 2,
      "weight": "0.5",
      "imgUrl": "http://sockstore.egg/img/856673",
      "htsNumber": "555555",
      "countryOfOrigin": "US",
      "lineId": "1",
      "pickLocation": "100-03S"
    }
  ],
  "packages": [
    {
      "weight": "0.5",
      "length": "6",
      "width": "5",
      "height": "2.5",
      "insuranceAmount": null,
      "declaredValue": null
    }
  ]
}
```

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

### Retrieve Shipment Response JSON Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/retrieve-shipment

Example JSON response for a successful shipment retrieval. Includes details about the shipment, sender, receiver, and costs.

```json
{
  "bookNumber": "2317948",
  "trackingNumber": "1ZA3R6625221693812",
  "trackingNumbers": ["1ZA3R6625221693812"],
  "voided": false,
  "carrierCode": "ups",
  "serviceCode": "ups_ground",
  "packageTypeCode": "ups_custom_package",
  "shipmentDate": "2015-04-21",
  "shipmentReference": "abc123",
  "contentDescription": "",
  "sender": {
    "name": "Albert Jones",
    "company": "Jones Co.",
    "address1": "123 Some Street",
    "address2": "#54",
    "city": "Holladay",
    "state": "UT",
    "zip": "84117",
    "country": "US"
  },
  "receiver": {
    "name": "Alice Jensen",
    "company": "",
    "address1": "54 Green St.",
    "address2": "",
    "city": "Salt Lake City",
    "state": "UT",
    "zip": "84106",
    "country": "US"
  },
  "residential": true,
  "signatureOptionCode": "direct",
  "weightUnit": "lb",
  "dimUnit": "in",
  "currency": "USD",
  "customsCurrency": "USD",
  "pieces": [
    {
      "weight": "1.4",
      "length": "5.1",
      "width": "4",
      "height": "2.5",
      "insuranceAmount": "12.15",
      "declaredValue": null
    }
  ],
  "fulfillment": null,
  "totalShippingCost": 8.75
}
```

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

### Get Order REST Endpoint

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/webhooks/get-order

Use this GET endpoint to retrieve an order from your system. Include the order ID as a query parameter.

```http
GET [/your-custom-get-order-endpoint]?orderId=[orderId]
```

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

### Response JSON Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/retrieve-shipments

The structure of the JSON object returned by the API containing shipment details.

```json
{
  "shipments": [
    {
      "bookNumber": "2317948",
      "trackingNumber": "1ZA3R6625221693812",
      "trackingNumbers": ["1ZA3R6625221693812"],
      "voided": false,
      "carrierCode": "ups",
      "serviceCode": "ups_ground",
      "packageTypeCode": "ups_custom_package",
      "shipmentDate": "2015-04-21",
      "shipmentReference": "abc123",
      "contentDescription": "",
      "sender": {
        "name": "Albert Jones",
        "company": "Jones Co.",
        "address1": "123 Some Street",
        "address2": "#54",
        "city": "Holladay",
        "state": "UT",
        "zip": "84117",
        "country": "US"
      },
      "receiver": {
        "name": "Alice Jensen",
        "company": "",
        "address1": "54 Green St.",
        "address2": "",
        "city": "Salt Lake City",
        "state": "UT",
        "zip": "84106",
        "country": "US"
      },
      "residential": true,
      "signatureOptionCode": "direct",
      "weightUnit": "lb",
      "dimUnit": "in",
      "currency": "USD",
      "customsCurrency": "USD",
      "pieces": [
        {
          "weight": "1.4",
          "length": "5.1",
          "width": "4",
          "height": "2.5",
          "insuranceAmount": "12.15",
          "declaredValue": null
        }
      ],
      "fulfillment": null,
      "totalShippingCost": 8.75
    },
    ...
  ]
|
```

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

### Search Shipments Response Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/search-shipments

The response contains a list of shipments matching the search criteria, with a maximum of 100 results. Includes details like tracking numbers, sender/receiver information, and shipping costs.

```json
{
  "shipments": [
    {
      "bookNumber": "2317948",
      "trackingNumber": "1ZA3R6625221693812",
      "trackingNumbers": ["1ZA3R6625221693812"],
      "voided": false,
      "carrierCode": "ups",
      "serviceCode": "ups_ground",
      "packageTypeCode": "ups_custom_package",
      "shipmentDate": "2015-04-21",
      "shipmentReference": "abc123",
      "contentDescription": "",
      "sender": {
        "name": "Albert Jones",
        "company": "Jones Co.",
        "address1": "123 Some Street",
        "address2": "#54",
        "city": "Holladay",
        "state": "UT",
        "zip": "84117",
        "country": "US"
      },
      "receiver": {
        "name": "Alice Jensen",
        "company": "",
        "address1": "54 Green St.",
        "address2": "",
        "city": "Salt Lake City",
        "state": "UT",
        "zip": "84106",
        "country": "US"
      },
      "residential": true,
      "signatureOptionCode": "direct",
      "weightUnit": "lb",
      "dimUnit": "in",
      "currency": "USD",
      "customsCurrency": "USD",
      "pieces": [
        {
          "weight": "1.4",
          "length": "5.1",
          "width": "4",
          "height": "2.5",
          "insuranceAmount": "12.15",
          "declaredValue": null
        }
      ],
      "fulfillment": null,
      "totalShippingCost": 8.75,
      "orderIds": [
        "000111222",
        "000111223"
      ]
    }
  ]
}
```

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

### List Orders

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/webhooks/list-orders

Retrieves a list of orders ready for shipping. This endpoint is called via a GET request.

```APIDOC
## GET [/your-custom-list-orders-endpoint]

### Description
Retrieves a JSON structure containing an array of orders that are ready to be shipped.

### Method
GET

### Endpoint
[/your-custom-list-orders-endpoint]

### Response
#### Success Response (200)
- **orderId** (string) - Unique order id
- **orderNumber** (string or null) - Order number shown to customer
- **orderDate** (unix-timestamp) - Date order was placed
- **customerNotes** (string) - Notes provided by customer
- **dueByDate** (YYYY-MM-DD) - (optional) Date that will show up in the order list of the ship screen
- **currency** (string) - AUD, EUR, etc. Will appear on commercial invoices and packing slips (default is USD)
- **sender** (object) - sender address
  - **company** (string) - Sender company name
  - **name** (string) - Sender name
  - **address1** (string) - First line of sender address
  - **address2** (string) - Second line of sender address
  - **city** (string) - Sender city
  - **state** (string) - Sender state
  - **zip** (string) - Sender zip code
  - **country** (string) - Two character country code
  - **phone** (string) - Ten digit phone number
  - **email** (string) - Sender email
- **receiver** (object) - receiver address
  - **company** (string) - Receiver company name
  - **name** (string) - Receiver name
  - **address1** (string) - First line of receiver address
  - **address2** (string) - Second line of receiver address
  - **city** (string) - Receiver city
  - **state** (string) - Receiver state
  - **zip** (string) - Receiver zip code
  - **country** (string) - Two character country code
  - **phone** (string) - Ten digit phone number
  - **email** (string) - Receiver email
- **returnTo** (object) - return to address (optional)
  - **company** (string) - Return to company name
  - **name** (string) - Return to name
  - **address1** (string) - First line of return to address
  - **address2** (string) - Second line of return to address
  - **city** (string) - Return to city
  - **state** (string) - Return to state
  - **zip** (string) - Return to zip code
  - **country** (string) - Two character country code
  - **phone** (string) - Ten digit phone number
  - **email** (string) - Return to email
- **shippingService** (string or null) - Shipping service selected (used for shipping service mapping and shows up on ship screen when order is selected)
- **shipperReference** (string or null) - Text that will show up on shipping label in the reference field. If nothing is specified, order number will be used. If no order number exists, order id will be used
- **shipping_total** (decimal-as-string or null) - Customer cost of shipping
- **weightUnit** ("kg" or "lb" or null) - weight unit of each item
- **items** (array) - items in order
  - **productId** (string or null) - product id
  - **sku** (string or null) - product sku
  - **title** (string or null) - product title
  - **price** (decimal-as-string or null) - item price
  - **quantity** (positive-integer or null) - item quantity
  - **weight** (decimal-as-string or null) - item weight
  - **imgUrl** (string or null) - item image url
- **packages** (array) - packages in order
  - **weight** (decimal-as-string or null) - package weight
  - **length** (decimal-as-string or null) - package length
  - **width** (decimal-as-string or null) - package width
  - **height** (decimal-as-string or null) - package height
  - **insuranceAmount** (decimal-as-string or null) - package insuranceAmount
  - **declaredValue** (decimal-as-string or null) - package declaredValue

#### Response Example
```json
{
  "orderId": "12345",
  "orderNumber": "ORD-67890",
  "orderDate": 1678886400,
  "customerNotes": "Please deliver by Friday.",
  "dueByDate": "2023-03-20",
  "currency": "USD",
  "sender": {
    "company": "RockSolid Internet",
    "name": "John Doe",
    "address1": "123 Main St",
    "address2": null,
    "city": "Anytown",
    "state": "CA",
    "zip": "90210",
    "country": "US",
    "phone": "5551234567",
    "email": "john.doe@rocksolid.com"
  },
  "receiver": {
    "company": "Customer Inc",
    "name": "Jane Smith",
    "address1": "456 Oak Ave",
    "address2": "Apt 101",
    "city": "Otherville",
    "state": "NY",
    "zip": "10001",
    "country": "US",
    "phone": "5559876543",
    "email": "jane.smith@customer.com"
  },
  "returnTo": {
    "company": "RockSolid Internet Returns",
    "name": "Returns Dept",
    "address1": "789 Pine Ln",
    "address2": null,
    "city": "Warehouse City",
    "state": "TX",
    "zip": "75001",
    "country": "US",
    "phone": "5551112222",
    "email": "returns@rocksolid.com"
  },
  "shippingService": "Express",
  "shipperReference": "ORD-67890",
  "shipping_total": "15.50",
  "weightUnit": "lb",
  "items": [
    {
      "productId": "P100",
      "sku": "SKU-A1",
      "title": "Widget",
      "price": "25.00",
      "quantity": 2,
      "weight": "1.5",
      "imgUrl": "http://example.com/img/widget.jpg"
    }
  ],
  "packages": [
    {
      "weight": "3.5",
      "length": "12",
      "width": "10",
      "height": "5",
      "insuranceAmount": "50.00",
      "declaredValue": "50.00"
    }
  ]
}
```
```

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

### Search Shipments Request Example

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/search-shipments

Send a JSON payload with a 'keyword' field to search for shipments. The keyword can match various fields like tracking number, order ID, etc.

```json
{
  "keyword": "2317948"
}
```

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

### Response JSON Example (PNG)

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/retrieve-shipping-label

This JSON structure is returned when requesting a shipping label in PNG format. It includes the format type and base64 encoded image data.

```JSON
{
  "labelImageFormat": "PNG",
  "base64Images": [
      "....base64 encoded content....",
      "....base64 encoded content...."
  ]
}
```

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

### GET /your-custom-get-order-endpoint

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/webhooks/get-order

Retrieves an updated order from your system for partial fulfillment processing.

```APIDOC
## GET /your-custom-get-order-endpoint

### Description
Retrieves an updated order from your system. This is used by eCommerce Webship when partial fulfillment is enabled.

### Method
GET

### Endpoint
/your-custom-get-order-endpoint?orderId=[orderId]

### Parameters
#### Query Parameters
- **orderId** (string) - Required - The unique identifier for the order.

### Response
#### Success Response (200)
- **order** (object) - The order object containing details like orderId, status, receiver, shippingService, and items.

#### Response Example
{
    "order": {
        "orderId": "5210320",
        "status": "pending",
        "dueByDate": "2015-11-30",
        "orderNumber": null,
        "orderDate": 1444148650,
        "receiver": {
            "name": "Al Borland",
            "address1": "4020 N Williams Ave",
            "city": "Claremont",
            "state": "California",
            "zip": 91711,
            "country": "US",
            "phone": "8888881234"
        },
        "shippingService": "Priority Overnight",
        "shipping_total": "15.89",
        "weightUnit": "lb",
        "items": [
            {
                "productId": "1234",
                "sku": "1234",
                "title": "Wiffle Balls",
                "price": "9.99",
                "quantity": "3",
                "weight": "5",
                "imgUrl": "http://example.com/balls.jpg"
            },
            {
                "productId": "4321",
                "sku": "4321",
                "title": "Junk",
                "price": "4.99",
                "quantity": "20",
                "weight": "2",
                "imgUrl": "http://example.com/junk.jpg"
            },
            {
                "productId": "777",
                "sku": "777",
                "title": "Lucky",
                "price": ".77",
                "quantity": "1",
                "weight": "7",
                "imgUrl": null
            }
        ]
    }
}
```

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

### Shipment Response Fields

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/retrieve-shipments

A reference guide for the fields returned in a shipment object response.

```APIDOC
## Shipment Response Fields

### Description
This document outlines the fields returned in a shipment response object, covering shipment metadata, address details, package dimensions, and fulfillment data.

### Response Fields
- **bookNumber** (string) - Unique ID for this shipment
- **trackingNumber** (string) - Carrier specific tracking number for this shipment
- **trackingNumbers** (array of string) - All tracking numbers (for multi-piece shipments)
- **voided** (boolean) - True if this shipment has been voided
- **carrierCode** (string) - The carrier code
- **serviceCode** (string) - The service code
- **packageTypeCode** (string) - The package type code
- **shipmentDate** (date) - The date of the shipment
- **shipperReference** (string) - Custom reference field provided from the original order
- **shipperReference2** (string) - Another custom reference field provided from the original order
- **contentDescription** (string) - Human readable description of content
- **sender.name** (string) - Name of sender
- **sender.company** (string) - Company name of sender
- **sender.address1** (string) - Sender street address line 1
- **sender.address2** (string) - Sender street address line 2
- **sender.city** (string) - Sender city
- **sender.state** (string) - Sender state/province (must be two-character code for US and CA)
- **sender.zip** (string) - Sender zip or postal code
- **sender.country** (string) - ISO two-character country code
- **receiver.name** (string) - Name of receiver
- **receiver.company** (string) - Company name of receiver
- **receiver.address1** (string) - Receiver street address line 1
- **receiver.address2** (string) - Receiver street address line 2
- **receiver.city** (string) - Receiver city
- **receiver.state** (string) - Receiver state/province (must be two-character code for US and CA)
- **receiver.zip** (string) - Receiver zip or postal code
- **receiver.country** (string) - ISO two-character country code
- **residential** (boolean) - Set to true of the receiver address is residential
- **signatureOptionCode** (string or null) - Signature option code for shipment. Null for no signature
- **weightUnit** (string) - Either "lb" for pounds or "kg" for kilograms
- **dimUnit** (string or null) - Either "in" for inches or "cm" for centimeters or null if packageType has preset dimensions
- **currency** (string) - The currency of the provided insuranceAmount, declaredValue, and customsValue fields. Must be "USD" for shippers in the US
- **customsCurrency** (string) - If present, is the currency of the provided customsValue (USD, GBP, CAD, EUR)
- **pieces[n].weight** (string) - Numeric weight as a JSON string
- **pieces[n].length** (string or null) - Numeric length as a JSON string
- **pieces[n].width** (string or null) - Numeric width as a JSON string
- **pieces[n].height** (string or null) - Numeric height as a JSON string
- **pieces[n].insuranceAmount** (decimal or null) - The value of the piece to be covered by insurance
- **pieces[n].declaredValue** (decimal or null) - The declared value of the piece for international shipments
- **fulfillment.orderId** (string) - ID of order that this shipment is associated with
- **fulfillment.integrationId** (string) - ID of webship integration associated with order
- **fulfillment.items[n].productId** (string) - ID of fulfilled product
- **fulfillment.items[n].sku** (string) - Sku of fulfilled product
- **fulfillment.items[n].lineId** (string) - ID of fulfilled line item
- **fulfillment.items[n].quantity** (integer) - Quantity of items fulfilled
- **fulfillment.items[n].unitPrice** (string) - Unit price of items fulfilled
- **totalShippingCost** (decimal) - Total end-cost of the shipments
```

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

### Retrieve Shipment Endpoint

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/retrieve-shipment

Use this GET endpoint to retrieve a previously booked shipment. Replace :customerId and :bookNumber with your specific values.

```http
GET /restapi/v1/customers/:customerId/shipments/:bookNumber
```

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

### GET /restapi/v1/customers/:customerId/list-tags

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/list-order-tags

Retrieves a list of order tags associated with a specific customer.

```APIDOC
## GET /restapi/v1/customers/:customerId/list-tags

### Description
Use this endpoint to list order tags.

### Method
GET

### Endpoint
/restapi/v1/customers/:customerId/list-tags

### Parameters
#### Path Parameters
- **customerId** (string) - Required - The ID of the customer whose tags are to be listed.

### Response
#### Success Response (200)
- **tags** (array) - A list of tag objects.
  - **id** (string) - The unique identifier for the tag.
  - **tagName** (string) - The name of the tag.
  - **tagColor** (string) - The color associated with the tag in hexadecimal format.

#### Response Example
```json
{
  "tags" : [
    {
        "id": "1234567890",
        "tagName": "test tag 2",
        "tagColor": "#e91e63"
    }
  ]
}
```
```

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

### Keyboard Shortcuts

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/list-order-tags

Keyboard shortcuts for navigating the documentation interface.

```text
?
```

```text
n
```

```text
p
```

```text
s
```

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

### Get Shipping Quotes

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/quote

This endpoint can be used to get a shipping quote for a specific service or to list all available services from carriers. By omitting `serviceCode` and `packageTypeCode`, you can retrieve all services. `carrierCode` is also optional.

```APIDOC
## POST /api/quotes

### Description
Retrieves shipping quotes based on the provided shipment details. Can be used to get a quote for a specific service or to list all available services.

### Method
POST

### Endpoint
/api/quotes

### Request Body
- **carrierCode** (string) - Optional - The carrier code to filter services.
- **serviceCode** (string) - Optional - The specific service code to get a quote for.
- **packageTypeCode** (string) - Optional - The package type code.
- **sender** (object) - Required - Sender's address details.
  - **country** (string) - Required - Sender's country code.
  - **zip** (string) - Required - Sender's zip code.
- **receiver** (object) - Required - Receiver's address details.
  - **city** (string) - Required - Receiver's city.
  - **country** (string) - Required - Receiver's country code.
  - **zip** (string) - Required - Receiver's zip code.
  - **email** (string) - Optional - Receiver's email address.
- **residential** (boolean) - Optional - Indicates if the destination is residential.
- **signatureOptionCode** (string) - Optional - The signature option code.
- **contentDescription** (string) - Optional - Description of the shipment contents.
- **weightUnit** (string) - Required - Unit for weight (e.g., 'lb', 'kg').
- **dimUnit** (string) - Required - Unit for dimensions (e.g., 'in', 'cm').
- **currency** (string) - Required - 3-character currency code for the quote.
- **customsCurrency** (string) - Optional - 3-character currency code for customs.
- **pieces** (array) - Required - Array of package details.
  - **weight** (string) - Required - Weight of the piece.
  - **length** (string) - Optional - Length of the piece.
  - **width** (string) - Optional - Width of the piece.
  - **height** (string) - Optional - Height of the piece.
  - **insuranceAmount** (string) - Optional - Insurance amount for the piece.
  - **declaredValue** (string) - Optional - Declared value for the piece.
- **billing** (object) - Optional - Billing details.
  - **party** (string) - Required - Billing party ('sender' or 'receiver').
- **providerAccountId** (string) - Optional - Your account ID with the provider.

### Request Example
```json
{
  "carrierCode": "ups",
  "serviceCode": "",
  "packageTypeCode": "",
  "sender": {
    "country": "US",
    "zip": "84117"
  },
  "receiver": {
    "city": "Salt Lake City",
    "country": "US",
    "zip": "84106",
    "email":"foo@bar.com"
  },
  "residential": true,
  "signatureOptionCode": "DIRECT",
  "contentDescription": "stuff and things",
  "weightUnit": "lb",
  "dimUnit": "in",
  "currency": "USD",
  "customsCurrency": "USD",
  "pieces": [
    {
      "weight": "1.4",
      "length": "5.1",
      "width": "4",
      "height": "2.5",
      "insuranceAmount": "12.15",
      "declaredValue": null
    }
  ],
  "billing": {
    "party": "sender"
  },
  "providerAccountId": null
}
```

### Response
#### Success Response (200)
- **quotes** (array) - An array of shipping quotes.
  - **carrierCode** (string) - The carrier code.
  - **serviceCode** (string) - The service code.
  - **serviceDescription** (string) - The service description.
  - **packageTypeCode** (string) - The package type code.
  - **currency** (string) - 3-character currency code.
  - **customsCurrency** (string) - 3-character currency code.
  - **totalAmount** (decimal) - Total quote amount (includes base charge and all surcharges).
  - **baseAmount** (decimal) - Base charge amount.
  - **surcharges** (array) - Array of surcharge details.
    - **description** (string) - Human readable description of surcharge.
    - **amount** (decimal) - Surcharge amount.
  - **zone** (string) - The zone used to compute shipping cost.
  - **quotedWeight** (string) - Quoted weight of the shipment.
  - **quotedWeightType** (string) - Type of quoted weight (e.g., 'Actual').

#### Response Example
```json
{
  "quotes": [
    {
      "carrierCode": "ups",
      "serviceCode": "ups_ground",
      "serviceDescription": "UPS® Ground",
      "packageTypeCode": "ups_custom_package",
      "currency": "USD",
      "customsCurrency": "USD",
      "totalAmount": "16.27",
      "baseAmount": "12.15",
      "surcharges": [
        {
          "description": "Residential surcharge",
          "amount": "4.12"
        }
      ],
      "zone": "2",
      "quotedWeight": "2",
      "quotedWeightType": "Actual"
    },
    {
        "carrierCode": "ups",
        "serviceCode": "ups_second_day_air",
        "serviceDescription": "UPS 2nd Day Air®",
        "packageTypeCode": "ups_custom_package",
        "currency": "USD",
        "totalAmount": "41.72",
        "baseAmount": "22.66",
        "surcharges": [
            {
                "description": "ResidentialExpress",
                "amount": "5.15"
            },
        ],
        "zone": "202",
        "quotedWeight": "2",
        "quotedWeightType": "Actual"
    }
  ]
}
```
```

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

### List Services

Source: https://shipping.rocksolidinternet.com/restapi/docs/v1-ecommerce/endpoints/list-services

Use this endpoint to list available shipping services and package types.

```APIDOC
## GET /restapi/v1/customers/:customerId/services

### Description
Use this endpoint to list available shipping services and package types.

### Method
GET

### Endpoint
/restapi/v1/customers/:customerId/services

### Parameters
#### Path Parameters
- **customerId** (string) - Required - The ID of the customer for whom to list services.

### Request Example
```
GET /restapi/v1/customers/TEST00002/services
```

### Response
#### Success Response (200)
- **services** (array) - A list of available shipping services.
  - **carrierCode** (string) - The carrier code.
  - **carrierLabel** (string) - Human readable carrier label.
  - **serviceCode** (string) - The service code.
  - **serviceLabel** (string) - Human readable service label.
  - **inbound** (boolean) - True for inbound services.
  - **supportedCountries** (array of strings or null) - List of supported countries.
  - **unsupportedCountries** (array of strings or null) - List of unsupported countries.
  - **signatureOptions** (array) - List of available signature options.
    - **signatureOptionCode** (string) - The code for this signature option.
    - **signatureOptionLabel** (string) - The human readable label for this signature option.
  - **supportedDangerousGoodsCodes** (string) - The dangerous goods codes supported for the service type.
  - **packageTypes** (array) - List of supported package types for the service.
    - **packageTypeCode** (string) - The code for this package type.
    - **packageTypeLabel** (string) - The human readable label for this package type.
    - **multipieceSupported** (boolean) - True if multipiece shipments are supported.
    - **weightUnit** (string) - Unit of weight ('lb' or 'kg').
    - **maxWeightPerPiece** (decimal string) - Maximum weight per piece.
    - **dimType** (string) - Type of dimension ('preset', 'envelope', or 'custom').
    - **dimUnit** (string or null) - Unit of dimension ('in' or 'cm') or null if dimType is not 'preset'.
    - **presetLength** (decimal or null) - Preset length or null if dimType is not 'preset'.
    - **presetWidth** (decimal or null) - Preset width or null if dimType is not 'preset'.
    - **presetHeight** (decimal or null) - Preset height or null if dimType is not 'preset'.

#### Response Example
```json
{
  "services": [
    {
      "carrierCode": "ups",
      "carrierLabel": "UPS",
      "serviceCode": "ups_ground",
      "serviceLabel": "UPS Ground",
      "inbound": false,
      "supportedCountries": ["US"],
      "unsupportedCountries": null,
      "signatureOptions": [
        {
          "signatureOptionCode": "direct",
          "signatureOptionLabel": "Signature Required"
        },
        {
          "signatureOptionCode": "adult",
          "signatureOptionLabel": "Adult Signature Required"
        }
      ],
      "supportedDangerousGoodsCodes": null,
      "packageTypes": [
        {
          "packageTypeCode": "ups_large_box",
          "packageTypeLabel": "UPS Large Box",
          "multipieceSupported": true,
          "weightUnit": "lb",
          "maxWeightPerPiece": "40.0",
          "dimType": "preset",
          "dimUnit": "in",
          "presetLength": "10",
          "presetWidth": "5",
          "presetHeight": "5"
        },
        {
          "packageTypeCode": "customer_packaging",
          "packageTypeLabel": "Customer Supplied Packaging",
          "multipieceSupported": true,
          "weightUnit": "lb",
          "maxWeightPerPiece": "105.25",
          "dimType": "custom",
          "dimUnit": null,
          "presetLength": null,
          "presetWidth": null,
          "presetHeight": null
        }
      ]
    },
    {
      "carrierCode": "dhl",
      "carrierLabel": "DHL",
      "serviceCode": "dhl_express_worldwide",
      "serviceLabel": "DHL Express Worldwide",
      "inbound": false,
      "supportedCountries": null,
      "unsupportedCountries": ["US"],
      "signatureOptions": [
        {
          "signatureOptionCode": "direct",
          "signatureOptionLabel": "Signature Required"
        }
      ],
      "supportedDangerousGoodsCodes": null,
      "packageTypes": [
        {
          "packageTypeCode": "customer_packaging",
          "packageTypeLabel": "Customer Supplied Packaging",
          "multipieceSupported": true,
          "weightUnit": "kg",
          "maxWeightPerPiece": "50.00",
          "dimType": "custom",
          "dimUnit": null,
          "presetLength": null,
          "presetWidth": null,
          "presetHeight": null
        }
      ]
    }
  ]
}
```
```
Tokens:
Raw