Pickup (richieste di ritiro)

Gestione ritiri

Pickup - GET

Restituisce informazioni sullo stato di una richiesta di ritiro.

Recuro informazioni ritiro.

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

Query Parameters

Name
Type
Description

id*

Integer

ID del ritiro

Headers

Name
Type
Description

x-api-key*

String

Api Key fornita da Gsped

{
    "status": 2,
    "num_spedizione": "",
    "error": "",
    "id": 70058437,
    "note": "",
    "note_orm": "",
    "num_orm": "CBJ180121002626"
}

Snippets codice di esempio

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.gsped.it/sandbox/pickup?id_sped=12345',
  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;

Pickup - POST

Invia al corriere una richiesta di ritiro.

Attenzione :

Questo endpoint, a meno di errori nei nomi dei campi e/o dati errati risponderà sempre con status code 200, anche nel caso in cui la richiesta di ritiro non sia andata a buon fine.

Verificare sempre il campo status nella risposta della pickup.

Se il valore di questo campo è 0.6 oppure 10 significa che il ritiro non è stato prenotato (nella maggior parte dei casi per orari e date non accettate dal corriere perché non gestibili dal punto di vista operativo).

Infine si tenga conto che non tutti i corrieri rendono disponibile immediatamente l'informazione se il ritiro richiesto è fattibile, verificare con i tecnici di Gsped per i corrieri per cui si vuole usare questo endpoint.

Invia richiesta di ritiro

POST https://api.gsped.it/[ISTANZA]/pickup

Headers

Name
Type
Description

Content-Type*

String

application/json

x-api-key*

String

Api Key fornita da Gsped

Request Body

Name
Type
Description

client_id*

Integer

ID dell'anagrafica con la quale si vuole generare la spedizione (valore comunicato)

corriere*

Integer

Codice corriere

servizio*

Integer

Codice servizio

colli*

Integer

Numero di colli di cui sarà composta la spedizione

peso*

Float

Peso complessivo in KG

date_req_ritiro*

String

Data di ritiro (YYYY-MM-DD)

opening_time*

String

Ora pronta merce (HH:MM:SS)

closing_time*

String

Ora chiusura (HH:MM:SS)

opening_time2

String

Seconda ora pronta merce (HH:MM:SS) - solo corriere TNT

closing_time2

String

Seconda ora chiusura (HH:MM:SS) - solo corriere TNT

ddt_alpha

String

Riferimento cliente alfanumerico

ddt_num

Integer

Riferimento cliente numerico

sender_name

String

Nome/denominazione/ragione sociale del mittente

sender_addr

String

Indirizzo mittente (via + numero civico)

sender_cap

String

CAP mittente

sender_city

String

Località mittente

sender_contact

String

Persona di riferimento presso il mittente

sender_email

String

Email del mittente

sender_prov

String

Provincia del mittente (sigla 2 caratteri)

sender_country_code

String

Paese del mittente (sigla ISO 3166-1 alpha-2)

sender_phone

String

Telefono del mittente

rcpt_name

String

Nome/denominazione/ragione sociale del destinatario

note_sender

String

Note mittente

rcpt_addr

String

Indirizzo destinatario (via + numero civico)

rcpt_cap

String

CAP destinatario

rcpt_city

String

Località destinatario

rcpt_prov

String

Provincia del destinatario (sigla 2 caratteri)

rcpt_country_code

String

Paese del destinatario (sigla ISO 3166-1 alpha- 2)

rcpt_contact

String

Persona di riferimento presso il destinatario

rcpt_phone

String

Telefono del destinatario

rcpt_email

String

Email del destinatario

merce

String

Descrizione merce

daticolli

Array

Dettaglio dimensione colli (se disponibili):

daticolli.n_collo

Integer

Numero progressivo

daticolli.altezza

Integer

Altezza in CM

daticolli.larghezza

Integer

Larghezza in CM

daticolli.lunghezza

Integer

Lunghezza in CM

daticolli.peso

Float

Peso in KG

daticolli.volume

Float

Volume in metri cubi

{
    "status": 2,
    "num_spedizione": "",
    "error": "",
    "id": 70061546,
    "note": "",
    "note_orm": "",
    "num_orm": "CBJ180121002626"
}

Snippets codice di esempio

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.gsped.it/sandbox/pickup',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
  "client_id": 390,
  "corriere": 1,
  "servizio": 0,
  "colli": 1,
  "peso": 5,
  "date_req_ritiro": "2022-01-14",
  "opening_time": "09:00",
  "closing_time": "17:30",
  "ddt_alpha": "2001504697",
  "ddt_num": 2001504697,
  "sender_name": "Test mittente",
  "sender_addr": "VIA PRINCIPESSA CLOTILDE, 70",
  "sender_cap": "10134",
  "sender_city": "Torino",
  "sender_contact": "contatto mittente",
  "sender_prov": "TO",
  "sender_country_code": "IT",
  "sender_email": "test@gsped.com",
  "sender_phone": "3208281234",
  "note_sender": "",
  "rcpt_addr": "Via Pier Santi Mattarella, 1",
  "rcpt_cap": "92100",
  "rcpt_city": "AGRIGENTO",
  "rcpt_contact": "contatto destinatario",
  "rcpt_country_code": "IT",
  "rcpt_email": "test@gsped.com",
  "rcpt_name": "test destinatario",
  "rcpt_phone": "0922601234",
  "rcpt_prov": "AG",
  "merce": "Articoli arredamento",
  "daticolli": [
    {
      "n_collo": 1,
      "altezza": 50,
      "larghezza": 35,
      "lunghezza": 25,
      "peso": 10,
      "volume": 0.014
    }
  ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'x-api-key: YOUR-API-KEY'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
PreviousShipment ReferencesNextPOD (prove di consegna)

Last updated