PRproject44
Multi-Modal: Image Retrieval

Query for shipment images.

<h4><b>Required Fields</h4></b> <ul><li><b> capacityProviderAccountGroup: </b></li><ul><li><b> accounts: </b></li><ul><li> code </li></ul></ul><li><b> shipmentIdentifiers: </b></li><ul><li> type </li><li> value </li></ul><li><b> destinationAddress: </b></li><ul><li> postalCode </li></ul><li> documentType </li><li> mode </li></ul>
post/api/v4/images/query

Request

Request body

documentType'BILL_OF_LADING' | 'DELIVERY_RECEIPT' | 'WEIGHT_CERTIFICATE' | 'INVOICE' | 'INSPECTION_CERTIFICATE' | 'LETTER_OF_AUTHORIZATION' | 'LUMPER_CERTIFICATE' | 'PACKING_SLIP'

A code for the requested image's document type.

imageFormat'PDF' | 'TIF' | 'PNG' | 'GIF' | 'JPG'

A code for the format of the image to be returned. The capacity provider's image will be converted to this format. (default: 'PNG')

mode'PARCEL' | 'LTL' | 'VOLUME_LTL' | 'TRUCKLOAD' | 'OCEAN' | 'RAIL'

The transportation mode of the shipment for which images should be retrieved. Only LTL images are supported currently.

pickupDatestring date

The date this shipment was picked up by carrier. Some carriers require this to aid in retrieving documents. (format: yyyy-MM-dd)

Response

OK

documentType'BILL_OF_LADING' | 'DELIVERY_RECEIPT' | 'WEIGHT_CERTIFICATE' | 'INVOICE' | 'INSPECTION_CERTIFICATE' | 'LETTER_OF_AUTHORIZATION' | 'LUMPER_CERTIFICATE' | 'PACKING_SLIP'

A code for this image's document type, matching what was requested.

imageFormat'PDF' | 'TIF' | 'PNG' | 'GIF' | 'JPG'

A code for this image's format, matching what was requested.

imageUrlstring

The web URL for accessing this image.

Changes

No recorded changes to this operation across all 1 revision of this API.