api/shipments

Description

Delete an unprocessed consignment from the system.

Request

• Method: GET
• Content Type: application/json
• URL: https://api.gosweetspot.com/api/shipments

Headers

• access_key : your unqiue api key provided by GSS.
• site_id : which site you are requesting action for.

Parameters

Parameter	Type	Description
id	string	A comma seperated list of consignment numbers to be deleted. A maximum of 50 consignments can be deleted per call.

Return format

A JSON object array, with consignment number and assosiated outcome

Valid outcome states are:

• Invalid ticket number
• Cannot be deleted. Already deleted.
• Cannot be deleted. Already delivered.
• Cannot be deleted. Already in transit.
• Cannot be deleted. Already manifested.

Errors

Http 409 - Max consignment limit 50 exceeded.

Request example

curl --location --request DELETE 'https://api.gosweetspot.com/api/shipments?id=SSPOT014115%2CSSPOT014114%2CSSPOT014113%2CSSPOT014112' \
--header 'access_key;' \
--header 'site_id;' \
--header 'Content-Type: application/json'

Response example

{
  "SSPOT014112": "Deleted",
  "SSPOT014113": "Deleted",
  "SSPOT014114": "Cannot be deleted. Already deleted.",
  "SSPOT014115": "Cannot be deleted. Already deleted."
}