sellytics API Documentation (0.9.0)

Welcome to the reference for the sellytics REST API!

The sellytics API is organised around REST and provides crawled marketplace data. Different types of data include products, categories (including ranking of products), keyword (including ranking of products), offer listings (including sellers), reviews (including content and author) and sellers. The advanced technology allows users to queue jobs in a prioritized manner.

The sellytics REST API provides a broad set of operations and resources that:

  • Enables the creation of jobs filled with tasks
  • Enables queueing crawling jobs to fetch live marketplace data

Want to share your opinion on how our API works for you? Tell us how you feel about using our API and let us know if you have suggestions about possible improvements.

Authentication

OAuth2

Security scheme type: OAuth2
password OAuth Flow
Token URL: https://auth.sellytics.com/oauth/token
Scopes:

    Jobs & Tasks

    Create job with offer listing tasks

    Authorizations:
    Request Body schema: application/json

    jobRequest

    callbackUrl
    string

    Optional: Put {{jobID}} in the CallBack-URL, it will be replaced with corresponding JobID.

    tasks
    Array of objects (OfferTaskRequest)

    List of tasks. A task contains ASIN and a specific marketplace. Marketplace can be mixed within one job.

    Responses

    201

    Created

    post /amazon/jobs/offer-listings/v1
    https://api.sellytics.com/amazon/jobs/offer-listings/v1

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "callbackUrl": "https://url.com/{{jobID}}",
    • "dateCreated": "2019-09-06T11:35:26Z",
    • "id": "string",
    • "status":
      {
      },
    • "taskType": "UNDEFINED"
    }

    Create job with product tasks

    Authorizations:
    Request Body schema: application/json

    jobRequest

    callbackUrl
    string

    Optional: Put {{jobID}} in the CallBack-URL, it will be replaced with corresponding JobID.

    tasks
    Array of objects (ProductDetailTaskRequest)

    List of tasks. A task contains ASIN and a specific marketplace. Marketplace can be mixed within one job.

    Responses

    201

    Created

    post /amazon/jobs/products/v1
    https://api.sellytics.com/amazon/jobs/products/v1

    Request samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {}

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "callbackUrl": "https://url.com/{{jobID}}",
    • "dateCreated": "2019-09-06T11:35:26Z",
    • "id": "string",
    • "status":
      {
      },
    • "taskType": "UNDEFINED"
    }

    Get list of created jobs

    Authorizations:
    query Parameters
    page
    integer <int32>

    page

    size
    integer <int32>

    size

    sort
    string

    sort

    Responses

    200

    OK

    get /amazon/jobs/v1
    https://api.sellytics.com/amazon/jobs/v1

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "content":
      [
      ],
    • "pagination":
      {
      }
    }

    Get status of a specific job

    Authorizations:
    path Parameters
    id
    required
    string

    id

    Responses

    200

    OK

    get /amazon/jobs/{id}/status/v1
    https://api.sellytics.com/amazon/jobs/{id}/status/v1

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "date": "2019-09-06T11:35:26Z",
    • "message": "Job is done.",
    • "statusCode": "DONE"
    }

    Get a specific job

    Authorizations:
    path Parameters
    id
    required
    string

    id

    Responses

    200

    OK

    get /amazon/jobs/{id}/v1
    https://api.sellytics.com/amazon/jobs/{id}/v1

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "callbackUrl": "https://url.com/{{jobID}}",
    • "dateCreated": "2019-09-06T11:35:26Z",
    • "id": "string",
    • "status":
      {
      },
    • "taskType": "UNDEFINED"
    }

    Get task items from a offer listing job

    Authorizations:
    path Parameters
    id
    required
    string

    id

    query Parameters
    page
    integer <int32>

    page

    size
    integer <int32>

    size

    sort
    string

    sort

    Responses

    200

    OK

    get /amazon/jobs/offer-listings/{id}/tasks/v1
    https://api.sellytics.com/amazon/jobs/offer-listings/{id}/tasks/v1

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "content":
      [
      ],
    • "pagination":
      {
      }
    }

    Get task items from a product job

    Authorizations:
    path Parameters
    id
    required
    string

    id

    query Parameters
    page
    integer <int32>

    page

    size
    integer <int32>

    size

    sort
    string

    sort

    Responses

    200

    OK

    get /amazon/jobs/products/{id}/tasks/v1
    https://api.sellytics.com/amazon/jobs/products/{id}/tasks/v1

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "content":
      [
      ],
    • "pagination":
      {
      }
    }

    Get callback items from a specific job

    Authorizations:
    path Parameters
    id
    required
    string

    id

    Responses

    200

    OK

    get /amazon/jobs/{id}/callbacks/v1
    https://api.sellytics.com/amazon/jobs/{id}/callbacks/v1

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "callbackResults":
      [
      ],
    • "dateCreated": "2019-09-06T11:35:26Z",
    • "id": "string",
    • "statusCode": "CREATED",
    • "url": "string"
    }

    Products

    Get a a list of matching products

    Authorizations:
    path Parameters
    marketplace
    required
    string
    Enum: "DE" "US" "FR" "UK" "CA" "IN" "IT" "ES"

    marketplace

    slug
    required
    string

    slug

    query Parameters
    page
    integer <int32>

    page

    size
    integer <int32>

    size

    sort
    string

    sort

    Responses

    200

    OK

    get /amazon/products/search/hasMarketplaceAndSalesRankSlug/{marketplace}/{slug}/v1
    https://api.sellytics.com/amazon/products/search/hasMarketplaceAndSalesRankSlug/{marketplace}/{slug}/v1

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "content":
      [
      ],
    • "pagination":
      {
      }
    }

    Get a a list of products in this marketplace

    Authorizations:
    path Parameters
    marketplace
    required
    string
    Enum: "DE" "US" "FR" "UK" "CA" "IN" "IT" "ES"

    marketplace

    query Parameters
    page
    integer <int32>

    page

    size
    integer <int32>

    size

    sort
    string

    sort

    Responses

    200

    OK

    get /amazon/products/{marketplace}/v1
    https://api.sellytics.com/amazon/products/{marketplace}/v1

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "content":
      [
      ],
    • "pagination":
      {
      }
    }

    Get a specific product

    Authorizations:
    path Parameters
    asin
    required
    string

    asin

    marketplace
    required
    string
    Enum: "DE" "US" "FR" "UK" "CA" "IN" "IT" "ES"

    marketplace

    Responses

    200

    OK

    get /amazon/products/{marketplace}/{asin}/v1
    https://api.sellytics.com/amazon/products/{marketplace}/{asin}/v1

    Response samples

    Content type
    application/json
    Copy
    Expand all Collapse all
    {
    • "asin": "string",
    • "availability":
      {
      },
    • "bestsellerRankings":
      [
      ],
    • "brand":
      {
      },
    • "bulletpoints":
      [
      ],
    • "buybox":
      {
      },
    • "category":
      {
      },
    • "categoryBestsellerRanking": 0,
    • "dateCreated": "2019-09-06T11:35:27Z",
    • "description": "string",
    • "disabled": true,
    • "ean": "string",
    • "imageUrls":
      [
      ],
    • "lastUpdated": "2019-09-06T11:35:27Z",
    • "listedSince": "2019-09-06T11:35:27Z",
    • "marketplace": "DE",
    • "marketplacePriceOffer":
      {
      },