Skip to main content
GET
/
resale
/
listings
Retrieve resale listings
curl --request GET \
  --url https://api.nuwebgroup.com/v1/resale/listings \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "resaleListings",
      "id": 1,
      "attributes": {
        "customerId": 123,
        "minimumPurchaseQuantity": 1,
        "status": "active",
        "eventId": 456,
        "orderId": 789,
        "createdAt": "2025-01-15T10:30:00.000000Z",
        "closedAt": null,
        "onSaleFrom": "2025-02-01T09:00:00.000000Z",
        "onSaleUntil": "2025-02-15T18:00:00.000000Z"
      },
      "relationships": {
        "resaleContracts": {
          "data": [
            {
              "type": "resaleContracts",
              "id": 1
            }
          ]
        }
      },
      "links": {
        "self": "/v1/resale/listing?id=1"
      }
    }
  ],
  "included": [
    {
      "type": "resaleContracts",
      "id": 1,
      "attributes": {
        "orderItemId": 456,
        "maxSellerContribution": 500,
        "status": "active",
        "soldAt": null,
        "currencyId": 1,
        "price": 5000,
        "totalPrice": 5250,
        "displayTotal": 5500
      }
    }
  ]
}

Authorizations

ā€‹
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Query Parameters

ā€‹
page
integer

The page you wish to retrieve purchased items. You will only be able to paginate by page if you do not specify an offset.

ā€‹
offset
integer

The offset - e.g 100 for listing items starting with the 100th item. Offset will always take precedence over page.

ā€‹
limit
integer

The number of resale contracts to retrieve per page. The default and maximum is 100

ā€‹
eventId
integer

Filter by event ID.

ā€‹
customerId
integer

Filter by customer ID.

ā€‹
createdAfter
string<date-time>

Filter listings created on or after this date (ISO 8601 format).

ā€‹
createdBefore
string<date-time>

Filter listings created on or before this date (ISO 8601 format).

ā€‹
status
enum<string>

Filter by listing status. Default is 'active'.

Available options:
active,
closed,
all
ā€‹
withTrashed
enum<string>

Include soft-deleted listings. Default is 'false'.

Available options:
true,
false
ā€‹
include
enum<string>[]

A list of related resources you wish to include in the response.

Available options:
resaleContracts,
resaleContracts.orderItem,
resaleContracts.replacingOrderItem,
resaleContracts.payoutTransaction,
resaleContracts.payoutWalletTransaction,
events,
orders
ā€‹
only
string

A list of attributes that you wish to be returned in the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources

ā€‹
except
string

A list of attributes that you wish to exclude from the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources.

Response

Successfully retrieved the resale listings.

ā€‹
data
object[]
ā€‹
included
object[]