Shipment By DDT Num

Shipment by DDT Num - GET

This endpoint returns the shipment information together with their labels in the available formats, exactly as Shipment - GET, but using the numeric reference as a query parameter.

To use this endpoint the numeric reference must be unique in order

If the user to whom the apikey is associated operates with several usernames and the numeric references risk to be identical, it is possible to use the additional parameter client_id, valorised with the whole one indicating on which data to further filter the query.

The list of the client_id of a user is given by Gsped at the end of each configuration.

Retrieve shipment information

GET https://api.gsped.it/[INSTANCE]/ShipmentByDdtnum

Query Parameters

Name

Type

Description

ddt_num*

Integer

Numeric reference of the shipment

client_id

String

Client ID

Headers

Name

Type

Description

x-api-key*

String

API Key given by Gsped

{
  "client_id": 390,
  "cod_destinatario": "",
  "colli": 1,
  "contrassegno": 0,
  "corriere": 1,
  "date_req_cons": "0000-00-00 00:00:00",
  "ddt_alpha": "ONLINES69512708",
  "ddt_num": 123,
  "merce": "Informatica",
  "note_sender": "",
  "origine": "",
  "peso": 1.5,
  "preavviso_telefonico": "",
  "rcpt_addr": "via gandhi",
  "rcpt_cap": 83020,
  "rcpt_city": "sperone",
  "rcpt_contact": "danilo",
  "rcpt_country_code": "IT",
  "rcpt_email": "[email protected]",
  "rcpt_name": "r-store",
  "rcpt_phone": 81,
  "rcpt_prov": "av",
  "servizio": 0,
  "tipo_incasso": 0,
  "valore": 0,
  "valore_doganale": 0,
  "volume": 0,
  "status": 0,
  "fid_partenza": 39,
  "num_serie": 0,
  "num_spedizione": "0",
  "date_upd": "0000-00-00 00:00:00",
  "error": "",
  "sender_name": "TEST mittente",
  "sender_addr": "Via Stilicone 20",
  "sender_cap": 20154,
  "sender_city": "Milano",
  "sender_contact": "TEST contatto",
  "sender_prov": "MI",
  "sender_country_code": "IT",
  "sender_email": "[email protected]",
  "label_jpg": [
    "/9j/4AAQSkZJRgA...AAAAAD/9k="
  ],
  "label_pdf": [
    "JVBERi0xLjQKJeL...Tk4CiGCg=="
  ],
  "label_zpl": [
    "^XA\r^LH20,20^P....^LH0,0^XZ"
  ],
  "id": 68409660,
  "daticolli": [
    {
      "peso": 1.5,
      "volume": 0,
      "larghezza": 0,
      "lunghezza": 0,
      "altezza": 0,
      "n_collo": 1,
      "barcode": ""
    }
  ],
  "tnt_options": [],
  "tracking_link": "https://vas.brt.it/vas/sped_ricDocMit_load.hsm?KSU=1234567&DocMit=000000000000123",
  "sender_phone": 131349123,
  "dropshipping": 0,
  "valuta": "",
  "al_piano": "",
  "al_sabato": "",
  "reso_contestuale": "",
  "fermo_deposito": 0,
  "note": "",
  "centro_costo": "",
  "sda_servizio": "",
  "date_req_ritiro": "2022-01-18 00:00:00",
  "opening_time": "09:00:00",
  "closing_time": "18:00:00",
  "barcode": "T68409660",
  "ups_uap_id": "",
  "sda_id_fermoposta": "",
  "flag_reso": 0,
  "note_2": "",
  "documenti": 0,
  "brt_num_segnacollo_da": 108,
  "brt_num_segnacollo_a": 108,
  "confermato": 0,
  "ups_signature_required": 0,
  "id_pickup": null,
  "data_consegna_prevista": "0000-00-00 00:00:00",
  "sda_accessori": 0,
  "codice_merce_fercam": "C",
  "milkman_tracking_code": 0,
  "opening_time2": null,
  "closing_time2": null,
  "chi_paga": 0,
  "dangerous_goods": "",
  "vat_seller": "",
  "vat_buyer": "",
  "generic_service_point": "",
  "user_id": 0,
  "sender_eori": "",
  "rcpt_eori": "",
  "link_pickup_booking": ""
}

{
    "error": "DDT_num spedizione non indicata(1)"
}

{
    "status": false,
    "error": "Invalid API key "
}

{
    "error": "Spedizione non trovata (10)"
}

Example Snippets

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.gsped.it/sandbox/ShipmentByDdtnum?ddt_num=123',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'x-api-key: YOUR-API-KEY'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import http.client

conn = http.client.HTTPSConnection("api.gsped.it")
payload = ''
headers = {
  'x-api-key': 'YOUR-API-KEY'
}
conn.request("GET", "/sandbox/ShipmentByDdtnum?ddt_num=123", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

package main

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

func main() {

  url := "https://api.gsped.it/sandbox/ShipmentByDdtnum?ddt_num=123"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("x-api-key", "YOUR-API-KEY")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

var client = new RestClient("https://api.gsped.it/sandbox/ShipmentByDdtnum?ddt_num=123");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "YOUR-API-KEY");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

curl --location --request GET 'https://api.gsped.it/sandbox/ShipmentByDdtnum?ddt_num=123' \
--header 'x-api-key: YOUR-API-KEY'