# CloseDoc

### Generalità

La **CloseDoc** è un endpoint custom che usato in alcune situazioni particolari

{% hint style="info" %}
**ATTENZIONE!** NON sostituisce la [shipmentConfirm](https://apidocs.gsped.com/spedizioni-e-dintorni/shipment-confirm) (che rimane necessaria) e va fatta PRIMA della shipmentConfirm per aggiornare i dati sul nostro sistema prima che vengano trasmessi al corriere con la conferma della spedizione.
{% endhint %}

{% hint style="warning" %}
È valido solamente sui corrieri della tabella seguente
{% endhint %}

<table><thead><tr><th width="196.33333333333331">ID Corriere Gsped</th><th width="235">Corriere</th><th>Note</th></tr></thead><tbody><tr><td>1</td><td>BRT</td><td>Solo soluzione B o B2</td></tr><tr><td>70-79</td><td>Corrieri Dummy</td><td></td></tr><tr><td>90</td><td>Italsempione</td><td></td></tr><tr><td>91</td><td>Logisticando</td><td></td></tr><tr><td>93</td><td>Ribosped</td><td></td></tr><tr><td>94</td><td>Zust - Tiesse</td><td></td></tr><tr><td>95</td><td>Lynx</td><td></td></tr><tr><td>97</td><td>Speditalia</td><td></td></tr><tr><td>100</td><td>Arco</td><td>Disponibile entro metà maggio</td></tr><tr><td>101</td><td>GLS</td><td></td></tr><tr><td>105</td><td>SDA</td><td>Solo se soluzione InvioSystem</td></tr><tr><td>131</td><td>Fercam</td><td></td></tr><tr><td>144</td><td>Dimotrans</td><td></td></tr><tr><td>151</td><td>Malga</td><td></td></tr><tr><td>164</td><td>Ceva</td><td></td></tr><tr><td>165</td><td>Bianchi Trasporti</td><td></td></tr><tr><td>172</td><td>Nippon Express</td><td></td></tr><tr><td>174</td><td>Aldieri</td><td></td></tr><tr><td>179</td><td>Liccardi</td><td></td></tr><tr><td>186</td><td>Susa</td><td></td></tr></tbody></table>

La CloseDoc consente di impostare lo stesso valore di *ddt\_alpha* (riferimento mittente alfanumerico) su tutte le spedizioni con lo stesso *ddt\_num*, di impostare il contrassegno e il valore doganale sulla spedizione complessiva raggruppata usando i meccanismi di accorpamento del corriere.

Tipico caso d'uso: etichettatura dei singoli colli con una chiamata alla shipment per ogni collo con ddt\_num sempre uguale per ogni collo, dopo la stampa dell'etichetta del singolo collo il sistema del magazzino genera il numero di DDT, determina se la spedizione deve essere in contrassegno ed esegue la chiamata alla CloseDoc passando il numero di DDT e l'eventuale contrassegno da impostare sulla spedizione raggruppata.

### Prerequisiti

Prerequisito per l'uso della CloseDoc è il passaggio dello stesso valore di ddt\_num (riferimento mittente numerico) per tutte le spedizioni create con la POST all'endpoint [shipment](https://apidocs.gsped.com/spedizioni-e-dintorni/shipment), questo valore consentirà al nostro sistema di identificare le spedizioni da aggiornare quando riceve la chiamata alla CloseDoc.

### Funzionamento

## Aggionamento spedizione dato un ddt\_num

<mark style="color:green;">`POST`</mark> `https://api.gsped.it/[istanza]/closeDoc`

Body in JSON.

#### Request Body

| Name                                         | Type   | Description                                                                                                                         |
| -------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- |
| client\_id<mark style="color:red;">\*</mark> | Int    | ID client fornito da Gsped                                                                                                          |
| ddt\_alpha<mark style="color:red;">\*</mark> | String | Riferimento alfanumerico della spedizione                                                                                           |
| valore\_doganale                             | Float  | Valore doganale                                                                                                                     |
| modalita\_incasso                            | Int    | [Tipo incasso contrassegno](https://apidocs.gsped.com/overview/codici-gsped#tipologia-incassi-contrassegno)                         |
| contrassegno                                 | Float  | Valore del contrassegno                                                                                                             |
| ddt\_num<mark style="color:red;">\*</mark>   | String | Riferimento numerico della spedizione                                                                                               |
| corriere                                     | Int    | Eventuale indicazione del corriere per una ricerca più precisa (**Obbligatorio** se si riutilizzano i ddt\_num su corrieri diversi) |

{% tabs %}
{% tab title="200: OK Aggiornamento avvenuto con successo" %}

```javascript
{
    "status": 200
}
```

{% endtab %}

{% tab title="400: Bad Request Payload errato" %}

```json
{
    "error": "Il corriere selezionato non permette la closeDoc"
}
```

{% endtab %}
{% endtabs %}