Skip to main content
GET
Show my offers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept
enum<string>
default:application/json
required

API response format

Available options:
application/json

Query Parameters

with_id
integer

ID of a specific offer to retrieve. For getting a specific offer, pass the offer ID in this parameter. Optional parameter, not passed by default.

with_product_id
integer

Filter offers by product currency setting ID (product_currency_setting_id).

offset
integer
Example:

0

limit
integer
Example:

20

sort_column
enum<string>

Column to sort by. * Possible values: * * - price_per_step: Sort by price per step * - guarantee_delivery_time: Sort by guarantee delivery time * - status: Sort by offer status * - created_at: Sort by creation date * - updated_at: Sort by last update date

Available options:
price_per_step,
guarantee_delivery_time,
status,
created_at,
updated_at
Example:

"price_per_step"

sort_direction
enum<string>

Sort direction. * Possible values: * * - asc: Ascending order (from lowest to highest) * - desc: Descending order (from highest to lowest)

Available options:
asc,
desc
Example:

"asc"

with_status
enum<integer>

Filter by offer status. * Possible values: * * - 1 (Draft): Offer is saved as draft and not visible to others * - 2 (Active): Offer is active and visible to customers * - 3 (Not Active): Offer is not active and not visible to customers * - 4 (Need Details): Offer has not passed the review and needs additional details * - 5 (On Review): Offer is under review * - 6 (Sold): There is an order for this offer * - 7 (Transfered): The order for this offer has been completed * - 8 (Review Passed): Offer has passed the review and waiting for activation

Available options:
1,
2,
3,
4,
5,
6,
7,
8
Example:

3

Response

Success

data
object[]

Array of offers

total
integer

Total number of offers

Example:

100