Shipment API
Method: POST
URL: /api/v1/shipment/set-info
URL: /api/v1/shipment/set-info
Identification
Identification
To update shipment information, add the API access key and Entity ID outside the payload part of the JSON.
access_key (required)
Generate an API Access key at System > Users.
entity_id (required)
After creating an entity, the Entity ID is visible at System > Settings.
Example
Example
{"access_key": "[Clougistic API access key]","entity_id": "[ENTITY - ID] ","payload": {"shipment_id" : "[SHIPMENT - ID] ","info": {"labels_printed": "true","shipper_orderid": 2343434}}}
URL: /api/v1/shipment/get-details
URL: /api/v1/shipment/get-details
To get all shipment information, including all parcels.
access_key (required)
Generate an API Access key at System > Users.
entity_id (required)
After creating an entity, the Entity ID is visible at System > Settings.
Example
Example
{"access_key": "[Clougistic API access key]","entity_id": "[ENTITY - ID]","payload": {"shipment_id": "[id]"}