Introduction

Overview

The Cisco Service Order Return (RMA) API provides a powerful, convenient, and simple way to interact with the Cisco RMA service and enables you to access RMA information instantly, programmatically, and in bulk.

The Cisco Service Order Return (RMA) API is stateless, externally accessible, and delivered as a REST web service, which allows you to build innovative RMA applications and portals

Features

The Cisco Service Order Return (RMA) API provides the following features:

• Supports RESTful interface.
• Supports JSON data format.
• Includes web services that return:
• Details about the specified RMA.
• List of RMAs associated to the specified user ID.

API Reference

This topic describes the methods provided by this API.

Notes:

• You can download the WADL for this API by clicking the following link: Cisco Service Order Return (RMA) API WADL
• For information on error codes returned by these methods, see Error Codes.

Warning! All parameters are case sensitive and must be entered as shown in this document.
If a space is encountered in a mandatory input parameter, Error 403 is thrown. For example: "https://apix.cisco.com/return/v1.0/returns/rma_numbers/ 626099288" will result in "<h1>Not Authorized</h1>" response.

GET RMA Details by RMA Number

Returns detailed information about the specified RMA.

Request Parameters

Response Parameters

Sample Request

GET https://apix.cisco.com/return/v1.0/returns/rma_numbers/84894022 HTTP/1.1
Accept-Encoding: gzip,deflate
Authorization: Bearer QROt9zFPchfWTZeodjpmC04cGWsd
Content-Type: application/json
Host: apix.cisco.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Sample Response

HTTP/1.1 200 OK
Date: Wed, 14 Aug 2013 05:20:28 GMT
Server: IBM_HTTP_Server
X-Mashery-Message-ID: b198f36c-20bc-4cdd-9c4a-73f2d0c17e45
Cache-Control: private
Pragma: private
Content-Type: application/json
Content-Language: en-US
Cache-Control: max-age=0
Expires: Wed, 14 Aug 2013 05:20:28 GMT
Connection: close
Transfer-Encoding: chunked

{
   "APIPagination": {
      "pageIndex": "1",
      "lastIndex": "1",
      "totalRecords": "1",
      "pageRecords": "1",
      "title": "Service Order RMA API",
      "selfLink": "https://apix.cisco.com/return/v1.0/returns/rma_numbers/84894022" 
   },
   "returns": { 
     "RmaRecord": [{
         "rmaNo": 84894022,
         "status": "Booked",
         "orderDate": "2013-08-06",
         "caseId": "625774679",
         "requestedShipDate": "2013-08-06",
         "originator": "SVORMA10",
         "allowPartialShipment": "",
         "failureClass": "Operational Failure",
         "failureCode": "HW Fail - Power",
         "contractId": "92156435",
         "serviceLevel": "Premium Parts & Labor - 4 Hour",
         "customerRefInfo": {
            "customerPONumber": "",
            "origSalesOrderNumber": "84894022",
            "customerRefNumber": "",
            "customerProvidedSN": "" 
         },
         "shipToInfo": {
            "customerName": "NPQ CORPORATION",
            "address1": "TECH SUINDRA",
            "address2": "",
            "address3": "",
            "address4": "",
            "city": "HYDERABAD",
            "state": "AP",
            "country": "IN",
            "postalCode": "",
            "stateProv": "AP",
            "siteUseId": "734647093",
            "ackUserId": "mackeryn",
            "ackPhone": "1455652605402",
            "ackEmail": "mq123@cisco.com",
            "ackName": "Mack Yrn",
            "shipToContactName": " Mack Yrn",
            "shipToContactPhone": "997752605402",
            "shipToContactEmail": " mq123@cisco.com" 
         },
         "billToInfo": {
            "customerName": "STARS FIRST LTD",
            "address1": "NUMBER ONE",
            "address2": "BOYCOTT DRIVE",
            "address3": "NEWTAVERN SOUTH",
            "address4": "",
            "city": "REJJITH",
            "state": "",
            "country": "GB",
            "postalCode": "B77 8QJ",
            "stateProv": "",
            "siteUseId": "61530259" 
         },
         "replacementParts": {
            "trackingInfo": {
               "trackingNumber": "",
               "courierList": "",
               "shipDate": "" 
            },
            "partsLineDetails": [{
               "partsLineRef": "2",
               "partsLineStatus": "Awaiting Shipping",
               "partsTransactionType": "ARPRM-SHIP-UKH",
               "shippedPartNo": "RP=",
               "partsDescription": "^Route Processor",
               "partsQtyAuth": "1",
               "partsScheduledShipTime": "2013-08-06",
               "partsqtyShipped": "",
               "partsShipDate": "",
               "partsShipmentWarehouse": "U06",
               "partsDispatchStatus": "DISPATCHED" 
            }] 
         },
         "returnLines": {
            "returnParts": [{
               "returnLineRef": "1",
               "returnLineStatus": "Awaiting Return",
               "returnTransactionType": "ARPRM-RETURN-UKH",
               "receivedPartNo": "RP=",
               "returnDescription": "^Route Processor",
               "returnQtyAuth": "1",
               "returnToCiscoBy": "2013-08-16",
               "reqturnQtyReceived": "",
               "returnDateReceived": "",
               "returnWarehouse": "BLR" 
            }]
         },
         "laborDetails":{
            "fieldEngineerName": "",
            "fieldEngineerPhone": "",
            "fieldEngineerOnRouteTime": "",
            "fieldEngineerArrivedTime": "",
            "fieldEngineerReleasedTime": "",
            "laborLines": [{
               "laborTaskNumber": "3",
               "laborStatus": "Booked",
               "primaryProductFamily": "7500",
               "laborScheduledTime": "2013-08-06",
               "laborDispatch": "SELECTED",
               "laborDispatchOrCancellationNotes": "" 
            }] 
         },
         "notes": {
            "addlComments": "",
            "failureDescription": "Created by SVORMA10 at 2013/08/06 12:38:22\r\nCreated by SVORMA10 at 2013/08/06 04:45:17\r\nCreated by SVORMA10 at 2013/08/06 04:27:37\r\ntest",
            "fieldEngineerInstructions": "Created by SVORMA10 at 2013/08/06 12:38:22\r\nCreated by SVORMA10 at 2013/08/06 04:45:17\r\ntest",
            "partDeliveryInstructions": "",
            "partialShipmentNote": "Created by SVORMA10 at 2013/08/06 12:38:22\r\n Do Not Partial Ship",
            "specialInstructions": "" 
         } 
      }]
   } 
}

GET RMAs by User ID

Returns a list of RMAs associated with the specified user. By default, the last 30 days of RMAs for a user is returned.

Request Parameters

Request Parameters

Sample Request

GET https://apix.cisco.com/return/v1.0/returns/users/user_ids/svorma8?fromDate=2013-08-01&toDate=2013-08-15 HTTP/1.1
Accept-Encoding: gzip,deflate
Authorization: Bearer QROt9zFPchfWTZeodjpmC04cGWsd
Content-Type: application/json
Host: apix.cisco.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Sample Response

HTTP/1.1 200 OK
Date: Wed, 14 Aug 2013 05:23:18 GMT
Server: IBM_HTTP_Server
X-Mashery-Message-ID: d43b8915-7ac5-4953-b103-a9fd8f007755
Cache-Control: private
Pragma: private
Content-Type: application/json
Content-Language: en-US
Cache-Control: max-age=0
Expires: Wed, 14 Aug 2013 05:23:18 GMT
Connection: close
Transfer-Encoding: chunked

{
   "OrderList": {
      "APIPagination": {
         "pageIndex": "1",
         "lastIndex": "1",
         "totalRecords": "2",
         "pageRecords": "2",
         "title": "Service Order RMA API",
         "selfLink": "https://apix.cisco.com/return/v1.0/returns/users/user_ids/SVORMA8?fromDate=2013-08-01&toDate=2013-08-15&pageIndex=1" 
      },
      "users": [{
         "userId": "SVORMA8",
         "returnCount": "2",
         "returns": [{
            "rmaNo": "84894100",
            "status": "BOOKED",
            "orderDate": "2013-08-11",
            "caseId": "675775751",
            "contractId": "4348152",
            "serviceLevel": "Advance ReplacementNext Business Day",
            "orderedPart": "WS-X5009=",
            "customerProvidedSN": "",
            "trackingNumber": "1442352345",
            "courierList": "BESTWAY",
            "earliestShipDateTime": "2013-08-11",
            "shippingAddress": {
               "customerName": "XcelCorp",
               "address1": "2900 KOREX DRI",
               "city": "BERWICK",
               "state": "ME",
               "country": "US",
               "siteUseId": "914128396" 
            },
            "onSiteContactName": "SVO RMA8",
            "onSiteContactPhone": "14134268800",
            "onSiteContactEmail": "whoami@cisco.com" 
         },{
            "rmaNo": "84894087",
            "Status": "HOLD",
            "orderDate": "2013-08-09",
            "caseId": "625776365",
            "contractId": "6680005",
            "serviceLevel": "Advance ReplacementNext Business Day",
            "orderedPart": "WS-C6509-V-E-FAN=",
            "customerProvidedSN": "",
            "trackingNumber": "",
            "courierList": "",
            "earliestShipDateTime": "2013-08-09",
            "shippingAddress": {
               "customerName": "KOIR ONLINE",
               "address1": "3016 OMNI STREET",
               "city": "SIHUE",
               "state": "HI",
               "country": "US",
               "siteUseId": "76685207" 
            },
            "onSiteContactName": "Krup Nanerjee",
            "onSiteContactPhone": "78941360",
            "onSiteContactEmail": "knsample@cisco.com" 
         }] 
      }] 
   }
}

Error Codes

This table describes the error codes returned by the Cisco Service Order Return (RMA) API service.