Cancel Sales Order B2B

Shipper API gives interface access to our clients for cancelling Sales Order API from their own system to. It applies for B2B type of Business

Authorizations : X-API-Key_Header
Request Body Schema : application/json

PATCH Sales Order B2B

Method	Endpoint
PATCH	/v3/fulfillment/outbound/wms/cancel

Body Request Parameter

Field	Data Type	Description	Note
order_no	string(50)	Sales Order No Example: TEST-OUTBOUND-OMS-1	Mandatory
warehouse_id	string(20)	Warehouse ID Given by Shipper Example: WH-TGR04	Mandatory
cancel_reason	String(50)	Cancellation Reason Example: “Cancelled from marketplace”	Mandatory

Field

Data Type

Description

Note

order_no

string(50)

Sales Order No

Example: TEST-OUTBOUND-OMS-1

Mandatory

warehouse_id

string(20)

Warehouse ID Given by Shipper

Example: WH-TGR04

Mandatory

cancel_reason

String(50)

Cancellation Reason

Example: “Cancelled from marketplace”

Mandatory

Sample Body Request

Header	How to Fill
x-api-key	Shipper API Key

{
  "data": {
    "cancellation": {
      "cancel_reason": "cancelled from marketplace",
      "order_no": "TEST-OUTBOUND-WMS-3",
      "warehouse_id": "WH-TGR04"
    }
  }
}

Sample Response

{
    "metadata": {
        "path": "/v1/fulfillment/outbound/wms/cancel",
        "http_status_code": 200,
        "http_status": "OK",
        "timestamp": 1652327198
    }
}

{
  "metadata": {
    "path": "/v1/fulfillment/outbound/wms/cancel",
    "http_status_code": 400,
    "http_status": "Bad Request",
    "errors": [
      {
        "code": 3012,
        "message": "Order Doesn't Exist in WMS and OMS."
      }
    ],
    "timestamp": 1652328337
  }
}

{
  "metadata": {
    "path": "/v3/fulfillment/outbound/wms/cancel",
    "status_code": 401,
    "status": "Unauthorized",
    "message": "PATCH /v1/fulfillment/outbound/wms/cancel [401] Unauthorized",
    "error": {
      "code": 802,
      "message": "Unauthorized Access. You are not authorized to access this resource."
    },
    "timestamp": "2022-05-12T04:04:19Z"
  }
}

{
  "metadata": {
    "path": "/v3/fulfillment/outbound/wms/cancel",
    "http_status_code": 500,
    "http_status": "Internal Server Error",
    "errors": [
      {
        "code": 803,
        "message": "Internal Server error."
      }
    ],
    "timestamp": 1652326659
  }
}

Status	Reason
200	Cancel sales order B2B success
400	Please check your input. Make sure the JSON payload is correct Make sure the requested input are valid.
401	Please check whether your API Key is valid and still active.
500	Something wrong with Shipper application. Please contact Shipper representative.