Reprint a scan form (with carrier)

GET

/shipping/api/v1/scan_forms/{sub_carrier_id}/reprint/{collection_form_id}

• Veeqo API Production Server

Reprints a previously created scan form (manifest) document and returns it as a base64-encoded document.

When a sub-carrier identifier is provided, it is used to look up the company’s shipping configuration for that carrier.

Parameters

Path Parameters

sub_carrier_id

required

string

Sub-carrier identifier (e.g., USPS, ROYAL_MAIL, DPD_LOCAL). Used to look up the company’s shipping configuration.

Example

USPS

collection_form_id

required

string

The unique identifier of the scan form to reprint, returned by the history endpoint as collection_form_id (or the identical scan_form_id). The create response does not return an identifier.

Example

a1b2c3d4-e5f6-7890-abcd-ef1234567890

Responses

200

Scan form document retrieved successfully

object

manifest

The reprinted scan form document

object

document

Base64-encoded scan form document content

string

JVBERi0xLjQKJeLjz9MKMyAwIG9iago8P...

document_format

MIME type of the document, as returned by the carrier

string

application/pdf

error_messages

Array<string>

400

Bad request - missing or invalid collection_form_id

object

error_messages

required

List of error messages

Array<string>

[
  "to_address is required"
]

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

404

Scan form not found for the given collection_form_id

object

error_messages

required

List of error messages

Array<string>

[
  "to_address is required"
]

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