ShipmentsList

Elenco delle spedizioni

ShipmentsList

Questo endpoint permette di ottenere l'elenco delle spedizioni.

L'utilizzo delle url previousPageUrl e nextPageUrl presenti nella risposta non è obbligatorio ma è consigliato perché permette di velocizzare notevolmente la chiamata.

ShipmentsList

GET https://api.gsped.it/[ISTANZA]/ShipmentsList

Recupera un elenco di spedizioni

Query Parameters

Name	Type	Description
data_da*	Y-m-d H:i:s	seleziona se data_created >= data_da
data_a*	Y-m-d H:i:s	seleziona se datacreated < data_da
corriere	int | array	seleziona se corriere IN [id, id...]
servizio	int | array	seleziona se servizio IN [id, id...]
cliente	int | array	seleziona se client_id IN [id, id...]
fatt_cliente	int | array	seleziona invoiced_client_id IN [id, id...]
nazionale	1/0	1 seleziona se rcpt_country_code = sender_country_code 0 seleziona se rcpt_country_code != sender_country_code
contrassegno	1/0	1 seleziona se contrassegno > 0 0 seleziona se contrassegno <= 0
assicurazione	1/0	1 seleziona se assicurazione > 0 0 seleziona se assicurazione <= 0 OR NULL
confermato	1/0	1 seleziona se confermato = 1 0 seleziona se confermato = 0
documenti	1/0	1 seleziona se documenti = 1 0 seleziona se documenti = 0
reso	1/0	1 seleziona le spedizioni di reso 0 seleziona le spedizioni normali
tipo	1/0	1 seleziona le spedizioni 0 seleziona i ritiri
perPage	1...200	Numero di elementi per pagina. Default: 200
page	int	Numero della pagina richiesta
order	ASC|DESC	Verso dell'ordinamento. Default: DESC
orderBy	string	Nome del campo su cui ordinare i risultati. Default: id Valori possibili: id, corriere, client_id, date_created, invoiced_client_id
status	float	Indica lo stato della spedizione. Deve essere maggiore o uguale a zero

Headers

Name	Type	Description
x-api-key*	String	Apikey fornita da GSPED

200: OK elenco spedizioni

{
    "status": 200,
    "page": 1,
    "totPages": 3,
    "totEntries": 6,
    "entries": 2,
    "payload": [
        {...},
        {...},
    ],
    "previousPageUrl": null,
    "nextPageUrl": "http://apistaging.gsped.it/testbed/shipments?corriere%5B0%5D=1&corriere%5B1%5D=104&perPage=2&page=2&totEntries=6"
}

400: Bad Request Errore input

{
    "status": 400,
    "error" => "Testo descrittivo dell'errore",
}

403: Forbidden Apikey invalida

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

Snippets codice di esempio

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gsped.it/sandbox/ShipmentsList",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => "",
  CURLOPT_HTTPHEADER => [
    "x-api-key: YOUR-API-KEY"
  ],
]);

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

curl_close($curl);

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

PYTHON

import http.client

conn = http.client.HTTPSConnection("api.gsped.it")

payload = ""

headers = { 'x-api-key': "YOUR-API-KEY" }

conn.request("GET", "/sandbox/ShipmentsList", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

GO

package main

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

func main() {

	url := "https://api.gsped.it/sandbox/ShipmentsList"

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

	req.Header.Add("x-api-key", "YOUR-API-KEY")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}

C#

// Some codevar client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.gsped.it/sandbox/ShipmentsList"),
    Headers =
    {
        { "x-api-key", "YOUR-API-KEY" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

cURL

curl --request GET \
  --url 'https://api.gsped.it/sandbox/ShipmentsList' \
  --header 'x-api-key: YOUR-API-KEY'