WashDryFold (WDF) ProLink Orders
This resource represents WashDryFold (WDF) ProLink orders.
Encode HTML
Be sure to encode HTML characters so they get transmitted in parameter (e.g. # is %23)
Get WDF order by ID
Return details about a single WDF order by ID
GET /api/location/{locationID}/wdf/order/{orderID}
EXAMPLE: Retrieving order ID 456 details for location 123/api/location/123/wdf/order/456
Get WDF order by OrderNumber
Return details about a single WDF order by number
GET/api/location/{locationID}/wdf/?OrderNum={orderNum}
EXAMPLE: Retrieving order # “ABC123” details for location 123/api/location/123/wdf/order?orderNum=ABC123
Get WDF orders
Return details about one or more WDF order(s) by current State
Requirements: Account Admin or 'WDF' privilege
Creation, Start, Finish min+max date/times are optional
Request
Path parameters
Query parameters
GET /api/location/{locationID}/wdf/order
EXAMPLE: Retrieving all open orders for location 123/api/location/123/wdf/order?states=open
EXAMPLE: Retrieving newest 10 finished orders for location 123 for the month of June 2025/api/location/123/wdf/order?states=finished&finishDateMin=2025-06-01&finishDateMax=2025-06-30&limit=10&sortKey=finishDate&sort=desc
Response
Name | Type | Description | Notes |
|---|---|---|---|
| long | Order ID |
|
| string | Order number |
|
| int | Order status | 0 = Unknown |
| string | Hex Color | Web format (e.g. "#A0B1C2") |
| decimal | Order sale price |
|
| decimal | Order cost | Summation of machine start vend costs |
| float | Order weight |
|
| DateTime | Creation date/time | Set when order first created |
| DateTime | Start date/time | Set with first machine transaction but can also set directly. May be NULL if machine not yet started against order |
| DateTime | Completion date/time | Read-only - Is set when transitioning state to 'Finished' May be NULL if not order not completed |
| DateTime | Max date/time to accept machine start transactions | Set with account default or can be set directly. |
| int | User ID of employee user that created order | Read-only |
| int | UserAccount ID of employee currently assigned to order |
|
Create WDF order
Creates a new WDF order
Raw Body must be provided with request details. Response will be returned as WDF Order GET.
Requirements: Account Admin or 'WDF' privilege
POST /api/location/{locationID}/wdf/order
EXAMPLE body: Creating a new order with order# of “ABC123”, sale price of $20, weight of 10.5lbs, and no user specified (to be automatically assigned)
{
"OrderNum": "ABC123",
"SalePrice": "20.00",
"Weight": "10.5"
}Name | Type | Description | Notes |
|---|---|---|---|
| string | Order number |
|
| decimal | Order sale price | Optional field |
| float | Order weight | Optional field |
| int | UserAccount ID of employee to be assigned to order | Optional to specify WDF user for order, otherwise if not specified then one will be automatically created/assigned. |
Edit WDF order
Edit details for a particular WDF order
Raw Body must be provided with request details (include only field to be modified). Response will be returned as WDF Order GET.
Requirements: Account Admin or 'WDF' privilege
PATCH /api/location/{locationID}/wdf/order/{orderID}
EXAMPLE body: Editing existing order to set new cost
{
"SalePrice": "25.00"
}EXAMPLE body: Editing existing order reset expiration
{
"ResetValidUntilDate": "true"
}Name | Type | Description | Notes |
|---|---|---|---|
| string | Order number |
|
| int | Order status | 0 = Unknown |
| decimal | Order sale price |
|
| float | Order weight |
|
| DateTime | Start date/time | Set with first machine transaction but can also set directly. |
| DateTime | Max date/time to accept machine start transactions | Set with account default or can be set directly. |
| int | UserAccount ID of employee currently assigned to order |
|
| bool | Request flag to reset the ValidUntilDate for existing order | Write-only field for existing orders Will set the ValidUntilDate to future date/time as specified in minutes for the WDF Account settings |