Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
itemPrice
number
required

Item Price ($)

Required range: 0 <= x <= 10000000
quantity
number
required

Quantity

Required range: 1 <= x <= 1000000
shippingCharged
number

Shipping Charged to Buyer ($)

Required range: 0 <= x <= 10000000
productCost
number

Your Product Cost per Unit ($)

Required range: 0 <= x <= 10000000
shippingCostActual
number

Your Actual Shipping Cost ($)

Required range: 0 <= x <= 10000000
category
enum<string>

Category

Available options:
most,
books_media,
clothing,
sneakers,
jewelry,
electronics,
guitars,
cards,
coins_bullion,
heavy
finalValueFeeOverride
number

Custom Final Value Fee % (optional)

Required range: 0 <= x <= 100
fixedOrderFee
number

Per-Order Fee ($)

Required range: 0 <= x <= 10000
promotedListingPct
number

Promoted Listings Ad Rate (%)

Required range: 0 <= x <= 100
insertionFeeEach
number

Insertion Fee per Unit ($)

Required range: 0 <= x <= 10000
targetMarginPct
number

Target Profit Margin (%)

Required range: 0 <= x <= 99
currency
enum<string>

Currency

Available options:
USD,
EUR,
GBP,
AUD,
JPY,
CAD

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.