Skip to main content

List Activity

GET 

/api/shippo/instances/:integration_instance/activity

Paginated audit feed of actions across the Shippo integration: connect/disconnect, connection failures, settings changes, syncs triggered and completed, warehouse and service-level mapping changes, order pushes and recalls, label purchases, refunds and cost reversals.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Event names include: connected, disconnected, connection_failed, settings_updated, sync_triggered, carriers_synced, warehouse_mapped, warehouse_unmapped, service_level_updated, service_levels_auto_matched, service_levels_imported, order_submitted, order_recalled, label_purchased, label_refund_requested, label_cost_reversed, shipment_recorded.

Filtering: every filter[<column>] param below accepts an operator suffix, filter[<column>.<operator>]=<value>; list operators take a comma-separated value. Alternatively pass a nested AND/OR tree in filter_groups (base64-encoded JSON) — see that param.

Sorting: created_at, event, id (default -created_at then -id). Pagination: per_page defaults to 15.

Returns a standard paginated envelope: data[] plus current_page, from, to, per_page, total, last_page, first_page_url, last_page_url, next_page_url, prev_page_url, path and links. Returns 404 for an unknown instance.

Authentication: Requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type