Bulk Upload Location Sample File

Overview

Get a download URL for the sample spreadsheet used by the bulk location upload. Checks S3 for assets/sample/Bulk Upload Location Sample.xlsx. If absent, uploads the bundled public/ copy to S3 first, then returns its S3 URL with a cache-busting ?v=<timestamp>. 400 if the sample file is missing from both S3 and local storage.

Prerequisites

• A bearer token. Callable with Partner and Account tokens.

Base URL

Endpoint

GET /api/v1/store/bulk-upload/sample/location-file

Authentication

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

• Who can call it: Partner and Account tokens.

• (Partner or Account user) — authentication, role-agnostic store/ group.

• No request-level scoping. Any authenticated user gets the same static sample-file URL.

Rate limit

• No rate limit.

Request

• (no path, query, or body parameters)

Response

• data.path (string) — S3 download URL for the sample file with a ?v=YmdHis cache-buster.

200 OK · 200

{
  "data": {
    "path": "https://d2ny6zb7otrnhl.cloudfront.net/assets/sample/Bulk Upload Location Sample.xlsx?v=20260624090758"
  }
}

400 Sample File Not Found · 400

{
  "message": "Bad Request",
  "status": "error",
  "errors": {
    "error": "Sample file not found"
  }
}

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/store/bulk-upload/sample/location-file" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'