Retrieve Shipment Details

curl --request GET \
  --url https://api.perform.ai/v5/shipment/details/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.perform.ai/v5/shipment/details/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.perform.ai/v5/shipment/details/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.perform.ai/v5/shipment/details/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.perform.ai/v5/shipment/details/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.perform.ai/v5/shipment/details/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.perform.ai/v5/shipment/details/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "api_response": "<string>",
  "data": {
    "shipment_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "shipment_id": "<string>",
    "shipment_reference": "<string>",
    "additional_reference": "<string>",
    "tracking_number": "<string>",
    "carrier_reference": "<string>",
    "carrier": {
      "id": "<string>",
      "name": "<string>",
      "country_iso": [
        "<string>"
      ],
      "language": [
        "<string>"
      ],
      "supported_languages": [
        "<string>"
      ],
      "contact": "<string>",
      "site_link": "<string>"
    },
    "created_date": "<string>",
    "updated_date": "<string>",
    "source": "<string>",
    "status": "<string>",
    "current_phase": {
      "name": "<string>",
      "key": "<string>"
    },
    "tags": [
      "<string>"
    ],
    "notification_email": [
      "<string>"
    ],
    "notification_phone": [
      "<string>"
    ],
    "tracking_page_reference": "<string>",
    "order": {
      "order_uuid": "<string>",
      "order_id": "<string>",
      "order_reference": "<string>",
      "source_type": "<string>",
      "source_name": "<string>",
      "created_date": "<string>",
      "updated_date": "<string>"
    },
    "recipient_address": {
      "address_name": "<string>",
      "location_type": "<string>",
      "entity_reference": "<string>",
      "salutation": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "line3": "<string>",
      "street_name": "<string>",
      "house_number": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "state_or_province": "<string>",
      "region": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "fax": "<string>",
      "company": "<string>",
      "tax_id": "<string>",
      "full": "<string>"
    },
    "sender_address": {
      "address_name": "<string>",
      "location_type": "<string>",
      "entity_reference": "<string>",
      "salutation": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "line3": "<string>",
      "street_name": "<string>",
      "house_number": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "state_or_province": "<string>",
      "region": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "fax": "<string>",
      "company": "<string>",
      "tax_id": "<string>",
      "full": "<string>"
    },
    "to_address": {
      "address_name": "<string>",
      "location_type": "<string>",
      "entity_reference": "<string>",
      "salutation": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "line3": "<string>",
      "street_name": "<string>",
      "house_number": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "state_or_province": "<string>",
      "region": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "fax": "<string>",
      "company": "<string>",
      "tax_id": "<string>",
      "full": "<string>"
    },
    "from_address": {
      "address_name": "<string>",
      "location_type": "<string>",
      "entity_reference": "<string>",
      "salutation": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "line3": "<string>",
      "street_name": "<string>",
      "house_number": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "state_or_province": "<string>",
      "region": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "fax": "<string>",
      "company": "<string>",
      "tax_id": "<string>",
      "full": "<string>"
    },
    "return_address": {
      "address_name": "<string>",
      "location_type": "<string>",
      "entity_reference": "<string>",
      "salutation": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "line3": "<string>",
      "street_name": "<string>",
      "house_number": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "state_or_province": "<string>",
      "region": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "fax": "<string>",
      "company": "<string>",
      "tax_id": "<string>",
      "full": "<string>"
    },
    "shipment_value": {
      "amount": 123,
      "currency": "<string>"
    },
    "total_shipping_cost": {
      "amount": 123,
      "currency": "<string>"
    },
    "shipping_costs": [
      {
        "name": "<string>",
        "reference": "<string>",
        "unit_quantity": 123,
        "unit_cost": {
          "amount": 123,
          "currency": "<string>"
        },
        "total_cost": {
          "amount": 123,
          "currency": "<string>"
        }
      }
    ],
    "cod_value": {
      "amount": 123,
      "currency": "<string>"
    },
    "dimensions": {
      "length": 123,
      "width": 123,
      "height": 123,
      "unit": "<string>"
    },
    "weight": {
      "amount": 123,
      "unit": "<string>"
    },
    "linked_shipments": [
      {
        "tracking_number": "<string>",
        "carrier_reference": "<string>",
        "carrier": {
          "id": "<string>",
          "name": "<string>",
          "country_iso": [
            "<string>"
          ],
          "language": [
            "<string>"
          ],
          "supported_languages": [
            "<string>"
          ],
          "contact": "<string>",
          "site_link": "<string>"
        }
      }
    ],
    "expected_delivery": {
      "from": "<string>",
      "to": "<string>"
    },
    "payment_type": "<string>",
    "item_count": 123,
    "packaging_type": "<string>",
    "note": "<string>",
    "shipping_service": "<string>",
    "description_of_goods": "<string>",
    "handling_instructions": "<string>",
    "sales_channel": "<string>",
    "documents": [
      {
        "document_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "document_id": "<string>",
        "name": "<string>",
        "type": "<string>",
        "file_format": "<string>",
        "created_date": "<string>",
        "additional_info": {}
      }
    ],
    "all_events": [
      {
        "event": "<string>",
        "event_key": "<string>",
        "phase": "<string>",
        "phase_key": "<string>",
        "time": "<string>",
        "timezone": "<string>",
        "carrier_name": "<string>",
        "location": {
          "place": "<string>"
        },
        "additional_info": {}
      }
    ],
    "additional_info": {}
  }
}

{
  "api_response": "4030",
  "message": "validation_error",
  "errors": {
    "shipment_uuid": [
      "Either shipment_uuid or shipment_id is required."
    ]
  }
}

{
  "api_response": 403,
  "message": "Key not authorized"
}

{
  "api_response": "4041",
  "message": "No results found with the provided search parameters"
}

{
  "api_response": 429,
  "message": "Throttled"
}

{
  "api_response": "500",
  "message": "System error"
}