List Inbound RMAs

Request

Path Params

businessUnitId

string

required

Query Params

sortField

string

optional

Field to sort by

Default:

timestamp

sortDirection

enum<string>

optional

Direction in which to sort the sortField

Allowed values:

ASCDESC

Default:

DESC

offset

integer

optional

This offsets the start of each page by the number specified.

Default:

0

limit

integer

optional

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit due to filtering.

Default:

100

status

string

optional

Filter to orders with this status. Need list of possible status from Softeon.

rmaNumber

string

optional

Filter to inbounds where rmaNumber begins with this string.

timestampSince

string

optional

Start of the range for time-based filter. Date ranges are inclusive. ISO 8601 date string.

timestampUntil

string

optional

End of the range for time-based filter. Date ranges are inclusive. ISO 8601 date string.

buildingId

string

optional

Filter to inbounds to this building

customerOrderNumber

string

optional

Filter to inbounds where customerOrderNumber begins with this string.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Body

data

array[object (InboundRmaSummary) {6}]

optional

rmaNumber

string

optional

ASN, RMA, PO, etc

name

string

optional

Q: Is this something we can store and return with an ASN? Should we just return the beginning of notes field to display?

status

string

optional

building

object (BuildingReference)

optional

A Summary View of a Distribution Center/Building/Facility/Location

timestamp

string

optional

Q: We need to define which timestamps makes most sense to see here. orderDate, shipmentDate, receivedDate, etc?

customerOrderNumber

string

optional

Example

{
    "data": [
        {
            "rmaNumber": "string",
            "name": "string",
            "status": "string",
            "building": {
                "buildingId": "strin",
                "shortName": "string",
                "name": "string"
            },
            "timestamp": "string",
            "customerOrderNumber": "string"
        }
    ]
}