Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spojit.com/llms.txt

Use this file to discover all available pages before exploring further.

The ShipStation connector lets your workflows manage orders and shipments, generate labels, get carrier rates, and track inventory across warehouses through ShipStation’s REST API.
For the full API reference, see the ShipStation API documentation.

​
Connection setup

1

Get your API credentials

Log in to ShipStation and go to Settings > Account > API Settings. Copy your API Key and API Secret.
2

Add the connection in Spojit

Go to Connections in Spojit, click Add Connection, select ShipStation, and enter:
  • API Key: Your ShipStation API key
  • API Secret: Your ShipStation API secret
ShipStation enforces a rate limit of 40 requests per minute per API key. Space out bulk operations accordingly.

​
Tools

​
Orders

​
customerName
string
Filter by customer name.
​
orderNumber
string
Filter by order number.
​
orderStatus
string
Filter by status: awaiting_payment, awaiting_shipment, shipped, on_hold, cancelled.
​
orderDateStart
string
Start date (YYYY-MM-DD).
​
orderDateEnd
string
End date (YYYY-MM-DD).
​
page
number
default:"1"
Page number.
​
pageSize
number
default:"100"
Results per page (max 500).
​
sortBy
string
Sort field: OrderDate, ModifyDate, CreateDate.
​
sortDir
string
Sort direction: ASC or DESC.
Example request:
{
  "orderStatus": "awaiting_shipment",
  "orderDateStart": "2015-06-01",
  "orderDateEnd": "2015-07-01",
  "page": 1,
  "pageSize": 100,
  "sortBy": "OrderDate",
  "sortDir": "ASC"
}
Example response:
{
  "orders": [
    {
      "orderId": 123456789,
      "orderNumber": "TEST-ORDER-API-DOCS",
      "orderKey": "0f6bec18-9-4771-83aa-f392d84f4c74",
      "orderDate": "2015-06-29T08:46:27.0000000",
      "createDate": "2015-07-16T14:00:34.8230000",
      "modifyDate": "2015-08-17T09:21:59.4430000",
      "paymentDate": "2015-06-29T08:46:27.0000000",
      "shipByDate": "2015-07-05T00:00:00.0000000",
      "orderStatus": "awaiting_shipment",
      "customerId": 37701499,
      "customerUsername": "[email protected]",
      "customerEmail": "[email protected]",
      "billTo": {
        "name": "The President",
        "company": null,
        "street1": null,
        "street2": null,
        "street3": null,
        "city": null,
        "state": null,
        "postalCode": null,
        "country": null,
        "phone": null,
        "residential": null,
        "addressVerified": null
      },
      "shipTo": {
        "name": "The President",
        "company": "US Govt",
        "street1": "1600 Pennsylvania Ave",
        "street2": "Oval Office",
        "street3": null,
        "city": "Washington",
        "state": "DC",
        "postalCode": "20500",
        "country": "US",
        "phone": "555-555-5555",
        "residential": false,
        "addressVerified": "Address validation warning"
      },
      "items": [
        {
          "orderItemId": 128836912,
          "lineItemKey": "vd08-MSLbtx",
          "sku": "ABC123",
          "name": "Test item #1",
          "imageUrl": null,
          "weight": {
            "value": 24,
            "units": "ounces"
          },
          "quantity": 2,
          "unitPrice": 99.99,
          "taxAmount": null,
          "shippingAmount": null,
          "warehouseLocation": "Aisle 1, Bin 7",
          "options": [
            {
              "name": "Size",
              "value": "Large"
            }
          ],
          "productId": 7239919,
          "fulfillmentSku": null,
          "adjustment": false,
          "upc": null
        }
      ],
      "orderTotal": 194.43,
      "amountPaid": 218.73,
      "taxAmount": 5,
      "shippingAmount": 10,
      "customerNotes": "Please ship as soon as possible!",
      "internalNotes": "Customer called and would like to upgrade shipping",
      "gift": true,
      "giftMessage": "Thank you!",
      "paymentMethod": "Credit Card",
      "requestedShippingService": "Priority Mail",
      "carrierCode": "fedex",
      "serviceCode": "fedex_home_delivery",
      "packageCode": "package",
      "confirmation": "delivery",
      "shipDate": "2015-07-02",
      "weight": {
        "value": 48,
        "units": "ounces"
      },
      "dimensions": {
        "units": "inches",
        "length": 7,
        "width": 5,
        "height": 6
      },
      "insuranceOptions": {
        "provider": "carrier",
        "insureShipment": true,
        "insuredValue": 200
      },
      "advancedOptions": {
        "warehouseId": 98765,
        "nonMachinable": false,
        "saturdayDelivery": false,
        "containsAlcohol": false,
        "storeId": 12345,
        "customField1": "Custom data",
        "customField2": null,
        "customField3": null,
        "source": "Webstore"
      },
      "tagIds": null,
      "userId": null,
      "externallyFulfilled": false,
      "externallyFulfilledBy": null
    }
  ],
  "total": 1,
  "page": 1,
  "pages": 1
}
​
orderId
string
required
ShipStation order ID.
Example request:
{
  "orderId": "123456789"
}
Example response:
{
  "orderId": 123456789,
  "orderNumber": "TEST-ORDER-API-DOCS",
  "orderKey": "0f6bec18-9-4771-83aa-f392d84f4c74",
  "orderDate": "2015-06-29T08:46:27.0000000",
  "createDate": "2015-07-16T14:00:34.8230000",
  "modifyDate": "2015-08-17T09:21:59.4430000",
  "paymentDate": "2015-06-29T08:46:27.0000000",
  "shipByDate": "2015-07-05T00:00:00.0000000",
  "orderStatus": "awaiting_shipment",
  "customerId": 37701499,
  "customerUsername": "[email protected]",
  "customerEmail": "[email protected]",
  "billTo": {
    "name": "The President",
    "company": null,
    "street1": null,
    "street2": null,
    "street3": null,
    "city": null,
    "state": null,
    "postalCode": null,
    "country": null,
    "phone": null,
    "residential": null,
    "addressVerified": null
  },
  "shipTo": {
    "name": "The President",
    "company": "US Govt",
    "street1": "1600 Pennsylvania Ave",
    "street2": "Oval Office",
    "street3": null,
    "city": "Washington",
    "state": "DC",
    "postalCode": "20500",
    "country": "US",
    "phone": "555-555-5555",
    "residential": false,
    "addressVerified": "Address validation warning"
  },
  "items": [
    {
      "orderItemId": 128836912,
      "lineItemKey": "vd08-MSLbtx",
      "sku": "ABC123",
      "name": "Test item #1",
      "imageUrl": null,
      "weight": {
        "value": 24,
        "units": "ounces"
      },
      "quantity": 2,
      "unitPrice": 99.99,
      "taxAmount": null,
      "shippingAmount": null,
      "warehouseLocation": "Aisle 1, Bin 7",
      "options": [
        {
          "name": "Size",
          "value": "Large"
        }
      ],
      "productId": 7239919,
      "fulfillmentSku": null,
      "adjustment": false,
      "upc": null
    }
  ],
  "orderTotal": 194.43,
  "amountPaid": 218.73,
  "taxAmount": 5,
  "shippingAmount": 10,
  "customerNotes": "Please ship as soon as possible!",
  "internalNotes": "Customer called and would like to upgrade shipping",
  "gift": true,
  "giftMessage": "Thank you!",
  "paymentMethod": "Credit Card",
  "requestedShippingService": "Priority Mail",
  "carrierCode": "fedex",
  "serviceCode": "fedex_home_delivery",
  "packageCode": "package",
  "confirmation": "delivery",
  "shipDate": "2015-07-02",
  "weight": {
    "value": 48,
    "units": "ounces"
  },
  "dimensions": {
    "units": "inches",
    "length": 7,
    "width": 5,
    "height": 6
  },
  "insuranceOptions": {
    "provider": "carrier",
    "insureShipment": true,
    "insuredValue": 200
  },
  "advancedOptions": {
    "warehouseId": 98765,
    "nonMachinable": false,
    "saturdayDelivery": false,
    "containsAlcohol": false,
    "storeId": 12345,
    "customField1": "Custom data",
    "customField2": null,
    "customField3": null,
    "source": "Webstore"
  },
  "tagIds": null,
  "userId": null,
  "externallyFulfilled": false,
  "externallyFulfilledBy": null
}
​
order
object
required
Order object with orderNumber, orderDate, orderStatus, billTo, shipTo, items, etc.
Example request:
{
  "order": {
    "orderNumber": "TEST-ORDER-API-DOCS",
    "orderKey": "0f6bec18-3e89-4881-83aa-f392d84f4c74",
    "orderDate": "2015-06-29T08:46:27.0000000",
    "paymentDate": "2015-06-29T08:46:27.0000000",
    "shipByDate": "2015-07-05T00:00:00.0000000",
    "orderStatus": "awaiting_shipment",
    "customerUsername": "[email protected]",
    "customerEmail": "[email protected]",
    "billTo": {
      "name": "The President",
      "company": null,
      "street1": null,
      "street2": null,
      "street3": null,
      "city": null,
      "state": null,
      "postalCode": null,
      "country": null,
      "phone": null,
      "residential": null
    },
    "shipTo": {
      "name": "The President",
      "company": "US Govt",
      "street1": "1600 Pennsylvania Ave",
      "street2": "Oval Office",
      "street3": null,
      "city": "Washington",
      "state": "DC",
      "postalCode": "20500",
      "country": "US",
      "phone": "555-555-5555",
      "residential": true
    },
    "items": [
      {
        "lineItemKey": "vd08-MSLbtx",
        "sku": "ABC123",
        "name": "Test item #1",
        "imageUrl": null,
        "weight": {
          "value": 24,
          "units": "ounces"
        },
        "quantity": 2,
        "unitPrice": 99.99,
        "taxAmount": 2.5,
        "shippingAmount": 5,
        "warehouseLocation": "Aisle 1, Bin 7",
        "options": [
          {
            "name": "Size",
            "value": "Large"
          }
        ],
        "upc": "32-65-98"
      },
      {
        "sku": "DISCOUNT CODE",
        "name": "10% OFF",
        "weight": {
          "value": 0,
          "units": "ounces"
        },
        "quantity": 1,
        "unitPrice": -20.55,
        "adjustment": true
      }
    ],
    "amountPaid": 218.73,
    "taxAmount": 5,
    "shippingAmount": 10,
    "customerNotes": "Please ship as soon as possible!",
    "internalNotes": "Customer called and would like to upgrade shipping",
    "gift": true,
    "giftMessage": "Thank you!",
    "paymentMethod": "Credit Card",
    "requestedShippingService": "Priority Mail",
    "carrierCode": "fedex",
    "serviceCode": "fedex_2day",
    "packageCode": "package",
    "confirmation": "delivery",
    "shipDate": "2015-07-02",
    "weight": {
      "value": 25,
      "units": "ounces"
    },
    "dimensions": {
      "units": "inches",
      "length": 7,
      "width": 5,
      "height": 6
    },
    "insuranceOptions": {
      "provider": "carrier",
      "insureShipment": true,
      "insuredValue": 200
    },
    "advancedOptions": {
      "customField1": "Custom data that you can add to an order.",
      "source": "Webstore"
    },
    "tagIds": [53974]
  }
}
Example response:
{
  "orderId": 140335319,
  "orderNumber": "TEST-ORDER-API-DOCS",
  "orderKey": "0f6bec18-3e89-4881-83aa-f392d84f4c74",
  "orderDate": "2015-06-29T08:46:27.0000000",
  "createDate": "2016-02-16T15:16:53.7070000",
  "modifyDate": "2016-02-16T15:16:53.7070000",
  "paymentDate": "2015-06-29T08:46:27.0000000",
  "shipByDate": "2015-07-05T00:00:00.0000000",
  "orderStatus": "awaiting_shipment",
  "customerId": null,
  "customerUsername": "[email protected]",
  "customerEmail": "[email protected]",
  "billTo": {
    "name": "The President",
    "company": null,
    "street1": null,
    "street2": null,
    "street3": null,
    "city": null,
    "state": null,
    "postalCode": null,
    "country": null,
    "phone": null,
    "residential": null,
    "addressVerified": null
  },
  "shipTo": {
    "name": "The President",
    "company": "US Govt",
    "street1": "1600 Pennsylvania Ave",
    "street2": "Oval Office",
    "street3": null,
    "city": "Washington",
    "state": "DC",
    "postalCode": "20500",
    "country": "US",
    "phone": "555-555-5555",
    "residential": false,
    "addressVerified": "Address validation warning"
  },
  "items": [
    {
      "orderItemId": 192210956,
      "lineItemKey": "vd08-MSLbtx",
      "sku": "ABC123",
      "name": "Test item #1",
      "imageUrl": null,
      "weight": {
        "value": 24,
        "units": "ounces"
      },
      "quantity": 2,
      "unitPrice": 99.99,
      "taxAmount": 2.5,
      "shippingAmount": 5,
      "warehouseLocation": "Aisle 1, Bin 7",
      "options": [
        {
          "name": "Size",
          "value": "Large"
        }
      ],
      "productId": null,
      "fulfillmentSku": null,
      "adjustment": false,
      "upc": "32-65-98",
      "createDate": "2016-02-16T15:16:53.707",
      "modifyDate": "2016-02-16T15:16:53.707"
    },
    {
      "orderItemId": 192210957,
      "lineItemKey": null,
      "sku": "DISCOUNT CODE",
      "name": "10% OFF",
      "imageUrl": null,
      "weight": {
        "value": 0,
        "units": "ounces"
      },
      "quantity": 1,
      "unitPrice": -20.55,
      "taxAmount": null,
      "shippingAmount": null,
      "warehouseLocation": null,
      "options": [],
      "productId": null,
      "fulfillmentSku": "SKU-Discount",
      "adjustment": true,
      "upc": null,
      "createDate": "2016-02-16T15:16:53.707",
      "modifyDate": "2016-02-16T15:16:53.707"
    }
  ],
  "orderTotal": 194.43,
  "amountPaid": 218.73,
  "taxAmount": 5,
  "shippingAmount": 10,
  "customerNotes": "Please ship as soon as possible!",
  "internalNotes": "Customer called and would like to upgrade shipping",
  "gift": true,
  "giftMessage": "Thank you!",
  "paymentMethod": "Credit Card",
  "requestedShippingService": "Priority Mail",
  "carrierCode": "fedex",
  "serviceCode": "fedex_2day",
  "packageCode": "package",
  "confirmation": "delivery",
  "shipDate": "2015-07-02",
  "holdUntilDate": null,
  "weight": {
    "value": 25,
    "units": "ounces"
  },
  "dimensions": {
    "units": "inches",
    "length": 7,
    "width": 5,
    "height": 6
  },
  "insuranceOptions": {
    "provider": "carrier",
    "insureShipment": true,
    "insuredValue": 200
  },
  "advancedOptions": {
    "warehouseId": 9876,
    "nonMachinable": false,
    "saturdayDelivery": false,
    "containsAlcohol": false,
    "storeId": 12345,
    "customField1": "Custom data that you can add to an order.",
    "customField2": null,
    "customField3": null,
    "source": "Webstore"
  },
  "tagIds": null,
  "userId": null,
  "externallyFulfilled": false,
  "externallyFulfilledBy": null
}

​
Shipments & Labels

​
recipientName
string
Filter by recipient.
​
orderNumber
string
Filter by order number.
​
trackingNumber
string
Filter by tracking number.
​
carrierCode
string
Filter by carrier code.
​
shipDateStart
string
Start date (YYYY-MM-DD).
​
shipDateEnd
string
End date (YYYY-MM-DD).
​
page
number
default:"1"
Page number.
​
pageSize
number
default:"100"
Results per page (max 500).
Example request:
{
  "shipDateStart": "2014-10-01",
  "shipDateEnd": "2014-10-31",
  "carrierCode": "stamps_com",
  "page": 1,
  "pageSize": 100
}
Example response:
{
  "shipments": [
    {
      "shipmentId": 33974374,
      "orderId": 43945660,
      "orderKey": "8061c220f0794a9b92460b8bae6837e4",
      "userId": "123456AB-ab12-3c4d-5e67-89f1abc1defa",
      "orderNumber": "100038-1",
      "createDate": "2014-10-03T06:51:33.6270000",
      "shipDate": "2014-10-03",
      "shipmentCost": 1.93,
      "insuranceCost": 0,
      "trackingNumber": "9400111899561704681189",
      "isReturnLabel": false,
      "batchNumber": "100301",
      "carrierCode": "stamps_com",
      "serviceCode": "usps_first_class_mail",
      "packageCode": "package",
      "confirmation": "delivery",
      "warehouseId": 16079,
      "voided": false,
      "voidDate": null,
      "marketplaceNotified": true,
      "notifyErrorMessage": null,
      "shipTo": {
        "name": "Yoda",
        "company": "",
        "street1": "12223 LOWDEN LN",
        "street2": "",
        "street3": null,
        "city": "MANCHACA",
        "state": "TX",
        "postalCode": "78652-3602",
        "country": "US",
        "phone": "2101235544",
        "residential": null
      },
      "weight": {
        "value": 1,
        "units": "ounces"
      },
      "dimensions": null,
      "insuranceOptions": {
        "provider": null,
        "insureShipment": false,
        "insuredValue": 0
      },
      "shipmentItems": [
        {
          "orderItemId": 56568665,
          "lineItemKey": null,
          "sku": "SQ3785739",
          "name": "Potato Kitten -",
          "imageUrl": null,
          "weight": null,
          "quantity": 1,
          "unitPrice": 1,
          "warehouseLocation": null,
          "options": null,
          "productId": 7565777,
          "fulfillmentSku": null
        }
      ]
    }
  ],
  "total": 1,
  "page": 1,
  "pages": 1
}
​
shipment
object
required
Shipment object with carrierCode, serviceCode, packageCode, weight, shipFrom, shipTo, etc.
Example request:
{
  "shipment": {
    "carrierCode": "fedex",
    "serviceCode": "fedex_ground",
    "packageCode": "package",
    "confirmation": "delivery",
    "shipDate": "2014-04-03",
    "weight": {
      "value": 3,
      "units": "ounces"
    },
    "dimensions": {
      "units": "inches",
      "length": 7,
      "width": 5,
      "height": 6
    },
    "shipFrom": {
      "name": "Jason Hodges",
      "company": "ShipStation",
      "street1": "2815 Exposition Blvd",
      "street2": "Ste 2353242",
      "street3": null,
      "city": "Austin",
      "state": "TX",
      "postalCode": "78703",
      "country": "US",
      "phone": null,
      "residential": false
    },
    "shipTo": {
      "name": "The President",
      "company": "US Govt",
      "street1": "1600 Pennsylvania Ave",
      "street2": "Oval Office",
      "street3": null,
      "city": "Washington",
      "state": "DC",
      "postalCode": "20500",
      "country": "US",
      "phone": null,
      "residential": false
    },
    "testLabel": false
  }
}
Example response:
{
  "shipmentId": 123456789,
  "orderId": null,
  "customerEmail": null,
  "orderNumber": null,
  "createDate": "2016-04-03T12:11:36.8630000",
  "shipDate": "2016-04-03",
  "shipmentCost": 9.06,
  "insuranceCost": 0,
  "trackingNumber": "782390443992",
  "isReturnLabel": false,
  "batchNumber": null,
  "carrierCode": "fedex",
  "serviceCode": "fedex_ground",
  "packageCode": "package",
  "confirmation": "delivery",
  "warehouseId": null,
  "voided": false,
  "voidDate": null,
  "marketplaceNotified": false,
  "notifyErrorMessage": null,
  "shipTo": null,
  "weight": null,
  "dimensions": null,
  "insuranceOptions": null,
  "advancedOptions": null,
  "shipmentItems": null,
  "labelData": "JVBERi0xLjQKJeLjz9MKMiAwIG9iago8PC...",
  "formData": null
}
​
shipmentId
number
required
ShipStation shipment ID to void.
Example request:
{
  "shipmentId": 12345
}
Example response:
{
  "approved": true,
  "message": "Label voided successfully"
}

​
Rates

​
carrierCode
string
required
Carrier code (e.g., stamps_com, fedex, ups).
​
fromPostalCode
string
required
Origin postal/zip code.
​
toCountry
string
required
Destination country code (e.g., US, AU).
​
toPostalCode
string
required
Destination postal/zip code.
​
toState
string
Destination state/province.
​
weight
object
required
Weight: { value, units: "pounds" | "ounces" | "grams" }.
​
dimensions
object
Dimensions: { length, width, height, units: "inches" | "centimeters" }.
Example request:
{
  "carrierCode": "fedex",
  "fromPostalCode": "78703",
  "toState": "DC",
  "toCountry": "US",
  "toPostalCode": "20500",
  "toCity": "Washington",
  "weight": {
    "value": 3,
    "units": "ounces"
  },
  "dimensions": {
    "units": "inches",
    "length": 7,
    "width": 5,
    "height": 6
  },
  "confirmation": "delivery",
  "residential": false
}
Example response:
[
  {
    "serviceName": "FedEx First Overnight\u00ae",
    "serviceCode": "fedex_first_overnight",
    "shipmentCost": 87.8,
    "otherCost": 2.63
  },
  {
    "serviceName": "FedEx Priority Overnight\u00ae",
    "serviceCode": "fedex_priority_overnight",
    "shipmentCost": 50.23,
    "otherCost": 1.51
  },
  {
    "serviceName": "FedEx Standard Overnight\u00ae",
    "serviceCode": "fedex_standard_overnight",
    "shipmentCost": 46.96,
    "otherCost": 1.41
  },
  {
    "serviceName": "FedEx 2Day\u00ae A.M.",
    "serviceCode": "fedex_2day_am",
    "shipmentCost": 23.04,
    "otherCost": 0.69
  },
  {
    "serviceName": "FedEx 2Day\u00ae",
    "serviceCode": "fedex_2day",
    "shipmentCost": 20.03,
    "otherCost": 0.6
  },
  {
    "serviceName": "FedEx Express Saver\u00ae",
    "serviceCode": "fedex_express_saver",
    "shipmentCost": 14.28,
    "otherCost": 0.43
  },
  {
    "serviceName": "FedEx Ground\u00ae",
    "serviceCode": "fedex_ground",
    "shipmentCost": 8.25,
    "otherCost": 0.33
  }
]

​
Resources

No parameters required.Example response:
[
  {
    "name": "Stamps.com",
    "code": "stamps_com",
    "accountNumber": "SS123",
    "requiresFundedAccount": true,
    "balance": 24.27,
    "nickname": null,
    "shippingProviderId": 12345,
    "primary": true
  },
  {
    "name": "UPS",
    "code": "ups",
    "accountNumber": "ABCR80",
    "requiresFundedAccount": false,
    "balance": 0,
    "nickname": null,
    "shippingProviderId": 12347,
    "primary": true
  },
  {
    "name": "FedEx",
    "code": "fedex",
    "accountNumber": "297929999",
    "requiresFundedAccount": false,
    "balance": 0,
    "nickname": "SS",
    "shippingProviderId": 12348,
    "primary": true
  }
]
No parameters required.Example response:
[
  {
    "warehouseId": 17977,
    "warehouseName": "Main warehouse",
    "originAddress": {
      "name": "Spring warehouse",
      "company": "",
      "street1": "123 S SPRING RD",
      "street2": "",
      "street3": "",
      "city": "Elmhurst",
      "state": "IL",
      "postalCode": "60126",
      "country": "US",
      "phone": "5121112222",
      "residential": false
    },
    "returnAddress": {
      "name": "Chicago House",
      "company": "",
      "street1": "123 S SPRING RD",
      "street2": "",
      "street3": "",
      "city": "Elmhurst",
      "state": "IL",
      "postalCode": "60126",
      "country": "US",
      "phone": "5121112222",
      "residential": null
    },
    "createDate": "2014-10-21T08:11:43.8800000",
    "isDefault": true
  },
  {
    "warehouseId": 14265,
    "warehouseName": "Austin",
    "originAddress": {
      "name": "Austin",
      "company": "ShipStation",
      "street1": "2815 Exposition Blvd",
      "street2": "",
      "street3": "",
      "city": "Austin",
      "state": "TX",
      "postalCode": "78703",
      "country": "US",
      "phone": "5124445555",
      "residential": false
    },
    "returnAddress": {
      "name": "ShipStation",
      "company": "ShipStation",
      "street1": "2815 Exposition Blvd",
      "street2": "",
      "street3": "",
      "city": "Austin",
      "state": "TX",
      "postalCode": "78703",
      "country": "US",
      "phone": "5124445555",
      "residential": null
    },
    "createDate": "2014-05-27T09:54:29.9600000",
    "isDefault": false
  }
]
​
stateCode
string
Filter by state code.
​
countryCode
string
Filter by country code.
​
page
number
default:"1"
Page number.
​
pageSize
number
default:"100"
Results per page (max 500).
Example request:
{
  "stateCode": "AL",
  "countryCode": "US",
  "page": 1,
  "pageSize": 100
}
Example response:
{
  "customers": [
    {
      "customerId": 12345678,
      "createDate": "2014-11-18T10:33:01.1900000",
      "modifyDate": "2014-11-18T10:33:01.1900000",
      "name": "Cam Newton",
      "company": "Test Company",
      "street1": "123 War Eagle Lane",
      "street2": "",
      "city": "Auburn",
      "state": "AL",
      "postalCode": "36830",
      "countryCode": "US",
      "phone": "555-555-5555",
      "email": "[email protected]",
      "addressVerified": "Verified",
      "marketplaceUsernames": [
        {
          "customerUserId": 67195020,
          "customerId": 12345678,
          "createDate": "2015-04-27T12:35:03.8300000",
          "modifyDate": "2015-05-14T08:16:15.2700000",
          "marketplaceId": 0,
          "marketplace": "ShipStation",
          "username": "[email protected]"
        }
      ],
      "tags": [
        {
          "tagId": 1234,
          "name": "Expedited"
        }
      ]
    }
  ],
  "total": 1,
  "page": 1,
  "pages": 1
}
​
sku
string
Filter by SKU.
​
name
string
Filter by product name.
​
page
number
default:"1"
Page number.
​
pageSize
number
default:"100"
Results per page (max 500).
Example request:
{
  "sku": "1004",
  "page": 1,
  "pageSize": 100
}
Example response:
{
  "products": [
    {
      "aliases": null,
      "productId": 7854008,
      "sku": "1004",
      "name": "Coffee Mug",
      "price": 26,
      "defaultCost": 0,
      "length": 3,
      "width": 3,
      "height": 3,
      "weightOz": 26,
      "internalNotes": null,
      "fulfillmentSku": "F1004",
      "createDate": "2014-09-04T09:18:01.293",
      "modifyDate": "2014-09-18T12:38:43.893",
      "active": true,
      "productCategory": {
        "categoryId": 9999,
        "name": "Door Closers"
      },
      "productType": null,
      "warehouseLocation": "Bin 22",
      "defaultCarrierCode": "fedex",
      "defaultServiceCode": "fedex_home_delivery",
      "defaultPackageCode": "package",
      "defaultIntlCarrierCode": "ups",
      "defaultIntlServiceCode": "ups_worldwide_saver",
      "defaultIntlPackageCode": "package",
      "defaultConfirmation": "direct_signature",
      "defaultIntlConfirmation": "adult_signature",
      "customsDescription": null,
      "customsValue": null,
      "customsTariffNo": null,
      "customsCountryCode": null,
      "noCustoms": null,
      "tags": [
        {
          "tagId": 9180,
          "name": "APItest"
        }
      ],
      "upc": "012345678905",
      "thumbnailURL": "url_to_thumbnail_image"
    }
  ],
  "total": 1,
  "page": 1,
  "pages": 1
}

​
Advanced

Send a request to any ShipStation API endpoint.
​
method
string
required
HTTP method: GET, POST, PUT, or DELETE.
​
path
string
required
API path (e.g., /orders or /webhooks).
​
body
object
Request body (for POST/PUT).
Example request:
{
  "method": "GET",
  "path": "/orders?orderStatus=awaiting_shipment&page=1&pageSize=50"
}
Example response:
{
  "orders": [
    {
      "orderId": 123456789,
      "orderNumber": "TEST-ORDER-API-DOCS",
      "orderDate": "2015-06-29T08:46:27.0000000",
      "orderStatus": "awaiting_shipment",
      "shipTo": {
        "name": "The President",
        "street1": "1600 Pennsylvania Ave",
        "city": "Washington",
        "state": "DC",
        "postalCode": "20500",
        "country": "US"
      },
      "items": [
        {
          "sku": "ABC123",
          "name": "Test item #1",
          "quantity": 2,
          "unitPrice": 99.99
        }
      ],
      "orderTotal": 194.43,
      "amountPaid": 218.73
    }
  ],
  "total": 1,
  "page": 1,
  "pages": 1
}