Cancel Sales Order B2C

Shipper API gives interface access to our clients for canceling Sales Order from their own system to Shipper Warehouse Management System.

Sales Order only able to cancel if WMS has not allocated any stock to that Sales Order

PATCH Sales Order B2C

Field	Endpoint
PATCH	v3/fulfillment/outbound/oms/cancel

Body Request Parameter

Field	Data Type	Description	Note
order_no	String(20)	Sales Order No	Mandatory
warehouse_id	String(60)	Warehouse Id Given by Shipper	Mandatory
cancel_reason	String	Cancellation Reason	Mandatory

Sample Body Request

{
  "data": {
    "cancellation": {
      "order_no": "KZFILN0HRC9RDXJTZBJS",
      "cancel_reason": "cancel aja",
      "warehouse_id": "PMU"
    }
  }
}

Sample Response

{
    "metadata": {
        "path": "/v3/fulfillment/outbound/oms/cancel",
        "http_status_code": 200,
        "http_status": "OK",
        "timestamp": 1637907242
    }
}

{
  "metadata": {
    "path": "/v3/fulfillment/outbound/oms/cancel",
    "http_status_code": 400,
    "http_status": "Bad Request",
    "errors": [
      {
        "code": 810,
        "message": "Invalid Input. Please Validate Your Input."
      }
    ],
    "timestamp": 1637907103
  }
}

{
  "metadata": {
    "path": "/v1/fulfillment/cancel-outbound-oms",
    "http_status_code": 500,
    "http_status": "Internal Server Error",
    "timestamp": 1615969609
  }
}