Get Receipt

Retrieves the receipt information: item returned, item quantity, RMA, FedEx Office store where the product was returned, and when and who received the product at the FedEx Office store.

Swagger

         
swagger: '2.0'
info:
  x-ibm-name: receipts
  title: Receipts
  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://<...........................>/api/test/fsc/oauth2/authorize'
    scopes:
      Fulfillment_Returns: 'Read/Write access to Orders, Items, RMAs, Inventory,location,tracking objects'
    tokenUrl: 'https://<...........................>/api/test/fsc/oauth2/token'
  Client_Screte:
    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_Screte: []
    oauth2:
      - Fulfillment_Returns
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /receipts:
    get:
      responses:
        '200':
          description: 200 OK
      operationId: ''
      consumes: []
      parameters:
        - name: accessToken
          type: string
          required: false
          in: header
          description: 'Enter AccessToken, it is mandatory.'
        - name: nextTimestamp
          type: string
          required: false
          in: query
          description: '1479495671089'
        - name: prevTimestamp
          type: string
          required: false
          in: query
          description: '1479495671089'
        - name: receiptId
          type: string
          required: false
          in: query
          description: '140'
        - name: pageLimit
          type: string
          required: false
          in: query
          description: '5'
		- name: createdDate
          type: string
          required: false
          in: query
          description: 'ge|7C2017-03-01T14:30:59-05:00'
		- name: inductionDate
          type: string
          required: false
          in: query
          description: 'ge|7C2017-03-01T14:30:59-05:00'
		- name: deliveredDate
          type: string
          required: false
          in: query
          description: 'ge|7C2017-03-01T14:30:59-05:00'
	  summary: Get Receipts
      description: Retrieves  the receipt information-Item returned, Item quantity, RMA, FXO Store where the product was returned, when & who received the product at FXO store to the retailer. 

      

Sample Request

         
	•	Retrieve receipt data using receiptId.
		https://<........>/api/v1/receipts?receiptId=395,396,397
	•	Retrieve all receipt data based on receipt created date on or after the time stamp provided .
		https://<........>/api/v1/receipts?receiveDate=ge|2016-09-21T14:30:59-05:00
	•	Retrieve all receipt data based on combination conditions of receipt created date and storeId. 
		https://<........>/api/v1/receipts?receiveDate=ge|2016-09-21T14:30:59-05:00&storeId=999999999	
 
      

Sample Response

Success Response

         
{
	"success" : true,
	"requestIdentifier" : "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
	"transactionDate" : "2017-01-20T15:12:54-05:00",
	"receipts" : [{
			"receiptId" : "395",
			"sku" : "sku1",
			"skuDescption" : "",
			"rmaId" : "12234444",
			"rmaNumber" : "1338",
			"rmaStatus" : "Approved",
			"referenceNumber" : "122334545656",
			"receiptType" : "DTV",
			"merchantName" : "Fred's Store",
			"orderNumber" : "12333444-122",
			"serialNumber" : null,
			"shipmentId" : "12344-2332-333",
			"trackingNumber" : null,
			"receivedDate" : "2017-01-24T13:43:22",
			"inductionDate" : "2017-01-25T13:43:22",
			"deliveredDate" : "2017-01-27T13:43:22",
			"storeAddress" : {
				"storeId" : "1234",
				"city" : "Columbus",
				"state" : "OH"
			},
			"senderAddress" : {
				"name" : "John Smith",
				"city" : "Portaland",
				"state" : "OR",
				"zip" : "97035"
			},
			"destinationAddress" : {
				"addressId" : "CMH",
				"name" : null,
				"city" : "Columbus",
				"state" : "OH"
			}
		}, {
			"receiptId" : "396",
			"sku" : "sku2",
			"skuDescption" : "",
			"rmaId" : "12234488",
			"rmaNumber" : "1339",
			"rmaStatus" : "Approved",
			"receiptType" : null,
			"referenceNumber" : "122334545656",
			"merchantName" : "Fred's Store",
			"orderNumber" : "12333444-122-233",
			"serialNumber" : "12233",
			"shipmentId" : "12344-2332-4444",
			"trackingNumber" : "1232334",
			"receivedDate" : "2017-01-22T13:43:22",
			"inductionDate" : "2017-01-24T13:43:22",
			"deliveredDate" : "2017-01-26T13:43:22",
			"storeAddress" : {
				"storeId" : "1234",
				"city" : "Columbus",
				"state" : "OH"
			},
			"senderAddress" : {
				"name" : "John Smith",
				"city" : "Portaland",
				"state" : "OR",
				"zip" : "97035"
			},
			"destinationAddress" : {
				"addressId" : "CMH",
				"name" : null,
				"city" : "Columbus",
				"state" : "OH"
			}
		}
	],
	"paging" : {
		"previous" : "https://<.........>/api/v1/receipts?pageLimit=25&prevTimestamp=12309820234",
		"next" : "https://<............>/api/v1/receipts?pageLimit=25&nextTimestamp=12398723498"
	}
}

      

Error Response

      
{
	"requestIdentifier" : "01749ea2-4b8f-4f3d-a9dc-f0b862a3d72e",
	"transactionDate" : "2017-01-20T15:12:54-05:00",
	"success" : "false",
	"errors" : [{
			"code" : "ERR-CMR-0001",
			"description" : "Input data validation failed"
		}
	]
}

      

OAuth 2.0

Custom authentication

Query Parameters

Response Attribute

HTTP Status Code

Error Code