Get unmanifested shipments

PUT

/shipping/api/v1/scan_forms/unmanifested

• Veeqo API Production Server

Retrieve a list of carriers that have shipments which have not yet been included in a scan form.

Use this to check which carriers have pending shipments that need to be manifested before carrier pickup.

Responses

200

Unmanifested shipments retrieved successfully

object

carriers

List of carriers with unmanifested shipments

Array<object>

object

carrier_id

Carrier identifier, returned with the amazon_shipping_v2__ provider prefix.

The sub_carrier_id path parameter on the other scan form endpoints takes the bare sub-carrier code, so strip the prefix before using this value there — amazon_shipping_v2__USPS becomes USPS.

string

amazon_shipping_v2__USPS

carrier_name

Carrier name, also returned with the amazon_shipping_v2__ provider prefix.

string

amazon_shipping_v2__USPS

unmanifested_shipment_location_list

List of locations with unmanifested shipments for this carrier

Array<object>

object

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

98101

country_code

string

US

district_or_county

string

nullable

phone_number

string

2065550123

email

string format: email

shipping@example.com

last_manifest_date

Timestamp in epoch milliseconds of the most recent scan form created for this location. Null when no scan form has been created for it yet.

integer format: int64

nullable

1650163712052

localized_last_manifest_date

Human-readable form of last_manifest_date, in the carrier’s timezone

string

nullable

Saturday, April 16 2022 07:48 PM PDT

error_messages

Array<string>

400

Bad request - failed to retrieve unmanifested shipments

object

error_messages

required

List of error messages

Array<string>

[
  "to_address is required"
]

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