Receive RMA

This API flags an existing RMA as having been received by providing the RMA ID, the items/quantities to be marked as Received. This can only be called when the RMA is not in Canceled status.

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}/receive':
    post:
      responses:
        '200':
          description: 200 OK
     parameters:
        - name: receiverma_json_body
          required: true
          in: body
          schema:
            type: object
          description: '{"items" : [{"sku" : "sku1","quantity" : 1}, {"sku" : "sku2","quantity" : 2}]}'
        - name: AccessToken
          type: string
          required: false
          in: header
          description: 'Enter AccessToken, it is mandatory in case of basic authentication.'
        - name: rmaId
          type: string
          required: true
          in: path
          description: 8057-1232
	 summary: Receive RMA
     description: 'This API flags an existing RMA as having been received by providing the RMA ID, the items/quantities to be marked as Received. This can only be called when the RMA is not in Canceled status.'

			
		

Sample Request

			
{
  "items" : [{
      "sku" : "sku1",
      "quantity" : 1
    }, {
      "sku" : "sku2",
      "quantity" : 2
    }
  ]
}

			
		

Sample Response

Success Response

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

Error Response

			
{
    "requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
    "transactionDate": "2017-01-20T15:12:54-05:00",
    "success": false,
    "rma": {
        "rmaId": "1234",
        "rmaStatus": "Canceled"
    },
    "errors": [{
        "code": "ERR-RMA-XXXX",
        "description": "RMA cannot be received. RMA is in Canceled status."
    }]
}


			
		

OAuth 2.0

Custom authentication

Request Attribute

Response Attribute

HTTP Status Code

Error Code