Create RMA

Creates a new RMA and all of the item level details required for a return. The RMA API has a flag within to depict whether a label is needed.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:
    post:
      responses:
        200:
          description: 200 OK
      parameters:
      - name: create_createrma_json_body
        required: true
        in: body
        schema:
          type: json
        description: ''
      - name: AccessToken
        type: string
        required: false
        in: header
        description: Enter Access Token, it is required header
      	summary: Create RMA
        description: Creates a new RMA and all of the item level details required for a return.  
		The RMA API does have a flag within to depict if a label is needed or not.

      

Sample Request

         
{
  "requestIdentifier": "234234234234234",
  "rmaNumber": null,
  "affiliatedMerchant": "Gilt",
  "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"
  },
  "trackingNumber": null,
  "shippingService": null,
  "shippingCost": null,
  "labelRequired": null,
  "emailNotification": null,
  "returnEmployeeId": null,
  "returnEmployeeName": null,
  "shipToAddressId": null,
  "shippingCostResponsibility": null,
  "externalASNId": null,
  "casAccountNumber": null,
  "billToFirstName": null,
  "billToLastName": null,
  "billToAddress1": null,
  "billToAddress2": null,
  "billToCity": null,
  "billToStateCode": null,
  "billToZipCode": null,
  "specialtyFlag": null,
  "declaredValue": 19.99,
  "referenceFields": {
    "customerReference" : "1234",
    "departmentNumber": "10",
    "invoiceNumber" : "inv100",
    "poNumber": "PO123"   
  },  "orders": [
    {
      "orderNumber": "RMS-1451-O2",
      "orderDate": "2017-02-15",
      "items": [
        {
          "sku": "testsku23",
          "quantity": 3,
          "returnItemInfo": {
            "returnReason": "Wrong Size",
            "returnEligibilityOverride": "true",
            "finalSale": null
          }
        }
      ]
    }
  ]
}

 
      

Sample Response

Success Response

         
{
  "requestIdentifier": "234234234234234",
  "success": true,
  "rma": {
    "rmaId": "2408-1984",
    "rmaNumber": "2400",
	"affiliatedMerchant": "Gilt",
    "status": "Approved",
    "shipments": [{
        "status": "Approved",
        "shippingService": "FDXE",
        "shippingCost": 20.83,
        "shipToAddressId": "123098",
        "shipToAddressName": "CAD Location Name Update",
        "label": {
          "id": "15050",
          "labelURL": "http://<.........>/api/v1/labels/15050",
          "trackingNumber": "14147333522777"
        },
        "orders": [{
            "orderNumber": "RMS-1451-O2",
            "items": [{
                "sku": "testsku23",
                "quantity": 3
              }
            ]
          }
        ]
      }
    ]
  }
}



      

OAuth 2.0

Custom authentication

Request Attributes

Response Attribute

HTTP Status Code

Error Code