HomeGuidesAPI ReferenceChangelogSupport Request
API Reference

Get Shipment Packages via Stream - getShipmentPackagesStream

You can retrieve shipment packages for orders placed by customers using cursor-based pagination. This method provides a more efficient and reliable way to fetch order packages compared to traditional page-number-based pagination. Data is returned in a fixed sort order: lastModifiedDate newest to oldest (DESC). The content array contains the same shipment package structure as the getShipmentPackages endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Seller ID

Query Params
integer
≤ 200
Defaults to 50

Maximum number of packages to return per request (default 50, maximum 200)

string

Opaque token used to fetch the next page. Must not be sent in the first request. Use the nextCursor value from the response as-is.

string

Filter by package item statuses. Multiple statuses can be sent separated by commas. Valid values: Created, Picking, Invoiced, Shipped, Cancelled, Delivered, UnDelivered, Returned, UnSupplied, AtCollectionPoint, UnPacked, Awaiting

int64

Fetch packages modified after this date (Unix timestamp in milliseconds)

int64

Fetch packages modified before this date (Unix timestamp in milliseconds)

Headers
string
required

Store front code. Works the same way as the existing getShipmentPackages service.

Responses

400

Bad Request - Invalid nextCursor value, invalid sellerId, cursor-filter mismatch

401

Unauthorized

429

Too Many Requests

500

Internal server error

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json