GET v1/batches

shipengine.com

Summary: List Batches
Operation ID: list_batches
Auth: unknown
Description

List Batches associated with your Shipengine account

Parameters (6)

batch_number (string, query, optional)

Batch Number

page (integer, query, optional, default: 1)

Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.

Constraints: {'minimum': 1}

page_size (integer, query, optional, default: 25)

The number of results to return per response.

Constraints: {'minimum': 1}

sort_by (?, query, optional)
sort_dir (?, query, optional, default: desc)

Controls the sort order of the query.

status (?, query, optional)

No probe data for this endpoint yet.