go back to FreightMatchService

POST /freightmatch/{rowType}/{rowId}/{documentTypeId}

When DocumentPower is licensed and the ImagingDrop service is configured, images submitted to this end point will be indexed into the imaging application. When DocumentPower is not licensed and/or the option to 'Do not send documents to imaging' is enabled in Freight Matching Control, images will be stored as attachments to Order History comments.

Roles that can access this endpoint are Freight Matching.

Parameters

name description type default type
rowType the type of the object to which the image is associated.
  • O - Order
path String
rowId the ID of the type (most likely the primary key of the row) path String
documentTypeId the document type ID. path String
movementId the ID of the movement associated with the row query String
image a single image sent in the body of the request body of type: image/tiff InputStream

Result

Response

a String containing the batch ID (if staged for later batch pickup) or the ID of the record stored in the database.

Try It Out

Request

- Authentication Help
- String
- String
- String
- String
- InputStream