Offers List

This API returns a paginated list of Offers/Auctions created on Driffle.

Supported arguments

GET /offers

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Params

Param	Param Type	Type	Required	Description
page	query	string	No	Page number. Use this to traverse through your list of keys. Default value: 1
pid	query	number	No	Product Id
s	query	string	No	Search Phrase. Can be used to search for an offer using title.
srt	query	string	No	Sorting mechanism. Supported values: pd - Price descending, pa - Price ascending, lastSoldAsc - Last sold ascending, lastSoldDesc - Last sold descending
f	query	string	No	Comma separated Filters. Supported values: Out of stock products , Low in stock products , Best selling products , Disabled products
regions	query	string	No	Comma seperated regions IDs for filtering. See Regions, for supported values.
platforms	query	string	No	Comma separated platforms for filtering. See Platforms for supported values.

Response

200

{
  "message": "string",
  "statusCode": 200,
  "totalPages": 0,
  "totalCount": 0,
  "data": [
    {
      "offerId": 0,
      "product": {
        "id": 0,
        "title": "string",
        "productStatus": "string"
      },
      "unitsSold": 0,
      "onHand": 0,
      "status": 0,
      "sellingPrice": {
        "amount": 0,
        "currency": "string"
      },
      "commission": {
        "amount": 0,
        "currency": "string",
        "type": "string"
      },
      "listingPrice": {
        "amount": 0,
        "currency": "string"
      },
      "isLowest": true,
      "lowestPrice": {
        "amount": 0,
        "currency": "string"
      },
      "declaredStockKeys": 0,
      "declaredStockReservedKeys": 0,
      "inventoryReservedKeys": 0
    }
  ]
}

400

{
    "message": "Bad Request. Wrong/Invalid params format.",
    "statusCode": 400 
}

401

{
    "message": "UnAuthorized request. Invalid/Expired token",
    "statusCode": 401
}

403

{
    "message": "Forbidden Request. Action not allowed or Rate Limit exhausted.", 
    "statusCode": 403
}

500

{
    "message": "Internal Server Error",
    "statusCode": 500
}