Cancel Shipment

POST {{baseUrl}}/shipments/:shipment_id/cancel

This endpoint allows you to cancel specific Shipment by providing the ID of the shipment you want to cancel.

HEADERS

RESPONSES

status: OK

{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":{"id":"\u003cnumber\u003e","order_id":"\u003cnumber\u003e","order_reference_id":"\u003cnumber\u003e","created_at":{"date":"\u003cstring\u003e","timezone_type":"\u003cinteger\u003e","timezone":"\u003cstring\u003e"},"type":"return","courier_id":"\u003cinteger\u003e","courier_name":"\u003cstring\u003e","courier_logo":"\u003cstring\u003e","shipping_number":"\u003cstring\u003e","tracking_number":"\u003cstring\u003e","pickup_id":"\u003cnull\u003e","trackable":"\u003cboolean\u003e","tracking_link":"\u003cstring\u003e","label":{"format":"\u003cstring\u003e","url":"\u003cstring\u003e"},"payment_method":"cod","source":"\u003cstring\u003e","status":"pending","total":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"cash_on_delivery":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"is_international":"\u003cboolean\u003e","total_weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"},"packages":[{"item_id":"\u003cinteger\u003e","external_id":"\u003cinteger\u003e","name":"\u003cstring\u003e","sku":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"quantity":"\u003cinteger\u003e","weight":{"value":"\u003cinteger\u003e","units":"lb"}},{"item_id":"\u003cinteger\u003e","external_id":"\u003cinteger\u003e","name":"\u003cstring\u003e","sku":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"quantity":"\u003cinteger\u003e","weight":{"value":"\u003cinteger\u003e","units":"g"}}],"ship_from":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e","address_line":"\u003cstring\u003e","street_number":"\u003cnull\u003e","block":"\u003cnull\u003e","postal_code":"\u003cnull\u003e","latitude":"\u003cnumber\u003e","longitude":"\u003cnumber\u003e","branch_id":"\u003cinteger\u003e"},"ship_to":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e","address_line":"\u003cstring\u003e","street_number":"\u003cstring\u003e","block":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","latitude":"\u003cnumber\u003e","longitude":"\u003cnumber\u003e"},"meta":{"app_id":"\u003cinteger\u003e","policy_options":{"shipment_content_type":["dry","food_stuff"],"packaging_type":["box","paper_wrapper"],"boxes":"\u003cinteger\u003e"}}}}