List shipments eligible for a scan form or firm book
Returns shipments within the date range that are eligible to be included in a scan form (USPS) or firm book (FedEx). Pass formType as 0 for ScanForm or 1 for FirmBook.
Path parameters
clientid
client id (integer)
formType
Form type. 0 = ScanForm, 1 = FirmBook
Allowed values:
startDate
start date (DateTime)
endDate
end date (DateTime)
Headers
Authorization
EX: “Basic dXNlcm5hbWU6cGFzc3dvcmQ=”
API_KEY
EX: “B30BBEC3-8086-49B6-9893-2FCD31FA2BBF”
Response
Returned if there are no http errors.
Shipment
class for passing in all requirements to quote or buy a shipment
ShipmentStatus
Indicates whether a shipment has been SAVED = 0, or CREATED = 1 SAVED=0; CREATED=1;
Status
Was the request for this shipment successful, you will general see SUCCESS or FAILURE, NOTE and WARNING are rarely used. FAILURE = 0, SUCCESS = 1, WARNING = 2, NOTE = 3 FAILURE=0; SUCCESS=1; WARNING=2; NOTE=3;
StatusMessages
Message should be expected if Status is FAILURE
Error
Error will be empty or NULL if no error was encountered
Rates
List of rates returned for a quote or purchase
Purchase
ForbiddenWords
If forbidden words were found on a shipment they will be returned here
IsPending
Used to prevent duplicate shipments and send friendly info to caller.
Errors
400
Bad Request Error