Cancel delivery request

The delivery’s ID must match the trip_id used on the delivery creation route.

Authentification

TIP

  • api_key and partner_id in header
  • api_key and partner in body

Routes

Routesurl
Testshttps://partners-api-preprod.shopopop.com/deliveries/{tripId}/cancelopen in new window
Prodhttps://partners-api.shopopop.com/deliveries/{tripId}/cancelopen in new window

Method

VerbPOST

Path

PathtripId : string

Headers

Headertype
api_keystring
partner_idstring

Will be given when testing phase is ready

Response

HTTP STATUS 200

void

HTTP STATUS 404

{
  "error": true,
  "errorDesc: ["ERRAND_NOT_FOUND"] the delivery cannot be found.
}

HTTP STATUS 403

Access not authorized, the api_key and/or the partner_id are incorrect.

HTTP STATUS 400

{
  "error": true,
  "errorDesc: ["DELETE_DELAY_TIMEOUT"] // Cannot cancel a delivery done after 47h.
}

HTTP STATUS 500

{
  "error": true,
  "errorDesc: ["ERRAND_UPDATE_IMPOSSIBLE"]
}

HTTP STATUS 500

{
  "error": true,
  "errorDesc: ["INTERNAL_ERROR"] // internal error, contact us.
}