Skip to content
Full API Reference/
/
List scheduled pickups

ShipStation API v2 (2.0.0)

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
MIT
Languages
Servers
Mock server
https://docs.shipstation.com/_mock/openapi/
Production
https://api.shipstation.com/

Batches

Process labels in bulk and receive a large number of labels and customs forms in bulk responses. Batching is ideal for workflows that need to process hundreds or thousands of labels quickly.

Operations

Carriers

Retreive useful details about the carriers connected to your accounts, including carrier IDs, service IDs, advanced options, and available carrier package types.

Operations

Downloads

Download your label files in PDF, PNG, and ZPL.

Operations

Fulfillments

Manage fulfillments which represent completed shipments. Create fulfillments to mark orders as shipped with tracking information and notify customers and marketplaces.

Operations

Inventory

Manage inventory, adjust quantities, and handle warehouses and locations.

Operations

Labels

Purchase and print shipping labels for any carrier active on your account. The labels endpoint also supports creating return labels, voiding labels, and getting label details like tracking.

Operations

Manifests

A manifest is a document that provides a list of the day's shipments. It typically contains a barcode that allows the pickup driver to scan a single document to register all shipments, rather than scanning each shipment individually.

Operations

Package Pickups

Scheduled pickups and manage pickup requests for supported carriers.

Operations

List scheduled pickups

Request

List all pickups that have been scheduled for this carrier

Security
api_keys
Query
carrier_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$

Carrier ID

Example: carrier_id=se-28529731
warehouse_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$

Warehouse ID

Example: warehouse_id=se-28529731
created_at_startstring(date-time)

Only return scheduled pickups that were created on or after a specific date/time

Example: created_at_start=2019-03-12T19:24:13.657Z
created_at_endstring(date-time)

Only return scheduled pickups that were created on or before a specific date/time

Example: created_at_end=2019-03-12T19:24:13.657Z
pageinteger(int32)>= 1

Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.

Default 1
Example: page=2
page_sizeinteger(int32)>= 1

The number of results to return per response.

Default 25
Example: page_size=50
curl -i -X GET \
  'https://docs.shipstation.com/_mock/openapi/v2/pickups?carrier_id=se-28529731&warehouse_id=se-28529731&created_at_start=2019-03-12T19%3A24%3A13.657Z&created_at_end=2019-03-12T19%3A24%3A13.657Z&page=2&page_size=50' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

The request was a success.

Bodyapplication/json
pickupsArray of objects(pickup)required

An array of pickups associated with the user's account.

pickups[].​pickup_idstring(pickup_resource_id)>= 4 charactersread-only

Pickup Resource ID

Example: "pik_3YcKU5zdtJuCqoeNwyqqbW"
pickups[].​label_idsArray of objects

Label IDs that will be included in the pickup request

pickups[].​created_atstring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...read-only

An ISO 8601 string that represents a date and time.

Example: "2018-09-23T15:00:00.000Z"
pickups[].​cancelled_atstring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...read-only

An ISO 8601 string that represents a date and time.

Example: "2018-09-23T15:00:00.000Z"
pickups[].​carrier_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$read-only

The carrier_id associated with the pickup

Example: "se-28529731"
pickups[].​confirmation_numberstring or nullread-only

The carrier confirmation number for the scheduled pickup.

Example: "292513CL4A3"
pickups[].​warehouse_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$read-only

The warehouse_id associated with the pickup

Example: "se-28529731"
pickups[].​pickup_addressobject(partial_address)read-only

Any residential or business mailing address, anywhere in the world.

Note: Either name or company_name must be set. Both may be specified, if relevant.

pickups[].​contact_detailsobject(contact_details)
pickups[].​pickup_notesstring>= 0 characters

Used by some carriers to give special instructions for a package pickup

Example: "call before 15:00"
pickups[].​pickup_windowsArray of objects(pickup_windows)read-only

An array of available pickup windows. Carriers can return multiple times that they will pickup packages.

totalinteger(int64)>= 0read-onlyrequired

The total number of pickups returned

Example: 3
pageinteger(int32)>= 1read-onlyrequired

Current page of the list pickups results

Example: 3
pagesinteger(int32)>= 1read-onlyrequired

Total number of pages for list pickups results

Example: 4
linksobject(pagination_link)read-onlyrequired

Helpful links to other pages of results

links.​firstobject(optional_link)required

The link to the first page of results. This object will always have an href field. If there are no results, then the first page will contain an empty array of items.

links.​first.​hrefstring(url)(url)non-emptyrequired

The URL of the linked resource, if any

Example: "http://api.shipstation.com/v2/labels/se-28529731"
links.​first.​typestringnon-empty

The type of resource, or the type of relationship to the parent resource

Example: "child"
links.​lastobject(optional_link)required

The link to the final page of results. This object will always have an href field. If there are no results, then the final page will contain an empty array of items.

links.​last.​hrefstring(url)(url)non-emptyrequired

The URL of the linked resource, if any

Example: "http://api.shipstation.com/v2/labels/se-28529731"
links.​last.​typestringnon-empty

The type of resource, or the type of relationship to the parent resource

Example: "child"
links.​prevobject(optional_link)required

The link to the previous page of results. The href field will only be set when the page is 2 or greater.

links.​prev.​hrefstring(url)(url)non-empty

The URL of the linked resource, if any

Example: "http://api.shipstation.com/v2/labels/se-28529731"
links.​prev.​typestringnon-empty

The type of resource, or the type of relationship to the parent resource

Example: "child"
links.​nextobject(optional_link)required

The link to the next page of results. The href field will only be set when the page is less than pages.

links.​next.​hrefstring(url)(url)non-empty

The URL of the linked resource, if any

Example: "http://api.shipstation.com/v2/labels/se-28529731"
links.​next.​typestringnon-empty

The type of resource, or the type of relationship to the parent resource

Example: "child"
request_idstring(uuid)(uuid)= 36 characters^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...required

A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur

Example: "aa3d8e8e-462b-4476-9618-72db7f7b7009"
errorsArray of objects(error)read-onlyrequired

The errors associated with the failed API call

errors[].​error_sourcestring(error_source)required

The source of the error, as indicated by the name this informs us if the API call failed because of the carrier, the order source, or the ShipStation API itself.

Enum"carrier""order_source""ShipStation"
errors[].​error_typestring(error_type)required

The type of error

Enum"account_status""business_rules""validation""security""system""integrations"
errors[].​error_codestring(error_code)required

The error code specified for the failed API Call

Enum"auto_fund_not_supported""batch_cannot_be_modified""carrier_conflict""carrier_disconnected""carrier_not_connected""carrier_not_supported""confirmation_not_supported""default_warehouse_cannot_be_deleted""field_conflict""field_value_required"
errors[].​messagestringnon-emptyread-onlyrequired

An error message associated with the failed API call

Example: "Body of request cannot be null."
errors[].​field_namestringread-only

The name of the field that caused the error (only present for validation errors)

Example: "inventory_warehouse_id"
errors[].​field_valuestringread-only

The invalid value that was provided for the field (only present for validation errors)

Example: "invalid-id"
Response
application/json
{
  "pickups": [
    { … }
  ],
  "total": 3,
  "page": 3,
  "pages": 4,
  "links": {
    "first": { … },
    "last": { … },
    "prev": { … },
    "next": { … }
  },
  "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009",
  "errors": [
    { … }
  ]
}

Schedule a pickup

Request

Schedule a package pickup with a carrier

Security
api_keys
Bodyapplication/jsonrequired
label_idsArray of objectsrequired

Label IDs that will be included in the pickup request

contact_detailsobject(contact_details)required
contact_details.​namestringnon-emptyrequired
Example: "Jonh"
contact_details.​emailstring(email)(email)non-emptyrequired

An email address.

Example: "john.doe@example.com"
contact_details.​phonestring>= 7 charactersrequired

Phone number associated

Example: "89876752562"
pickup_notesstring>= 0 characters

Used by some carriers to give special instructions for a package pickup

Example: "call before 15:00"
pickup_windowobject(pickup_window)write-onlyrequired

The desired time range for the package pickup.

pickup_window.​start_atstring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...required

An ISO 8601 string that represents a date and time.

Example: "2018-09-23T15:00:00.000Z"
pickup_window.​end_atstring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...required

An ISO 8601 string that represents a date and time.

Example: "2018-09-23T15:00:00.000Z"
curl -i -X POST \
  https://docs.shipstation.com/_mock/openapi/v2/pickups \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "label_ids": [
      "se-28529731"
    ],
    "contact_details": {
      "name": "Jonh",
      "email": "email@email.com",
      "phone": "89876752562"
    },
    "pickup_notes": "call before 15:00",
    "pickup_window": {
      "start_at": "2018-09-23T15:00:00.000Z",
      "end_at": "2018-09-23T15:00:00.000Z"
    }
  }'

Responses

The request was a success.

Bodyapplication/json
pickup_idstring(pickup_resource_id)>= 4 charactersread-onlyrequired

Pickup Resource ID

Example: "pik_3YcKU5zdtJuCqoeNwyqqbW"
label_idsArray of objectsrequired

Label IDs that will be included in the pickup request

created_atstring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...read-onlyrequired

An ISO 8601 string that represents a date and time.

Example: "2018-09-23T15:00:00.000Z"
cancelled_atstring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...read-only

An ISO 8601 string that represents a date and time.

Example: "2018-09-23T15:00:00.000Z"
carrier_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$read-onlyrequired

The carrier_id associated with the pickup

Example: "se-28529731"
confirmation_numberstring or nullread-onlyrequired

The carrier confirmation number for the scheduled pickup.

Example: "292513CL4A3"
warehouse_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$read-onlyrequired

The warehouse_id associated with the pickup

Example: "se-28529731"
pickup_addressobject(partial_address)read-onlyrequired

Any residential or business mailing address, anywhere in the world.

Note: Either name or company_name must be set. Both may be specified, if relevant.

pickup_address.​namestringnon-emptyrequired

The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.

Example: "John Doe"
pickup_address.​phonestringnon-emptyrequired

The phone number of a contact person at this address. The format of this phone number varies depending on the country.

Example: "+1 204-253-9411 ext. 123"
pickup_address.​emailstring or null

Email for the address owner.

Example: "example@example.com"
pickup_address.​company_namestring or nullnon-empty

If this is a business address, then the company name should be specified here.

Example: "The Home Depot"
pickup_address.​address_line1stringnon-emptyrequired

The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.

Example: "1999 Bishop Grandin Blvd."
pickup_address.​address_line2string or nullnon-empty

The second line of the street address. For some addresses, this line may not be needed.

Example: "Unit 408"
pickup_address.​address_line3string or nullnon-empty

The third line of the street address. For some addresses, this line may not be needed.

Example: "Building #7"
pickup_address.​city_localitystringnon-emptyrequired

The name of the city or locality

Example: "Winnipeg"
pickup_address.​state_provincestringnon-emptyrequired

The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.

Example: "Manitoba"
pickup_address.​postal_codestring(postal_code)non-emptyrequired

postal code

Example: "78756-3717"
pickup_address.​country_codestring(country_code)= 2 charactersrequired

A two-letter ISO 3166-1 country code

Example: "CA"
pickup_address.​address_residential_indicatorstring(address_residential_indicator)required

Indicates whether this is a residential address.

Default "unknown"
Enum"unknown""yes""no"
Example: "yes"
contact_detailsobject(contact_details)required
contact_details.​namestringnon-emptyrequired
Example: "Jonh"
contact_details.​emailstring(email)(email)non-emptyrequired

An email address.

Example: "john.doe@example.com"
contact_details.​phonestring>= 7 charactersrequired

Phone number associated

Example: "89876752562"
pickup_notesstring>= 0 characters

Used by some carriers to give special instructions for a package pickup

Example: "call before 15:00"
pickup_windowsArray of objects(pickup_windows)read-only

An array of available pickup windows. Carriers can return multiple times that they will pickup packages.

request_idstring(uuid)(uuid)= 36 characters^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...required

A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur

Example: "aa3d8e8e-462b-4476-9618-72db7f7b7009"
errorsArray of objects(error)read-onlyrequired

The errors associated with the failed API call

errors[].​error_sourcestring(error_source)required

The source of the error, as indicated by the name this informs us if the API call failed because of the carrier, the order source, or the ShipStation API itself.

Enum"carrier""order_source""ShipStation"
errors[].​error_typestring(error_type)required

The type of error

Enum"account_status""business_rules""validation""security""system""integrations"
errors[].​error_codestring(error_code)required

The error code specified for the failed API Call

Enum"auto_fund_not_supported""batch_cannot_be_modified""carrier_conflict""carrier_disconnected""carrier_not_connected""carrier_not_supported""confirmation_not_supported""default_warehouse_cannot_be_deleted""field_conflict""field_value_required"
errors[].​messagestringnon-emptyread-onlyrequired

An error message associated with the failed API call

Example: "Body of request cannot be null."
errors[].​field_namestringread-only

The name of the field that caused the error (only present for validation errors)

Example: "inventory_warehouse_id"
errors[].​field_valuestringread-only

The invalid value that was provided for the field (only present for validation errors)

Example: "invalid-id"
Response
application/json
{
  "pickup_id": "pik_3YcKU5zdtJuCqoeNwyqqbW",
  "label_ids": [
    "se-28529731"
  ],
  "created_at": "2018-09-23T15:00:00.000Z",
  "cancelled_at": "2018-09-23T15:00:00.000Z",
  "carrier_id": "se-1234567",
  "confirmation_number": "292513CL4A3",
  "warehouse_id": "se-28529731",
  "pickup_address": {
    "name": "John Doe",
    "phone": "+1 204-253-9411 ext. 123",
    "email": "example@example.com",
    "company_name": "The Home Depot",
    "address_line1": "1999 Bishop Grandin Blvd.",
    "address_line2": "Unit 408",
    "address_line3": "Building #7",
    "city_locality": "Winnipeg",
    "state_province": "Manitoba",
    "postal_code": "78756-3717",
    "country_code": "CA",
    "address_residential_indicator": "yes"
  },
  "contact_details": {
    "name": "Jonh",
    "email": "email@email.com",
    "phone": "89876752562"
  },
  "pickup_notes": "call before 15:00",
  "pickup_windows": [
    { … }
  ],
  "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009",
  "errors": [
    { … }
  ]
}

Get pickup by id

Request

Get Pickup By ID

Security
api_keys
Path
pickup_idstring(pickup_resource_id)>= 4 charactersrequired

Pickup Resource ID

Example: pik_3YcKU5zdtJuCqoeNwyqqbW
curl -i -X GET \
  https://docs.shipstation.com/_mock/openapi/v2/pickups/pik_3YcKU5zdtJuCqoeNwyqqbW \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

The request was a success.

Bodyapplication/json
pickup_idstring(pickup_resource_id)>= 4 charactersread-onlyrequired

Pickup Resource ID

Example: "pik_3YcKU5zdtJuCqoeNwyqqbW"
label_idsArray of objectsrequired

Label IDs that will be included in the pickup request

created_atstring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...read-onlyrequired

An ISO 8601 string that represents a date and time.

Example: "2018-09-23T15:00:00.000Z"
cancelled_atstring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...read-only

An ISO 8601 string that represents a date and time.

Example: "2018-09-23T15:00:00.000Z"
carrier_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$read-onlyrequired

The carrier_id associated with the pickup

Example: "se-28529731"
confirmation_numberstring or nullread-onlyrequired

The carrier confirmation number for the scheduled pickup.

Example: "292513CL4A3"
warehouse_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$read-onlyrequired

The warehouse_id associated with the pickup

Example: "se-28529731"
pickup_addressobject(partial_address)read-onlyrequired

Any residential or business mailing address, anywhere in the world.

Note: Either name or company_name must be set. Both may be specified, if relevant.

pickup_address.​namestringnon-emptyrequired

The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.

Example: "John Doe"
pickup_address.​phonestringnon-emptyrequired

The phone number of a contact person at this address. The format of this phone number varies depending on the country.

Example: "+1 204-253-9411 ext. 123"
pickup_address.​emailstring or null

Email for the address owner.

Example: "example@example.com"
pickup_address.​company_namestring or nullnon-empty

If this is a business address, then the company name should be specified here.

Example: "The Home Depot"
pickup_address.​address_line1stringnon-emptyrequired

The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.

Example: "1999 Bishop Grandin Blvd."
pickup_address.​address_line2string or nullnon-empty

The second line of the street address. For some addresses, this line may not be needed.

Example: "Unit 408"
pickup_address.​address_line3string or nullnon-empty

The third line of the street address. For some addresses, this line may not be needed.

Example: "Building #7"
pickup_address.​city_localitystringnon-emptyrequired

The name of the city or locality

Example: "Winnipeg"
pickup_address.​state_provincestringnon-emptyrequired

The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.

Example: "Manitoba"
pickup_address.​postal_codestring(postal_code)non-emptyrequired

postal code

Example: "78756-3717"
pickup_address.​country_codestring(country_code)= 2 charactersrequired

A two-letter ISO 3166-1 country code

Example: "CA"
pickup_address.​address_residential_indicatorstring(address_residential_indicator)required

Indicates whether this is a residential address.

Default "unknown"
Enum"unknown""yes""no"
Example: "yes"
contact_detailsobject(contact_details)required
contact_details.​namestringnon-emptyrequired
Example: "Jonh"
contact_details.​emailstring(email)(email)non-emptyrequired

An email address.

Example: "john.doe@example.com"
contact_details.​phonestring>= 7 charactersrequired

Phone number associated

Example: "89876752562"
pickup_notesstring>= 0 characters

Used by some carriers to give special instructions for a package pickup

Example: "call before 15:00"
pickup_windowsArray of objects(pickup_windows)read-only

An array of available pickup windows. Carriers can return multiple times that they will pickup packages.

request_idstring(uuid)(uuid)= 36 characters^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...required

A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur

Example: "aa3d8e8e-462b-4476-9618-72db7f7b7009"
errorsArray of objects(error)read-onlyrequired

The errors associated with the failed API call

errors[].​error_sourcestring(error_source)required

The source of the error, as indicated by the name this informs us if the API call failed because of the carrier, the order source, or the ShipStation API itself.

Enum"carrier""order_source""ShipStation"
errors[].​error_typestring(error_type)required

The type of error

Enum"account_status""business_rules""validation""security""system""integrations"
errors[].​error_codestring(error_code)required

The error code specified for the failed API Call

Enum"auto_fund_not_supported""batch_cannot_be_modified""carrier_conflict""carrier_disconnected""carrier_not_connected""carrier_not_supported""confirmation_not_supported""default_warehouse_cannot_be_deleted""field_conflict""field_value_required"
errors[].​messagestringnon-emptyread-onlyrequired

An error message associated with the failed API call

Example: "Body of request cannot be null."
errors[].​field_namestringread-only

The name of the field that caused the error (only present for validation errors)

Example: "inventory_warehouse_id"
errors[].​field_valuestringread-only

The invalid value that was provided for the field (only present for validation errors)

Example: "invalid-id"
Response
application/json
{
  "pickup_id": "pik_3YcKU5zdtJuCqoeNwyqqbW",
  "label_ids": [
    "se-28529731"
  ],
  "created_at": "2018-09-23T15:00:00.000Z",
  "cancelled_at": "2018-09-23T15:00:00.000Z",
  "carrier_id": "se-1234567",
  "confirmation_number": "292513CL4A3",
  "warehouse_id": "se-28529731",
  "pickup_address": {
    "name": "John Doe",
    "phone": "+1 204-253-9411 ext. 123",
    "email": "example@example.com",
    "company_name": "The Home Depot",
    "address_line1": "1999 Bishop Grandin Blvd.",
    "address_line2": "Unit 408",
    "address_line3": "Building #7",
    "city_locality": "Winnipeg",
    "state_province": "Manitoba",
    "postal_code": "78756-3717",
    "country_code": "CA",
    "address_residential_indicator": "yes"
  },
  "contact_details": {
    "name": "Jonh",
    "email": "email@email.com",
    "phone": "89876752562"
  },
  "pickup_notes": "call before 15:00",
  "pickup_windows": [
    { … }
  ],
  "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009",
  "errors": [
    { … }
  ]
}

Delete a scheduled pickup

Request

Delete a previously-scheduled pickup by ID

Security
api_keys
Path
pickup_idstring(pickup_resource_id)>= 4 charactersrequired

Pickup Resource ID

Example: pik_3YcKU5zdtJuCqoeNwyqqbW
curl -i -X DELETE \
  https://docs.shipstation.com/_mock/openapi/v2/pickups/pik_3YcKU5zdtJuCqoeNwyqqbW \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Return the pickup_id of the scheduled pickup that was successfully deleted

Bodyapplication/json
request_idstring(uuid)(uuid)= 36 characters^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...required

A UUID that uniquely identifies the request id. This can be given to the support team to help debug non-trivial issues that may occur

Example: "aa3d8e8e-462b-4476-9618-72db7f7b7009"
errorsArray of objects(error)read-onlyrequired

The errors associated with the failed API call

errors[].​error_sourcestring(error_source)required

The source of the error, as indicated by the name this informs us if the API call failed because of the carrier, the order source, or the ShipStation API itself.

Enum"carrier""order_source""ShipStation"
errors[].​error_typestring(error_type)required

The type of error

Enum"account_status""business_rules""validation""security""system""integrations"
errors[].​error_codestring(error_code)required

The error code specified for the failed API Call

Enum"auto_fund_not_supported""batch_cannot_be_modified""carrier_conflict""carrier_disconnected""carrier_not_connected""carrier_not_supported""confirmation_not_supported""default_warehouse_cannot_be_deleted""field_conflict""field_value_required"
errors[].​messagestringnon-emptyread-onlyrequired

An error message associated with the failed API call

Example: "Body of request cannot be null."
errors[].​field_namestringread-only

The name of the field that caused the error (only present for validation errors)

Example: "inventory_warehouse_id"
errors[].​field_valuestringread-only

The invalid value that was provided for the field (only present for validation errors)

Example: "invalid-id"
pickup_idstring(pickup_resource_id)>= 4 charactersrequired

Pickup Resource ID

Example: "pik_3YcKU5zdtJuCqoeNwyqqbW"
Response
application/json
{
  "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009",
  "errors": [
    { … }
  ],
  "pickup_id": "pik_3YcKU5zdtJuCqoeNwyqqbW"
}

Package Types

Create custom package types to use for your shipments, rather than the carriers' default package types.

Operations

Products

Manage products in your ShipStation account. Products represent the items you sell and ship to customers.

Operations

Rates

Quickly compare rates using the Rates endpoint. You can see and compare rates for the carriers connected to your account (as long as they support sending rates).

Operations

Shipments

Shipments are at the core of most ShipStation capabilities. Shipment objects are required for cretaing labels and manifests, as well as getting rates.

Operations

Tags

Tags are text-based identifiers you can add to shipments to help in your shipment management workflows.

Operations

Totes

Manage totes (bins or containers) used in warehouse picking and packing operations. Create, update, delete totes and track tote quantities by warehouse.

Operations

Tracking

Use the tracking endpoint to stop receiving tracking updates (more dedicated tracking endpoint methods coming soon).

Operations

Warehouses

Get warehouse details like warehouse ID and related addresses using the warehouses endpoint.

Operations

Users

Manage and retrieve user information for the ShipStation account. This endpoint allows you to list users with various filtering options.

Operations

Webhooks

Webhooks are a powerful feature that can save you from sending repeated polling requests to check on the state of something. With webhooks, ShipStation will automatically contact your servers when the stage changes. This can include parcel tracking events, notification when a batch operation completes, and more.

Operations