--- title: "Get pickup by id" method: GET path: "/v2/pickups/{pickup_id}" tags: ["package_pickups"] --- # Get pickup by id `GET /v2/pickups/{pickup_id}` Get Pickup By ID ## Response `200` The request was a success. - object — An error response body - `pickup_id` string, required — Pickup Resource ID - `label_ids` SeId[], required — Label IDs that will be included in the pickup request - `created_at` string, date-time, required — An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. - `cancelled_at` string, date-time — An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. - `carrier_id` string, required — A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc. - `confirmation_number` string, required — The carrier confirmation number for the scheduled pickup. - `warehouse_id` string, required — A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc. - `pickup_address` Address, required — A complete or partial mailing address. - `name` string — The name of a contact person at this address. This field may be set instead of - or in addition to - the `company_name` field. - `phone` string — The phone number of a contact person at this address. The format of this phone number varies depending on the country. - `email` string — Email for the address owner. - `company_name` string — If this is a business address, then the company name should be specified here. - `address_line1` string — The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. - `address_line2` string — The second line of the street address. For some addresses, this line may not be needed. - `address_line3` string — The third line of the street address. For some addresses, this line may not be needed. - `city_locality` string — The name of the city or locality - `state_province` string — The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. - `postal_code` string — postal code - `country_code` string — A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) - `address_residential_indicator` 'unknown' | 'yes' | 'no' — Indicates whether an address is residential. - `contact_details` object, required - `name` string, required - `email` string, email, required — An email address. - `phone` string, required — Phone number associated - `pickup_notes` string, required — Used by some carriers to give special instructions for a package pickup - `pickup_window` object, required — The desired time range for the package pickup. - `start_at` string, date-time, required — An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. - `end_at` string, date-time, required — An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. - `pickup_windows` object[] — An array of available pickup windows. Carriers can return multiple times that they will pickup packages. - `start_at` string, date-time — An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. - `end_at` string, date-time — An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time. - `request_id` string, uuid, required — A UUID (a.k.a. GUID) that uniquely identifies a resource - `errors` Error[], required — The errors associated with the failed API call - `error_source` 'carrier' | 'order_source' | 'ShipStation' | 'shipengine', 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, the ShipStation API itself, or the underlying ShipEngine platform. - `error_type` 'account_status' | 'business_rules' | 'validation' | 'security' | 'system' | 'integrations', required — The type of error - `error_code` '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' | 'forbidden' | 'identifier_conflict' | 'identifiers_must_match' | 'insufficient_funds' | 'invalid_address' | 'invalid_billing_plan' | 'invalid_field_value' | 'invalid_identifier' | 'invalid_status' | 'invalid_string_length' | 'label_images_not_supported' | 'meter_failure' | 'order_source_not_active' | 'rate_limit_exceeded' | 'refresh_not_supported' | 'request_body_required' | 'return_label_not_supported' | 'settings_not_supported' | 'subscription_inactive' | 'terms_not_accepted' | 'tracking_not_supported' | 'trial_expired' | 'unauthorized' | 'unknown' | 'unspecified' | 'verification_failure' | 'warehouse_conflict' | 'webhook_event_type_conflict' | 'customs_items_required' | 'incompatible_paired_labels' | 'invalid_charge_event' | 'invalid_object' | 'no_rates_returned' | 'freight_connection_inactive' | 'freight_provider_id_required' | 'freight_shipment_not_found' | 'freight_tracking_not_available' | 'freight_tracking_not_found' | 'freight_shipment_not_batchable', required — The error code specified for the failed API Call - `message` string, required — An error message associated with the failed API call - `field_name` string — The name of the field that caused the error (only present for validation errors) - `field_value` string — The invalid value that was provided for the field (only present for validation errors) ## Other responses - `400` — The request contained errors. - `404` — The specified resource does not exist. - `500` — The request was successful. --- [API](https://skmtc.net/shipstation/apis/shipstation-api-v2.md) · [All operations](https://skmtc.net/shipstation/apis/shipstation-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipstation/shipstation-api-v2/revisions/d3d8c21cd227/schema)