--- title: "Retrieve a shipment" url: "https://docs.unified.to/shipping/shipment/Retrieve_a_shipment" description: "API reference for Retrieve a shipment. Launch multiple pre-built Shipment integrations today with zero maintenance — all through a single API." generated_at: "2026-05-29T17:54:05.666Z" --- # Retrieve a shipment GET/shipping/{connection\_id}/shipment/{id} ## Parameters **fields**string array id created\_at updated\_at order\_id from\_address to\_address packages carrier\_id service\_code status rate\_id label\_id tracking\_id shipped\_at rate\_amount rate\_currency rate\_service\_name rate\_estimated\_days rate\_estimated\_delivery\_at is\_rate\_guaranteed return\_address return\_authorization\_number warehouse\_location\_id warehouse\_location\_name customs is\_international insurance special\_instructions is\_signature\_required is\_adult\_signature\_required reference\_number is\_return original\_shipment\_id return\_reason return\_type raw Fields to return **raw**string Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar **connection\_id**string required ID of the connection **id**string required ID of the Shipment ## Returns [ShippingShipment](/shipping/shipment/model) **id**string Unique identifier for this shipment object **created\_at**date The date that this shipment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **updated\_at**date The last date that this shipment object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **order\_id**string Reference to commerce\_order or accounting\_order **from\_address**object Origin address **to\_address**object Destination address **packages** array Array of packages in this shipment **carrier\_id**string Reference to the carrier **service\_code**string Code for the shipping service used **status** enum Valid values: "PENDING" "PROCESSING" "IN\_TRANSIT" "DELIVERED" "EXCEPTION" Current status of the shipment **rate\_id**string Optional reference to the selected rate (for traceability) **label\_id**string Optional reference to the shipping label **tracking\_id**string Optional reference to the tracking information **shipped\_at**date When shipment was createddispatched (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **rate\_amount**number The rate amount used (may differ from shipping\_cost due to adjustments) **rate\_currency**string Currency for rate\_amount **rate\_service\_name**string Service name from the rate (e.g., "Priority Mail") **rate\_estimated\_days**number Estimated delivery days from the rate **rate\_estimated\_delivery\_at**date Estimated delivery date from the rate (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **is\_rate\_guaranteed**boolean Whether delivery is guaranteed (from rate) **return\_address**object Return address (may differ from from\_address) **return\_authorization\_number**string RMA number if return shipment **warehouse\_location\_id**string Origin warehouselocation ID; points to CommerceLocation **warehouse\_location\_name**string Origin warehouse location name **customs**object Customs information **is\_international**boolean Whether shipment is international **insurance**object Insurance details **special\_instructions**string array Array of special instructions **is\_signature\_required**boolean Signature required on delivery **is\_adult\_signature\_required**boolean Adult signature required **reference\_number**string Customer reference number **is\_return**boolean Whether this is a return shipment **original\_shipment\_id**string Reference to original shipment if return; points to ShippingShipment **return\_reason**string Reason for return **return\_type** enum Valid values: "CUSTOMER" "VENDOR" "WARRANTY" "DEFECTIVE" "OTHER" Type of return **raw**any The raw data returned by the integration for this shipment ## Code Samples ### Node.js SDK ``` import { UnifiedTo } from '@unified-api/typescript-sdk'; const sdk = new UnifiedTo({ security: { jwt: '', }, }); const connectionId = '5de520f96e439b002043d8dc'; const id = '1234'; const results = await sdk.shipping.getShippingShipment({ connectionId, id, fields: '', raw: '', }); ``` ### Node.js (axios) ``` const options = { method: 'GET', url: 'https://api.unified.to/shipping/5de520f96e439b002043d8dc/shipment/5de520f96e439b002043d8d8', headers: { authorization: 'bearer .....' }, params: { fields: '', raw: '', } }; const results = await axios.request(options); ``` ### Java ``` AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("GET", "https://api.unified.to/shipping/5de520f96e439b002043d8dc/shipment/5de520f96e439b002043d8d8?fields=&raw=") .setHeader("accept", "application/json") .setHeader("authorization", ".....") .execute() .toCompletableFuture() .thenAccept(System.out::println) .join(); client.close(); ``` ### Go ``` import ( "fmt" "net/http" "io/ioutil" ) url := `https://api.unified.to/shipping/5de520f96e439b002043d8dc/shipment/5de520f96e439b002043d8d8?fields=&raw= req, _ := http.NewRequest("GET", url, nil) req.Header.Add("accept", "application/json") req.Header.Add("authorization", ".....") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) ``` ### Python ``` import requests url = "https://api.unified.to/shipping/5de520f96e439b002043d8dc/shipment/5de520f96e439b002043d8d8?fields=&raw=" headers = { "accept": "application/json", "authorization": "....." } response = requests.get(url, headers=headers) ``` ### PHP ``` $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/shipping/5de520f96e439b002043d8dc/shipment/5de520f96e439b002043d8d8?fields=&raw=", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: ....." ], ]); ``` ### Ruby ``` require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/shipping/5de520f96e439b002043d8dc/shipment/5de520f96e439b002043d8d8?fields=&raw=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["authorization"] = '....' response = http.request(request) puts response.read_body ``` ### cURL ``` curl --request GET \ --url 'https://api.unified.to/shipping/5de520f96e439b002043d8dc/shipment/5de520f96e439b002043d8d8?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```