OMS DOCUMENTATIONRESOURCE CENTER

These guides provide examples for many tasks that a developer will need to be familiar with during implementation.

KIBO OMS DEVELOPMENT

Documentation

Get Returnable Items

The Get Returnable Items API provides a merchant with the list of all items that can be returned on an particular order.

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

The .json address above can be used to access the schema within Postman. An example use of the Get Returnable Items API follows below, or view the schema or the sample Postman collection.

Example

The Get Returnable Items API call requires an Order ID, as it analyzes the items within that single order and returns the ones that are able to be returned. This example has the following properties:

  • Returnable Items: Two Shirts
  • No Restocking Fee

General Information

The response from the API is fairly straightforward. It will repeat the Order ID and provide a new Returnable Shipment object that includes the following information:

  • Shipment ID
  • Restocking Fee
  • Item Details

The Full Request

Using the URL format as outlined above, the entire call is simple to put together. 

https://integration.shopatron.com}/api/v2/return/returnableItems/0000000

The Full Response

This is the complete response returned by the API. This particular example only has a single returnable item, but shipments with multiple would list each item.

{
    "orderID": 0000000,
    "returnableShipment": [
        {
            "shipmentID": 1234567,
            "restockingFee": false,
            "item": [
                {
                    "orderItemID": 7654321,
                    "quantity": 2,
                    "returnSubtotal": 35.19,
                    "fulfillerSubtotal": 35.19,
                    "partNumber": "1234567",
                    "partName": "Shirt",
                    "returnRestriction": "RETURNABLE",
                    "options": [
                        "Gender: Men",
                        "Brand: TestShirts",
                        "Size: S",
                        "Color: White",
                        "Manufacturer Part #: 10101"
                    ]
                }
            ]
        }
    ]
}