Outprice API documentation

{
  "id": 1,
  "marketplace": "daraz",
  "source_url": "string",
  "poll_interval_minutes": 1,
  "status": "active",
  "created_at": "2024-01-15T09:30:00Z",
  "title": "string",
  "seller_name": "string",
  "venture": "string",
  "currency": "string",
  "category_tags": [
    "string"
  ],
  "attention_reason": "string",
  "next_poll_at": "2024-01-15T09:30:00Z",
  "rating": 1.1,
  "review_count": 1,
  "promotions": [
    "string"
  ],
  "buyer_price": 1.1,
  "latest": {
    "id": 1,
    "tracked_item_id": 1,
    "captured_at": "2024-01-15T09:30:00Z",
    "variant_count": 1,
    "extraction_method": "structured_data",
    "confidence_score": 1.1,
    "status": "accepted",
    "price": 1.1,
    "shipping": 1.1,
    "original_price": 1.1,
    "currency": "string",
    "in_stock": true,
    "anomaly_reason": "string",
    "seen_at": "2024-01-15T09:30:00Z",
    "readings": 1
  },
  "demand": {},
  "discounts": {},
  "fees_label": "string",
  "channels": [
    {}
  ],
  "own_price": 1.1,
  "price_gap_pct": 1.1,
  "own_shipping": 1.1,
  "own_shipping_is_default": false,
  "comparison_basis": "string",
  "comparison_note": "string",
  "cost_price": 1.1,
  "min_margin_pct": 1.1,
  "own_source_url": "string",
  "own_in_stock": true,
  "own_synced_at": "2024-01-15T09:30:00Z",
  "own_sync_status": "string",
  "own_sync_detail": "string",
  "own_pending_price": 1.1,
  "own_margin_pct": 1.1,
  "match_margin_pct": 1.1,
  "match_verdict": "string",
  "match_note": "string",
  "floor_price": 1.1
}

FR-5.1 — the user’s own listing price for gap calculation.

A price, or a link to the seller’s own listing to read it from, or both. A link is read before it is saved: one we cannot read is refused with the reason, the same rule as tracking a competitor, because a link that silently never updates is worse than no link.

Authentication

X-API-Keystring

Your Outprice API key (starts with pw_).

Path parameters

item_idintegerRequired

Request

This endpoint expects an object.

pricedouble or nullOptional

labelstring or nullOptional

source_urlstring or nullOptional<=2000 characters

cost_pricedouble or nullOptional>=0

min_margin_pctdouble or nullOptional>=0

shippingdouble or nullOptional>=0

shipping_for_allbooleanOptionalDefaults to false

Response

Successful Response

idinteger

marketplaceenum

source_urlstring

poll_interval_minutesinteger

statusenum

Allowed values:

created_atdatetime

titlestring or nullOptional

seller_namestring or nullOptional

venturestring or nullOptional

currencystring or nullOptional

category_tagslist of strings or nullOptional

attention_reasonstring or nullOptional

next_poll_atdatetime or nullOptional

ratingdouble or nullOptional

review_countinteger or nullOptional

promotionslist of strings or nullOptional

buyer_pricedouble or nullOptional

latestobject or nullOptional

demandmap from strings to any or nullOptional

discountsmap from strings to any or nullOptional

fees_labelstring or nullOptional

channelslist of maps from strings to any or nullOptional

own_pricedouble or nullOptional

price_gap_pctdouble or nullOptional

own_shippingdouble or nullOptional

own_shipping_is_defaultbooleanOptionalDefaults to false

comparison_basisstring or nullOptional

comparison_notestring or nullOptional

cost_pricedouble or nullOptional

min_margin_pctdouble or nullOptional

own_source_urlstring or nullOptional

own_in_stockboolean or nullOptional

own_synced_atdatetime or nullOptional

own_sync_statusstring or nullOptional

own_sync_detailstring or nullOptional

own_pending_pricedouble or nullOptional

own_margin_pctdouble or nullOptional

match_margin_pctdouble or nullOptional

match_verdictstring or nullOptional

match_notestring or nullOptional

floor_pricedouble or nullOptional

Errors

422

Unprocessable Entity Error