Excel export (partner)

Overview

Generate the partner review-response feed as an Excel file, store it on S3, and return the public download URL.

Prerequisites

• A bearer token. Callable with Partner tokens.

Base URL

Endpoint

POST /api/v1/partner/excel/download/review-response-feed

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Partner tokens.

• Mounted under the partner/excel group.

• The handler hard-gates on company.bundle_id == 1 (returns 500 with Access denied. Partner plan required. otherwise).

• Store set precedence: account_id (account); else store_id → single store; else all partner-user stores.

• All id params are guarded by an ownership check.

Rate limit

• No rate limit.

Request body

• Body:

{
  "range_start": "2024-01-01 00:00:00",
  "range_end": "2024-12-31 23:59:59",
  "account_id": 7
}

Response

• data.path (string) — S3 URL of the generated .xlsx (download/excel/YYYY-MM/<time>-ReviewResponseReport.xlsx)

200 Success · 200

{
  "data": {
    "path": "https://s3.amazonaws.com/bucket/download/excel/2024-01/1700000000-ReviewResponseReport.xlsx"
  }
}

Errors

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/partner/excel/download/review-response-feed" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"range_start": "2024-01-01 00:00:00", "range_end": "2024-12-31 23:59:59", "account_id": 7}'