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 , Only pre released product, 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.
status	query	string	No	active, inactive, disabled-by-admin Represents the current state of the offer.
automatePriceStatus	query	string	No	enable, disable Indicates whether Automate Pricing is active for this offer.
limit	query	number	No	Specifies the number of items to fetch per page; valid values range from 10 to 200.

Response

200

{
  "message": "string",
  "statusCode": 200,
  "totalPages": 0,
  "totalCount": 0,
  "data": [
    {
      "offerId": 0,
      "product": {
        "id": 0,
        "title": "string",
        "productStatus": "string"
        "isPreReleased" 0
      },
      "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

401

403

500

Offer Status

Value	Label	Description
1	Active	Product is live and available for purchase.
0	Inactive	Product is not available for purchase.
< 0	Disabled	Product has been restricted or disabled by an administrator.