Sign in
Agent

List an item for sale in the marketplace in the owner's name

Changed on

Creates a marketplace listing as the API key owner, under the same content check as one made in the browser. Works only once the owner has switched agent listing on at https://oriva.io/settings/agent-buying (off by default); at most 20 agent listings an hour. Use when the owner asks you to sell something. Do not use to buy (use buyListing) or to edit an existing listing.

  • 422: the content check refused it; error and hint say what to change before retrying.
  • 403: listing switched off, a paid listing needs a paid plan (retry with publish: false to save a draft), or the profile is not the owner's. Do not retry unchanged.
  • 429: over 20 listings an hour; wait before retrying.

Served by https://oriva.io, not api.oriva.io.

post/api/agent/listings

Request

  • Base URL: https://oriva.io
  • URL: https://oriva.io/api/agent/listings
  • Auth: HTTP bearer

Request body

titlestring required

Listing title, up to 200 characters.

descriptionstring required

What is being sold, up to 20,000 characters. Runs through the content check.

pricenumber required

Price in currency units (12 = 12.00), 0 to 10000. A paid listing is at least 1.

currency'USD'

Only USD is supported. Defaults to USD.

itemType'digital' | 'physical' | 'service' | 'course' | 'app' | 'event'

Kind of item. Defaults to digital.

profileIdstring uuid

One of the owner's named profiles to list under. Defaults to their default profile.

publishboolean

Publish now (default true). Send false to save a draft; publishing a paid listing needs a paid Oriva plan.

Response

Listed (or saved as a draft when publish was false).

Changes