Cancel Order

This API cancels an existing order by providing the order ID and the reason for canceling the order. The order can be canceled only when the orders has not processed by the fulfillment center.

Swagger

			
swagger: '2.0'
info:
  x-ibm-name: orders
  title: Orders
  version: 1.0.0
schemes:
  - https
host: $(catalog.host)
basePath: /v1
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  oauth2:
    type: oauth2
    description: ''
    flow: accessCode
    authorizationUrl: 'https://<..........................>/fsc/oauth2/authorize'
    scopes:
      Fulfillment_Returns: ''
    tokenUrl: 'https://<..........................>/fsc/oauth2/token'
  Client_Secret:
    type: apiKey
    description: Enter Client Secret
    in: header
    name: X-IBM-Client-Secret
  Client_Id:
    type: apiKey
    in: header
    name: X-IBM-Client-Id
    description: Enter Client ID
security:
  - Client_Secret: []
    Client_Id: []
    oauth2:
      - Fulfillment_Returns
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /orders/{fedexOrderId}:
    delete:
      responses:
        200:
          description: 200 OK
      summary: Cancel Order
      description: Cancels an existing order by providing Order Id and the reason
        for cancel the order. The order can be cancelled only when the orders
        is not processed by the fulfillment center.
      parameters:
      - name: cancelorder_json_input
        required: true
        in: body
        schema:
          type: object
        description: {
			  "order": {
			    "cancelReasonCode": "CCBR"
			  }
			}
      - name: fedexOrderId
        type: string
        required: true
        in: path
        description: FedEx Order Id
      - name: AccessToken
        type: string
        required: true
        in: header
        description: Enter the AccessToken, it is mandatory
			
		

Sample Request

			
{
  "order": {
    "cancelReasonCode": "CCBR"
  }
}
			
		

Sample Response

Success Response

			
{
   "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
   "transactionDate": "2017-01-20T15:12:54-05:00",
   "success": "true",
   "order": {
    “fedexOrderId”: “0001-0007-H0120173742”,
    "orderStatus": "Canceled"
  }
}


			
		

Error Response

			
 {
  "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
  "transactionDate": "2017-01-20T15:12:54-05:00",
  "success": "false",
  "order": {
   “fedexOrderId”: “0001-0007-H0120173760”,
   "orderStatus": "Shipped"
 },
 "errors": [
   {
     "code": "ERR-ORD-0026",
     "description": "Order cannot be canceled. Order is being processed or already shipped"
   }
  ]
}


			
		

OAuth 2.0

Custom authentication

Request Attribute

Response Attribute

HTTP Status Code

Error Code