API reference

Account

Check a key and see what needs you.

Who this key belongs to

GET/v1/me

Needs a key with read

The person behind the key, what the key may do, their shops and how many requests they've made this month. A good first call to check a key works.

Request

curl https://api.resell.store/v1/me \
  -H "Authorization: Bearer $RESELL_KEY"

Response

{
  "object": "account",
  "id": "usr_7Qm2",
  "name": "Maya Rivera",
  "email": "maya@example.com",
  "key": {
    "kind": "api",
    "scopes": [
      "read",
      "shops",
      "listings",
      "messages",
      "offers",
      "orders",
      "buying",
      "webhooks"
    ],
    "ask_first": [],
    "max_offer": null
  },
  "shops": [
    {
      "object": "shop",
      "slug": "maya",
      "name": "Maya's closet",
      "url": "https://maya.resell.store"
    }
  ],
  "usage": {
    "requests": 1240,
    "limit": 10000
  }
}

What needs you

GET/v1/inbox

Needs a key with read

Everything waiting on you right now, across all your shops: offers to answer, sales to ship and unread messages from buyers, plus counters waiting on you as a buyer. The same list as the badge in the app.

Request

curl https://api.resell.store/v1/inbox \
  -H "Authorization: Bearer $RESELL_KEY"

Response

{
  "object": "inbox",
  "offers_to_answer": [
    {
      "object": "offer",
      "id": "off_1",
      "status": "open",
      "amount": 150,
      "listing": {
        "title": "Yellow dutch oven, 5.5 qt"
      }
    }
  ],
  "sales_to_ship": [],
  "unread_threads": 2,
  "counters_to_answer": [],
  "unread_as_buyer": 0
}