Skip to main content

AccelerList API Beta Documentation

Access your inventory batch data programmatically with the AccelerList Public API.

Updated over a month ago

Quick Start

1. Get Your API Key

  1. Go to Settings → API in your AccelerList dashboard

  2. Click Generate API Key

  3. Copy and securely store your API key

⚠️ Important: You need an active subscription to use the API.

2. Make Your First Request

curl "https://backend.accelerlist.com/api/v1/public_beta/batch/list?api_key=YOUR_API_KEY"

That's it! You're ready to use the API.

Base URL

All requests go to:

https://backend.accelerlist.com/api/v1/public_beta

Authentication

Include your API key as a query parameter in every request:

?api_key=YOUR_API_KEY

Example:

curl "https://backend.accelerlist.com/api/v1/public_beta/batch/list?api_key=YOUR_API_KEY"

Endpoints

List Batches

Get all your batches with pagination and optional filtering.

Endpoint: GET /batch/list

Parameters:

Parameter

Type

Required

Default

Description

api_key

string

Yes

-

Your API key

page

integer

No

1

Page number

page_size

integer

No

10

Items per page (max 100)

status

string

No

-

Filter: in_progress, completed, or deleted

Example:

curl "https://backend.accelerlist.com/api/v1/public_beta/batch/list?api_key=YOUR_API_KEY&page=1&page_size=10&status=completed"

Response Fields:

Field

Type

Description

total

integer

Total number of batches

pages

integer

Total number of pages

page

integer

Current page number

per_page

integer

Items per page

results

array

Array of batch objects

Batch Object:

Field

Type

Description

id

string

Unique batch identifier (UUID)

name

string

Batch name

status

string

In Progress, Completed, or Deleted

created_at

string

ISO 8601 timestamp

updated_at

string

ISO 8601 timestamp

num_mskus

integer

Number of unique SKUs

total_items

integer

Total quantity of items

est_profit

float

Estimated profit

type

string

FBA or MF

channel

string

Sales channel (e.g., AMAZON_NA)

marketplace_id

string

Amazon marketplace ID

Get Batch Details

Get detailed information about a specific batch, including all items.

Endpoint: GET /batch/{batchId}

Parameters:

Parameter

Type

Required

Default

Description

api_key

string

Yes

-

Your API key

batchId

string

Yes

-

Batch ID (URL parameter)

page

integer

No

1

Page number for items

page_size

integer

No

50

Items per page (max 100)

Example:

curl "https://backend.accelerlist.com/api/v1/public_beta/batch/550e8400-e29b-41d4-a716-446655440000?api_key=YOUR_API_KEY&page=1&page_size=50"

Response Fields:

Field

Type

Description

batch_metadata

object

Batch information

items

object

Paginated items with total, pages, page, per_page, data

condition_notes

array

Available condition notes

listing_defaults

object

Default listing settings

Rate Limits

The API enforces rate limits to ensure fair usage:

  • 60 requests per minute

  • 1000 requests per hour

Rate limit information is included in every response:

{   
  "rate_limit": {     
    "remaining_minute": 59,     
    "remaining_hour": 999,     
    "limit_per_minute": 60,     
    "limit_per_hour": 1000   
  } 
}

If you exceed limits, you'll receive a 429 Too Many Requests response. Implement exponential backoff to retry after the limit resets.

Error Handling

The API uses standard HTTP status codes:

Code

Meaning

Description

200

OK

Request successful

400

Bad Request

Invalid parameters

401

Unauthorized

Invalid or missing API key

403

Forbidden

Active subscription required

404

Not Found

Resource not found

429

Too Many Requests

Rate limit exceeded

500

Server Error

Internal server error

Best Practices

  1. Store API keys securely

    • Use environment variables: os.environ.get('ACCELERLIST_API_KEY')

    • Never commit keys to version control

    • Use secrets management tools in production

  2. Handle pagination

    • Always check pages to know when to stop

    • Use reasonable page_size values (10-100)

    • Don't request more data than needed

  3. Respect rate limits

    • Monitor rate_limit in responses

    • Implement exponential backoff for 429 errors

    • Batch requests when possible

  4. Error handling

    • Always check response status codes

    • Handle network errors gracefully

    • Log errors for debugging

  5. Cache responses

    • Batch data doesn't change frequently

    • Cache responses to reduce API calls

    • Set appropriate cache TTLs

Troubleshooting

"Invalid API key" error

  • Verify your API key is correct (no extra spaces)

  • Check that your subscription is active

  • Generate a new API key if needed

"Rate limit exceeded" error

  • Check rate_limit.remaining_minute in responses

  • Implement request throttling

  • Wait for the rate limit window to reset

Empty results

  • Check that filters are correct (status values are lowercase)

  • Verify you have batches in your account

  • Try without filters to see all batches

Connection errors

  • Verify the base URL is correct

  • Check your network connection

  • On corp machines: Ensure firewall allows outbound HTTPS

Support

Need help? Contact us through Intercom with:

  • API endpoint you're calling

  • Request parameters (without API key)

  • Error message or status code

  • What you expected vs what happened

Did this answer your question?