Create a scan form

​

A ScanForm can be created in two ways:

  1. Create a ScanForm for Shipments directly
  2. Create a ScanForm for a Batch of Shipments

NOTE: A ScanForm can only include shipments from one carrier account. Shipments from different carrier accounts require separate ScanForms.

A ScanForm object is immutable once created. All information must be provided during creation; it cannot be modified later.

Body

required
application/json

Responses

  • application/json
  • application/json
  • 401

    Unauthorized request

  • application/json
Request Example for post/scan_forms
curl https://api.test.vesyl.com/v2/scan_forms \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "reference": "SCAN123",
  "carrier": "USPS",
  "up_to_time": "2025-10-02T19:27:57Z"
}'
No Body

Scan form created successfully

Previous
Retrieve all scan forms
Next
Retrieve a scan form