CloseDoc

General Information

The CloseDoc is a custom endpoint used in special cases.

PLEASE NOTE: It stays not for [shipmentConfirm] (shipment-confirm.md) (still required) and must be performed before the shipmentConfirm to update the data of the shipment, to be sent to the courier together with the confirmation.

The enabled couriers are:

Gsped courier IDCourierNotes

1

BRT

Only B / B2 solution

70-79

Corrieri Dummy

90

Italsempione

91

Logisticando

93

Ribosped

94

Zust - Tiesse

95

Lynx

97

Speditalia

100

Arco

Available by mid-May

101

GLS

105

SDA

Only InvioSystem solution

131

Fercam

144

Dimotrans

151

Malga

164

Ceva

165

Bianchi Trasporti

172

Nippon Express

174

Aldieri

179

Liccardi

186

Susa

If different shipments have the same ddt_num, the Closedoc allows to set the same ddt_alpha value (alphanumeric sender reference), the COD and the custom value on a grouped shipment using the courier's unification solutions.

Example: after a call to the shipment for a specific ddt_num each parcel has been labeled with the same ddt_num. After the label printing for each parcel the warehouse system generates the DDT number, determines whether the shipment has to be with COD and calls the CloseDoc, setting the DDT number and the COD (if required) to be put on the grouped shipment.

Prerequisites

The fundamental prerequisite to using the CloseDoc is the use of the same ddt_num (numeric sender reference) for all the shipments created with the POST at the endpoint shipment. This value allows our system to identify the shipments to update in case of CloseDoc call.

How does it work

Shipment update for a ddt_num

POST https://api.gsped.it/[INSTANCE]/closeDoc

Body in JSON.

Request Body

NameTypeDescription

client_id*

Int

Client ID provided by GSped

ddt_num*

String

Numerical reference of the shipment

ddt_alpha*

String

Alphanumerical reference of the shipment

contrassegno

Float

COD amount

modalita_incasso

Int

valore_doganale

Float

Custom value

{
    "status": 200
}

Last updated