KIBO OMS DOCUMENTATION

Get Return Information

The Get Return API retrieves information about a return. The request requires for the return to be in existence, so the Create Return API must have been called first.

Version2.0
Callhttps://integration.shopatron.com/api/v2/return/{returnID}
Supported FormatsJSON
HTTP MethodGET
Schemahttps://integration.shopatron.com/api/v2/schema/return.json

The .json address above can be used to access the schema within Postman.¬†An example use of the Get Return API follows here — or go directly to the schema or the sample Postman collection.

Example

The Get Return API call requires only one additional piece of data: the Return ID that was generated when the order was placed with the Create Return API. Otherwise, it is a standard GET call as defined with the above table. In this example, the return included these particular properties:

  • Status – CLOSED
  • Disposition Reason – Item did not fit
  • Refund Type – STANDARD

The response will provide general information about the return and its associated order or shipment, if one was provided, followed by the details of the item.

General Information

The following information about the return will also be included in the response:

  • Totals
  • Timestamps
  • Order and Shipment IDs
  • Item Being Returned
"returnID": 000000,
    "status": "CLOSED",
    "returnTotal": 76.95,
    "fulfillerTotal": 69.64,
    "createdTime": "2017-01-13T19:27:27+0000",
    "confirmTime": "2017-01-13T19:27:41+0000",
    "clearedTime": "2017-01-16T08:10:47+0000",
    "orderID": 1234567,
    "shipmentID": 101010101,
    "returnLocation": 555555,

Item Information

Details about the item or items being returned follow the general information. This includes various identification parameters as well as subtotal, status, item options, and the reason for the return.

"item": [
        {
            "returnItemID": 111111,
            "orderItemID": 0101010,
            "quantity": 1,
            "returnSubtotal": 76.95,
            "fulfillerSubtotal": 69.64,
            "partNumber": "000-11111-22-3",
            "UPC": "0123456789",
            "partName": "Shirt",
            "status": "ACCEPTED",
            "reason": "Item did not fit.",
            "options": [
                "color: Blue"
            ]
        }

The Full Response

This is the complete payload returned by the API. It is the simple combination of the above general and item information sections.

{
    "returnID": 000000,
    "status": "CLOSED",
    "returnTotal": 76.95,
    "fulfillerTotal": 69.64,
    "createdTime": "2017-01-13T19:27:27+0000",
    "confirmTime": "2017-01-13T19:27:41+0000",
    "clearedTime": "2017-01-16T08:10:47+0000",
    "orderID": 1234567,
    "shipmentID": 101010101,
    "returnLocation": 555555,
    "item": [
        {
            "returnItemID": 111111,
            "orderItemID": 0101010,
            "quantity": 1,
            "returnSubtotal": 76.95,
            "fulfillerSubtotal": 69.64,
            "partNumber": "000-11111-22-3",
            "UPC": "0123456789",
            "partName": "Shirt",
            "status": "ACCEPTED",
            "reason": "Item did not fit.",
            "options": [
                "color: Blue"
            ]
        }
    ],
    "externalOrderID": "000000000",
    "refundType": "STANDARD"
}

Megan MayfieldOMS Dev: Get Return Information