Skip to main content

api/customerorders

Less than 1 minute

api/customerorders

Description

Delete unprocessed customer orders from the system.

Request

  • Method: DEL
  • Content Type: application/json
  • URL: https://api.gosweetspot.com/api/customerorders

Headers

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

Parameters

ParameterTypeDescription
packingslipnostringA comma separated list of orders numbers (packing slip numbers) to be deleted. A maximum of 50 orders can be deleted per call.

Response

A JSON object, with order numbers and associated outcome.

Valid outcome states are:

  • Invalid packing slip number.
  • Cannot be deleted. Already deleted.
  • Cannot be deleted. Already processed.
  • Max delete limit is 50 packing slip numbers.

Request example

curl --location --request DELETE 'https://api.gosweetspot.com/api/customerorders?packingslipno=test%25231234%2Ctest%25231235%2Ctest%25231236' \
--header 'access_key;' \
--header 'site_id;' \
--header 'Content-Type: application/json; charset=utf-8'

Response example

{
  "test#1234": "Cannot be deleted. Already processed.",
  "test#1235": "Cannot be deleted. Already deleted.",
  "test#1236": "Deleted.",
}
Last update: