API Docs

Cancel shipment inbound

PATCH

/api/v1/public/shipments/inbound/update-status/{{inbound_id}}

This API updates the status of a specific inbound shipment. Setting the status to 700 will cancel the shipment.

URL Path Parameter:

{{inbound_id}} (integer) — ID of the inbound shipment you want to cancel.

status: 700 → means "Canceled"

Important Considerations:

Ensure the shipment is in a valid state for cancellation (not completed, already processed, or canceled).

Only authorized users should have permission to perform this action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PATCH '/api/v1/public/shipments/inbound/update-status/{{inbound_id}}' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{

"status": 700

}'

Response Example

200 - Success

{
  "status_code": 200,
  "data": {
    "shipment_inbound_id": 1363,
    "status": 700
  },
  "error": false,
  "error_code": null,
  "log_id": null,
  "messages": "",
  "total": 1
}

Request

Header Params

Authorization

string

required

Default:

Body Params application/json

status

integer

required

status: 700 → means "Canceled"

Examples

Responses

🟢200OK

application/json

Body

status_code

integer

optional

HTTP status code (200 = success)

data

object

optional

shipment_inbound_id

integer

optional

The ID of the shipment that was updated

status

integer

optional

The new status (700 = canceled)

error

boolean

optional

Indicates whether an error occurred (false = success)

error_code

string

optional

log_id

string

optional

messages

string

optional

total

integer

optional

Usually indicates the number of records affected (1 = one shipment updated)

🟠400Bad Request

Create shipment inbound

List shipment inbound