Cancel RMA

This API cancels an existing RMA by providing the RMA ID. The RMA can be canceled only when the RMA has not been received at FXO or the return center.

Swagger

			
swagger: '2.0'
info:
  x-ibm-name: rmas
  title: Rmas
  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_Id: []
    Client_Secret: []
    oauth2:
      - Fulfillment_Returns
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
'/rmas/{rmaId}/cancel':
    post:
      responses:
        '200':
          description: 200 OK
      parameters:
      - name: rmaId
        type: string
        required: true
        in: path
        description: 2408-207
      - name: AccessToken
        type: string
        required: false
        in: header
		summary: Cancel RMA
        description: This API cancels an existing RMA by providing the RMA ID. The RMA can be canceled only when the RMA has not been received at FXO or the return center.
			
		

Sample Request

			
•	Cancel the RMA using rmaId.
	https://<..............>/api/v1/rmas/2408-207/cancel
			
		

Sample Response

Success Response

			
{
    "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
    "transactionDate": "2017-01-20T15:12:54-05:00",
    "success": "true",
    "rma": {
        "rmaId": "1234",
	"rmaStatus": "Canceled"
    }
}
			
		

OAuth 2.0

Custom authentication

Response Attribute

HTTP Status Code

Error Code