Get scan form history for a carrier

PUT

/shipping/api/v1/scan_forms/{sub_carrier_id}/history

Veeqo API Production Server

Retrieve the history of previously created scan forms for a specific carrier.

When a carrier ID is provided, only scan forms for that carrier are returned. The sub_carrier_id is passed through to filter results.

Parameters

Path Parameters

sub_carrier_id

required

string

The sub-carrier identifier (e.g., USPS, UPS). Does not require a dedicated shipping configuration for this carrier — the system falls back to the base configuration.

Example

USPS

Request Body

object

start_date

Start date for the history range (YYYY-MM-DD)

string format: date

2026-01-01

end_date

End date for the history range (YYYY-MM-DD)

string format: date

2026-01-31

limit

Maximum number of scan form records to return

integer

collection_address

The collection/pickup address where packages will be collected from. You can provide either a saved address ID or the full address fields.

object

address_id

Veeqo Address Service ID for a saved address

string

b8b3e7b6-3adc-417f-963b-dd9851947ac2

name

Contact name at the collection address

string

My Warehouse

company

Company name

string

Acme Corp

phone

Phone number

string

+12065551234

email

Email address

string format: email

line1

Address line 1

string

410 Terry Ave N

line2

Address line 2

string

town

City/town

string

Seattle

postcode

Postal/ZIP code

string

country_code

ISO 3166-1 alpha-2 country code

string

US

county

State/region/county

string

WA

Examples

Get USPS scan form history

{
  "start_date": "2026-01-01",
  "end_date": "2026-01-31",
  "limit": 50,
  "collection_address": {
    "address_id": "b8b3e7b6-3adc-417f-963b-dd9851947ac2"
  }
}

Responses

200

Scan form history retrieved successfully

object

manifests

List of historical scan form records

Array<object>

A historical scan form record. The scan_form_id and collection_form_id are both returned by the API — they may have the same value. Use collection_form_id when calling the reprint endpoint.

object

scan_form_id

Unique identifier for the scan form

string

a1b2c3d4-e5f6-7890-abcd-ef1234567890

collection_form_id

Unique identifier for the collection form (used for reprinting)

string

a1b2c3d4-e5f6-7890-abcd-ef1234567890990001511

creation_date

Creation timestamp in epoch milliseconds. When filtering by start_date/end_date in the request (YYYY-MM-DD format), this timestamp falls within that date range.

integer format: int64

1775853637224

carrier_name

Name of the carrier

string

USPS

generation_status

Status of the scan form generation

string

Allowed values: COMPLETED PENDING FAILED

COMPLETED

ship_from_address

The address the shipments were sent from, as returned by the upstream carrier. Note: Response field names differ from the CollectionAddress request schema (e.g., address_line1 vs line1, city vs town, postal_code vs postcode).

object

name

string

Example Warehouse

company_name

string

nullable

address_line1

string

100 Main St Suite 200

address_line2

string

address_line3

string

city

string

Seattle

state_or_region

string

nullable

postal_code

string

country_code

string

US

district_or_county

string

nullable

phone_number

string

2065550123

email

string format: email

shipping@example.com

error_messages

Any error messages from failed history requests

Array<string>

400

Bad request

object

error_messages

required

List of error messages

Array<string>

[
  "to_address is required"
]

{
  "error_messages": [
    "Invalid request parameters"
  ]
}