Cancel Shipment
POST
https://api.techrar.com/order/v1/merchant/shipments/{shipment_id}/cancel/
Shipments should be either in
pending or ready_for_pickup statuses.Request
Path Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.techrar.com/order/v1/merchant/shipments//cancel/' \
--header 'app-id: 4' \
--header 'Authorization: Bearer <token>'Response Response Example
{
"id": 263,
"created_at": "2025-07-07T11:35:10.314981+03:00",
"order_id": 320,
"invoice_id": 391,
"status": "active",
"customer": {
"id": 35261,
"country_code": "966",
"username": "0556910123",
"mobile_number": "966556910123",
"email": "[email protected]",
"name": "966556910123",
"lang": "ar",
"current_city_id": null,
"is_email_verified": true,
"is_mobile_verified": true,
"is_blocked": false,
"is_deleted": false,
"is_verified": true,
"national_id": null,
"secondary_mobile_number": null,
"date_of_birth": null,
"avatar": null,
"joined_at": "2025-04-30T09:58:17.639533Z",
"custom_fields": null
},
"date": null,
"time": null,
"service_type": "delivery",
"location": {
"id": 9989,
"custom_fields": null,
"on_demand_supported": false,
"subscription_supported": false,
"location_url": "https://maps.google.com/?q=21.575444444444443,39.204972222222224",
"city": {
"id": 1,
"custom_fields": null,
"app_id": null,
"created_at": "2022-03-12T16:51:57.964819+03:00",
"modified_at": "2023-02-19T18:29:28.335083+03:00",
"is_deleted": false,
"deleted_at": null,
"ordering": 0,
"name_ar": "جده",
"name_en": "Jeddah",
"country_code": "SA",
"keywords": "Jeddah,jeddah,جدة,جده",
"is_supported": true
},
"app_id": null,
"created_at": "2024-10-24T10:57:13.058522+03:00",
"modified_at": "2025-01-28T17:13:30.686590+03:00",
"is_deleted": false,
"deleted_at": null,
"ordering": 0,
"name_ar": "home",
"name_en": "home",
"longitude": "39.204972222222224",
"latitude": "21.575444444444443",
"address1": "JDSC7486, 7486 Jabal Al Reatain, 2677, Ar Rabwah, Jeddah 23451, Saudi Arabia",
"address2": null,
"place_id": "ChIJsbXASQbRwxURKUzhiCdq0X4",
"postal_code": "23451",
"formatted_address": "JDSC7486, 7486 Jabal Al Reatain, 2677, Ar Rabwah, Jeddah 23451, Saudi Arabia",
"district": "Ar Rabwah",
"district_ar": null,
"city_name_en": "Jeddah",
"city_name_ar": null,
"route": "Jabal Al Reatain",
"street_number": "7486",
"is_synced": true,
"type": "home",
"description": "Building: -, Floor: -, Office: -, Notes: -",
"is_default": false,
"image": null,
"deleted_from": null,
"zone": 10,
"customer_profile": 1
},
"city_en": "Jeddah",
"city_ar": "جدة",
"district_en": "As Salama",
"district_ar": "السلامة",
"fulfillments": [
{
"id": 102630,
"created_at": "2025-07-07T11:35:10.119839+03:00",
"invoice_item_id": 423,
"item": {
"id": 121,
"custom_fields": {
"test": "test"
},
"images": [],
"discount": {
"is_applied": false,
"is_trial_applied": false,
"is_usage_price": false,
"price_after_discount_no_trial": 12.0,
"price_after_discount": 12.0
},
"stock": {
"in_stock": true,
"qty": 100
},
"modifiers": [
{
"id": 3,
"ordering": 0,
"name_en": "mod",
"name_ar": "mod",
"values": [
{
"id": 6,
"ordering": 0,
"name_en": "two",
"name_ar": "two"
},
{
"id": 5,
"ordering": 0,
"name_en": "one",
"name_ar": "one"
}
]
}
],
"variants": [
{
"id": 121,
"custom_fields": {
"test": "test"
},
"images": [],
"discount": {
"is_applied": false,
"is_trial_applied": false,
"is_usage_price": false,
"price_after_discount_no_trial": 12.0,
"price_after_discount": 12.0
},
"stock": {
"in_stock": true,
"qty": 100
},
"plan_config": null,
"off_days": [],
"off_dates": [],
"variant_title_en": "two",
"variant_title_ar": "two",
"modifier_values": [
6
],
"app_id": 86,
"ordering": 0,
"type": "product",
"service_type": "delivery",
"sku": "17502362717823294",
"price": 12.0,
"name_en": "Variant",
"name_ar": "Variant",
"description_en": "",
"description_ar": "",
"is_plan_only": false,
"is_plan_enabled": false,
"served_from_date": null,
"served_to_date": null,
"served_from_time": null,
"served_to_time": null
},
{
"id": 122,
"custom_fields": {
"test": "test_vaaar_1"
},
"images": [],
"discount": {
"is_applied": false,
"is_trial_applied": false,
"is_usage_price": false,
"price_after_discount_no_trial": 11.0,
"price_after_discount": 11.0
},
"stock": {
"in_stock": true,
"qty": 100
},
"plan_config": null,
"off_days": [],
"off_dates": [],
"variant_title_en": "one",
"variant_title_ar": "one",
"modifier_values": [
5
],
"app_id": 86,
"ordering": 0,
"type": "product",
"service_type": "delivery",
"sku": "1750236379191",
"price": 11.0,
"name_en": "Variant",
"name_ar": "Variant",
"description_en": "",
"description_ar": "",
"is_plan_only": false,
"is_plan_enabled": false,
"served_from_date": null,
"served_to_date": null,
"served_from_time": null,
"served_to_time": null
}
],
"varies_on": "modifiers",
"bundle_categories": [],
"plan_config": null,
"off_days": [],
"off_dates": [],
"app_id": 86,
"ordering": 0,
"type": "product",
"service_type": "delivery",
"sku": "17502362717823294",
"price": 12.0,
"name_en": "Variant",
"name_ar": "Variant",
"description_en": "",
"description_ar": "",
"is_plan_only": false,
"is_plan_enabled": false,
"served_from_date": null,
"served_to_date": null,
"served_from_time": null,
"served_to_time": null,
"categories": [
16
]
},
"name_en": "Variant",
"name_ar": "Variant",
"status": "active",
"addons": []
}
],
"shipments": [
{
"id": 1,
"custom_fields": null,
"courier_id": 1,
"courier_name": "OTO Flex",
"events": [
{
"created_at": "2025-07-08T10:56:48.139242+03:00",
"status": "ready_for_pickup",
"note": null,
"provider_status": "searchingDriver"
}
],
"tracking_number": "f60f7bed",
"tracking_url": "https://staging-api.tryoto.com/sms/order-tracking?key=ZFZ0RzdIU1BqUXlFdlNYZ2lTOCtyenJQSEVlNVpaZ1c4dnFObHdicFFZWFpQYTB2TEl1Z0R0RnllVmRBWFRzM3g0aDlmQ3k1KzFkbW1IellkU3dGSFE9PQ==",
"label_url": "https://staging-api.tryoto.com/print/awb?enc=eyJjb21wYW55SWQiOjM4NzA0LCJpZHMiOlszMDk1MjY0NV19",
"shipment_error": null,
"app_id": 86,
"created_at": "2025-07-08T10:56:41.495458+03:00",
"shipment_number": "TR1751961401",
"status": "ready_for_pickup",
"is_reversed": false,
"customer_id": 35261,
"customer_phone": "0556910123",
"customer_email": "[email protected]",
"customer_name": "966556910123",
"customer_address": "JDSC7486, 7486 Jabal Al Reatain, 2677, Ar Rabwah, Jeddah 23451, Saudi Arabia",
"weight": 1.0,
"package_count": 1,
"pickup_location_id": 1,
"origin_country_code": "SA",
"origin_city": "Jeddah",
"origin_lat": "21.590375041386423000",
"origin_lng": "39.152816252744530000",
"destination_country_code": "SA",
"destination_city": "Jeddah",
"destination_district": "As Salama",
"destination_lat": "21.575444444444443000",
"destination_lng": "39.204972222222224000",
"picked_up_at": null,
"shipped_at": null,
"delivered_at": null,
"shipping_amount": 0.0,
"provider_order_status": "searchingDriver"
}
]
}Modified at 2025-07-12 11:02:52