Download the locations spreadsheet template

Overview

Get a link to the sample spreadsheet for adding locations in bulk.

Use this before your first bulk upload so your file has the right columns. Fill it in and send it with Upload locations for review.

You'll need an account or partner token.

Returns a download URL.

Prerequisites

• A Partner or Account token. See Authentication.

Base URL

Endpoint

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

Authentication

Partner or Account token

• Every token gets the same template link. There is nothing to scope.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Response payload

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

Examples

Success payload

See Response payload.

Error payload

400 Sample file not found

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

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'