Get RMA

Retrieves RMA or list of RMAs based on the query parameters provided in the request.

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
paths:
  /rmas:
    get:
      responses:
        '200':
          description: 200 OK
      parameters:
        - name: accessToken
          type: string
          required: false
          in: header
        - name: id
          type: string
          required: false
          in: query
          description: 2408-2103
        - name: status
          type: string
          required: false
          in: query
          description: Canceled or Approved
        - name: createTimestamp
          type: string
          required: false
          in: query
          description: 'ge|7C2017-03-01T14:30:59-05:00'
        - name: lastUpdatedTimestamp
          type: string
          required: false
          in: query
          description: 'ge|7C2017-03-01T14:30:59-05:00'
        - name: responseFilter
          type: string
          required: false
          in: query
          description: Details
        - name: pageLimit
          type: integer
          required: false
          in: query
          format: int64
          description: '5'
        - name: prevTimeStamp
          type: string
          required: false
          in: query
          description: '1481059745000'
        - name: nextTimeStamp
          type: string
          required: false
          in: query
          description: '1481059745000'
	  summary: Get RMA
      description: Retrieves rma or list of rmas based on the query parameters provided in the request.	  .

      

Sample Request

         
	•	Retrieve RAM details using below details
	https://<........>/api/v1/rmas?id=2408-206&responseFilter= Details
	•	Retrieve RAM summary using below details
	https://<........>/api/v1/rmas?id=2408-206&responseFilter= Summary
 
      

Sample Response

Success Response

         
{
	"requestIdentifier" : "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
	"transactionDate" : "2017-01-20T15:12:54-05:00",
	"success" : true,
	"rma" : [{
			"rmaId" : "0001-1456",
			"rmaNumber" : "1950",
			"affiliatedMerchant": "Merchant",
			"status" : "Approved",
			"createdDate" : "2017-03-29T00:00:00",
			"shippingService" : "FDXG",
			"shippingCost" : 12.47,
			"returnEmployeeId" : "test.user"
			"returnEmployeeName" : "Jhn Smith",
			"shipToAddressId" : "1",
			"shippingCostResponsibility" : "RETAILER",
			"externalASNId" : "0001-0003-1950",
			"customer" : {
				"firstName" : "Sangita Patil",
				"lastName" : "Sangita Patil",
				"addressLine1" : "404 Beam Dr",
				"addressLine2" : "Apt 2",
				"city" : "PITTSBURGH",
				"stateCode" : "PA",
				"zipCode" : "15236-4562",
				"countryCode" : "US",
				"phoneNumber" : "4123456789",
				"emailAddress" : "sangeetap85@yahoo.com"
			},
			"orders" : [{
					"orderNumber" : "0001-0001-H0227171107",
					"orderDate" : "2017-02-27",
					"items" : [{
							"sku" : "003-003-0001",
							"quantity" : 1,
							"returnItemInfo" : {
								"returnReason" : "WI"
							}
						}
					]
				}
			],
			"label" : {
				"id" : 12300,
				"labelURL" : "http://hcdevweb.genco.com/commerce/services/labels/12300",
				"trackingNumber" : "795490675459"
			}
		}, {
			"rmaId" : "0001-1457",
			"rmaNumber" : "1951",
			"status" : "Approved",
			"createdDate" : "2017-03-29T00:00:00",
			"customer" : {
				"firstName" : "Sangita Patil",
				"lastName" : "Sangita Patil",
				"addressLine1" : "404 Beam Dr",
				"city" : "PITTSBURGH",
				"stateCode" : "PA",
				"zipCode" : "15236-4562",
				"countryCode" : "US",
				"phoneNumber" : "4123456789",
				"emailAddress" : "sangeetap85@yahoo.com"
			},
			"shippingService" : "FDXG",
			"shippingCost" : 12.47,
			"returnEmployeeName" : "null null",
			"shipToAddressId" : "1",
			"shippingCostResponsibility" : "RETAILER",
			"orders" : [{
					"orderNumber" : "0001-0001-H0226171106",
					"orderDate" : "2017-02-26",
					"items" : [{
							"sku" : "003-003-0001",
							"quantity" : 1,
							"returnItemInfo" : {
								"returnReason" : "DNF"
							}
						}
					]
				}
			],
			"label" : {
				"id" : 12301,
				"labelURL" : "http://hcdevweb.genco.com/commerce/services/labels/12301",
				"trackingNumber" : "795490675780"
			}
		}
	],
	"paging" : {
		"previous" : "http://hcdevweb.genco.com/rms/services/rma/getRmaService?pageLimit=15&responseFilter=Details&prevTimestamp=1490810481000",
		"next" : "http://hcdevweb.genco.com/rms/services/rma/getRmaService?pageLimit=15&responseFilter=Details&nextTimestamp=1493923012000"
	},
	"errors" : [{
		"code" : "ERR-RMS-0001",
		"description" : "This is an error"
	}]
}


      

OAuth 2.0

Custom authentication

Query Parameters

Response Attribute

HTTP Status Code

Error Code