Get RMA

Retrieves RMA or list of RMAs based on the query parameters provided in the request.To take advantage the enhanced RMA functionalities, make sure you subscribe to both “Returns 1.0.0” and “Returns 2.0.0” in the API Developer Portal

Swagger

         
swagger: '2.0'
info:
  x-ibm-name: rmas
  title: Rmas
  version: 2.0.0
schemes:
  - https
host: $(catalog.host)
basePath: /v2
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

         
	•	Get all RMAs, limit to 15 per page, with details information.
	https://<........>/api/v2/rmas?pageLimit=15&responseFilter=Details
	•	Get all RMAs, with a created time greater than or equal to given date, with summary information.Get 
	https://<........>/api/v2/rmas?createdTimestamp=ge|2017-03-17T12:00:00-05:00&responseFilter=Summary
 
      

Sample Response

Success Response

         
{
	"requestIdentifier": "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
	"transactionDate": "2017-01-20T15:12:54-05:00",
	"success": true,
	"rmas": [{
		"rmaId": "0001-1456",
		"rmaNumber": "1950",
		"affiliatedMerchant": "Gilt",
		"status": "Approved",
		"createdDate": "2017-03-29T00:00:00",
		"returnEmployeeId": "test.user",
		"returnEmployeeName": "Jhn Smith",
		"shippingCostResponsibility": "RETAILER",
		"externalASNId": "0001-0003-1950",
		"customer": {
			"firstName": "John",
			"lastName": "Smith",
			"addressLine1": "1020 Orchard St",
			"addressLine2": "",
			"city": " Sacramento ",
			"stateCode": "CA",
			"zipCode": "95814",
			"countryCode": "US",
			"phoneNumber": "888-787-8888",
			"emailAddress": "test85@gmail.com"

		},
		"declaredValue": 19.99,
		"referenceFields": {
			"customerReference": "1234",
			"departmentNumber": "10",
			"invoiceNumber": "inv100",
			"poNumber": "PO123"
		},
		"shipments": [{
			"status": "Approved",
			"shippingService": "FDXG",
			"shippingCost": 20.83,
			"shipToAddressId": "1",
			"orders": [{
				"orderNumber": "0001-0001-H0227171107",
				"orderDate": "2017-02-27",
				"items": [{
					"sku": "003-003-0001",
					"quantity": 1,
					"returnItemInfo": {
						"returnReason": "WI"
					}
				}]
			}],
			"label": {
				"id": "12300",
				"labelURL": "http://<.........>/api/v1/labels/15050",
				"trackingNumber": "795490675459"
			}
		}],
		"paging": {
			"previous": "https://<.......>/api/v2/rmas?pageLimit=15&responseFilter=Details&prevTimestamp=1490810481000",
			"next": " https://<.......>/api/v2/rmas?pageLimit=15&responseFilter=Details&nextTimestamp=1493923012000"
		}

	}]
}

      

OAuth 2.0

Custom authentication

Query Parameters

Response Attribute

HTTP Status Code

Error Code