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.
License MIT
Carrier ID
Warehouse ID
Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
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.
curl -i -X GET \ 'https://docs.shipstation.com/_mock/openapi/v2/pickups?carrier_id=se-28529731&created_at_end=2019-08-24T14%3A15%3A22Z&created_at_start=2019-08-24T14%3A15%3A22Z&page=1&page_size=25&warehouse_id=se-28529731' \ -H 'api-key: YOUR_API_KEY_HERE'
The request was a success.
An array of pickups associated with the user's account.
Pickup Resource ID
Label IDs that will be included in the pickup request
An ISO 8601 string that represents a date and time.
An ISO 8601 string that represents a date and time.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
The carrier confirmation number for the scheduled pickup.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
Used by some carriers to give special instructions for a package pickup
Helpful links to other pages of results
A link to a related resource, or an empty object if there is no resource to link to
A link to a related resource, or an empty object if there is no resource to link to
A link to a related resource, or an empty object if there is no resource to link to
A link to a related resource, or an empty object if there is no resource to link to
A UUID (a.k.a. GUID) that uniquely identifies a resource
The errors associated with the failed API call
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.
The type of error
The error code specified for the failed API Call
{ "pickups": [ { … } ], "total": 3, "page": 3, "pages": 4, "links": { "first": { … }, "last": { … }, "prev": { … }, "next": { … } }, "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009", "errors": [ { … } ] }
Label IDs that will be included in the pickup request
Used by some carriers to give special instructions for a package pickup
The desired time range for the package pickup.
An ISO 8601 string that represents a date and time.
An ISO 8601 string that represents a date and time.
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" } }'
The request was a success.
Pickup Resource ID
Label IDs that will be included in the pickup request
An ISO 8601 string that represents a date and time.
An ISO 8601 string that represents a date and time.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
The carrier confirmation number for the scheduled pickup.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A complete or partial mailing address.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
If this is a business address, then the company name should be specified here.
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
The second line of the street address. For some addresses, this line may not be needed.
The third line of the street address. For some addresses, this line may not be needed.
The name of the city or locality
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
A two-letter ISO 3166-1 country code
Used by some carriers to give special instructions for a package pickup
An array of available pickup windows. Carriers can return multiple times that they will pickup packages.
A UUID (a.k.a. GUID) that uniquely identifies a resource
The errors associated with the failed API call
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.
The type of error
The error code specified for the failed API Call
{ "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": "no" }, "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": [ { … } ] }
curl -i -X GET \ 'https://docs.shipstation.com/_mock/openapi/v2/pickups/{pickup_id}' \ -H 'api-key: YOUR_API_KEY_HERE'
The request was a success.
Pickup Resource ID
Label IDs that will be included in the pickup request
An ISO 8601 string that represents a date and time.
An ISO 8601 string that represents a date and time.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
The carrier confirmation number for the scheduled pickup.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A complete or partial mailing address.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
If this is a business address, then the company name should be specified here.
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
The second line of the street address. For some addresses, this line may not be needed.
The third line of the street address. For some addresses, this line may not be needed.
The name of the city or locality
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
A two-letter ISO 3166-1 country code
Used by some carriers to give special instructions for a package pickup
An array of available pickup windows. Carriers can return multiple times that they will pickup packages.
A UUID (a.k.a. GUID) that uniquely identifies a resource
The errors associated with the failed API call
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.
The type of error
The error code specified for the failed API Call
{ "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": "no" }, "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": [ { … } ] }
curl -i -X DELETE \ 'https://docs.shipstation.com/_mock/openapi/v2/pickups/{pickup_id}' \ -H 'api-key: YOUR_API_KEY_HERE'
Return the pickup_id of the scheduled pickup that was successfully deleted
A UUID (a.k.a. GUID) that uniquely identifies a resource
The errors associated with the failed API call
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.
The type of error
The error code specified for the failed API Call
{ "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009", "errors": [ { … } ], "pickup_id": "pik_3YcKU5zdtJuCqoeNwyqqbW" }
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.