List notes

The call names what the notes hang on. The application keeps notes in two tables, and this endpoint reads both.

get/api/v1/notes

Request

Base URL: https://app.sellerassistant.app (the document declares no server; this is the origin it was published from)
URL: https://app.sellerassistant.app/api/v1/notes
Auth: one of:
- API key in query parameter api_key
- API key in header X-Api-Key

Query parameters

target_type'asin' | 'supplier' | 'purchase_order' | 'warehouse' | 'price_list' required

Example:asin

What the notes belong to.

target_idstring required

Example:ATVPDKIKX0DER/B08N5WRWNW

For the type asin the id is <marketplace_id>/<asin>.

pageinteger

Example:1

The page to read. It starts at 1.

per_pageinteger

Example:25

The rows a page carries. The maximum is 200.

Response

One page of the notes, newest first

Example response

{
  "data": [
    {
      "id": 7,
      "target_type": "asin",
      "target_id": "ATVPDKIKX0DER/B08N5WRWNW",
      "note": "check the box count",
      "user_id": 42,
      "user_name": "John Doe"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total": 137,
      "last_page": 6
    },
    "trial_limit": {
      "max_rows": 25,
      "total": 137,
      "code": "trial_list_limited",
      "message": "The trial shows only the first rows of a list. Subscribe to see all rows.",
      "subscribe_url": "https://app.sellerassistant.app/subscription"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.