For Rental or Sale Order

All the print options Marked in BLUE in the dialog box shown below are controlled by Employee default setting. These will be automatically picked by API as well. Thus, will be considered based on the User Context of the Employee.

However, for the field Print the API ‘delivery receipt’ endpoint, will always consider ‘Only Shipped’.

For the fields in Yellow Box API will consider the following as default setting:

Delivery/Return Receipt: This is considered based on the APIs Endpoint.
Shipping Site/Returning Site: This is considered from User context site of the end point.
Printable Checkbox: Always be considered as true.

Delivery Receipt Print Form

The system will use the default Picklist form configured for the order's site.
If no form is set as DEFAULT, the system will use the first form listed alphabetically.
It is suggested to ensure that the folder containing the Forms is accessible through the R2API server.
- The best solution is configure it as a network path.

Pre-requisite

The folder where all the UI Form needed to generate a Delivery Receipt reside, must be a shared folder, so that I can be accessed by the app via your R2 deployment and vice-versa.

Alongside, it is understood that in most cases the above folder is configured locally within the deployment of R2, and modifying the file path for multiple UI forms can be a cumbersome task.

That's why we have an automated script available to modify file paths. Read more about it here..
And reach out to UBS Tech Support to help you with it.

POST

End Point: /warehouse/orders/{orderID}/deliveryreceipt/generate

This method allows you send a request to generate a delivery receipt.

In the request you can provide the from and to date which will get you only the items having this as last time status was changed.

Sample request payload

CODE

{
 "fromdate": "MM/dd/yyyy HH:mm",
 "todate": "MM/dd/yyyy HH:mm"
}

You may also include the following details in the Request.

CODE

{
 “shippingsiteid”: string, 
 “excludenonprintable”: boolean 
}

The value passed for the field fromdate must always be before todate.
- If fromdate > todate, system responds it with appropriate error message.
The value shippingsiteid is compared with contract line Shipping Site ID.
- If shippingSiteID is BLANK, system automatically considered it as "ALL SITES".
The excludenonprintable used to exclude non-printable lines.
- If excludenonprintable is not provided in payload, system considers it as FALSE.

Sample response payload

Response Information

The name of the generated PDF file will be included in the response header under Content-Disposition It will appear as an attachment with a specific filename.

Picklist Filename’s Naming Convention

<Order-ID>.pdf

Error Handling:

System automatically considers the following situation and responds appropriately

FORM UI is not found.
FORM UI is not accessible.
Any required input is not given in the request payload etc.