For all operations listed below you will need to provide HTTP Request Header Authorization param. For more details see Login/Auth page.

Pull customer completed shipments

Route: /customer_portal/complete_shipments

Method: GET

Query parameters:

  • date_from: required Date in YYYY-MM-DD format
  • date_to: required Date in YYYY-MM-DD format
  • page: integer
  • limit: integer

Example result

{
  "records_found": "23",
  "total_pages": 2,
  "records_per_page": 20,
  "current_page": 1,
  "records_this_page": 20,
  "records": [
    {
      "pp_id": "2162144",
      "actual_delivery_date": "2000-04-03",
      "actual_delivery_time": "17:00:00",
      "ready_date": "2000-03-30",
      "ready_time": "16:00:00",
      "service": "EXP",
      "origin_company": "JASON RIDER STUDIO",
      "origin_street1": "83 CANAL STREET",
      "origin_street2": "",
      "origin_city": "NEW YORK",
      "origin_code": "10002",
      "origin_country": "UNITED STATES",
      "destination_company": "TEST_COMPANY",
      "destination_street1": "18 RUE VANEAU",
      "destination_street2": "",
      "destination_city": "PARIS",
      "destination_code": "75007",
      "destination_country": "FRANCE",
      "pieces_count": "1",
      "origin_name": "JASON RIDER",
      "origin_email": "",
      "destination_name": "HUGO DECANIS",
      "destination_email": "HUGO.DECANIS@TEST_COMPANY.COM",
      "origin_hub": "JFK",
      "destination_hub": "CDG",
      "actual_weight": "6.00",
      "charge_weight": "20.00",
      "invoice_date": "2000-04-10",
      "total": "679.5200",
      "subtotal": "679.5200",
      "minimum_charge": "121.6400",
      "excess_charge": "213.3700",
      "tax": "0.0000",
      "customs_tax": "0.0000",
      "customs_currency": "EUR",
      "customs_duties": "0.0000",
      "commercial_value": "1.0000",
      "requester_name": "HUGO DECANIS",
      "requester_email": "HUGO.DECANIS@TEST_COMPANY.COM",
      "commercial_value_currency": "EUR",
      "branch_name": "PARIS",
      "customer_name": "TEST_COMPANY SA PRESSE EUROPE (EMEA)",
      "customer_account": "PARBAL02",
      "invoice_name": "TEST_COMPANY SA PRESSE EUROPE (EMEA)",
      "invoice_pp_id": "207948",
      "pod_date": "2000-04-03",
      "pod_time": "11:09:33",
      "pod_recipient": "RECIPIENT ",
      "charges": [
        {
          "name": "MINIMUM",
          "charge_value": "121.6400",
          "tax": "0.0000"
        }
      ]
    }

    ... more shipments
  ]
}