Once a user has found their property they can request new or replacement containers for the types of waste that are collected.
Available Containers
Users are presented with a checkbox list of the types of container they can order. The list reflects the options returned from the provider.
Available Containers Schema
Responsible for retrieving the new and replacement bins the property is eligible for. Full technical information about the End Points and schema used for containers can be found in the Waste Services Specification document.
Request
| Parameter Name | Description | Required | Type |
|---|---|---|---|
| UPRN | The UPRN of the selected property | Yes | String |
Return
| Parameter name | Property Name | Description | Required | Type |
|---|---|---|---|---|
| Success | Whether the API call was successful | Yes | Boolean | |
| selectedAddress | The address for the selected property. | Yes | Object | |
| Uprn | The UPRN of the property | String | ||
| Usrn | Universal street reference number | String | ||
| parentUPRN | The UPRN for the parent property if it has one | String | ||
| fullAddress | The full address formatted for one line | String | ||
| optionGroupNewBins | Array of new bins to offer to the user, formatted as a checkbox group: | Yes | Array | |
| Waste type, i.e. "Food" | String | |||
| Full bin name, i.e. "Food - 23L Caddy. There is no charge for this container" | String | |||
| Empty | String | |||
| optionGroupReplacementBins | Array of replacement bins to offer to the user, formatted as a checkbox group: | Yes | Array | |
| Waste type, i.e. "Food" | String | |||
| Full bin name, i.e. "Food - 23L Caddy. There is no charge for this container" | String | |||
| Empty | String | |||
Payment and Ordering
Once users have made a selection they are typically presented with a summary and inputs to enter their contact details. This part of the process is handled entirely by our platform and can include redirection to any of the standard supported payment providers.
Once payment has been confirmed (or if no charge was required) the order can be placed.
Order Schema
Responsible for returning the full information associated with the bins selected as new or replacement containers. Full technical information about the End Points and schema used for ordering containers can be found in the Waste Services Specification document.
Request
| Parameter name | Description | Required | Type |
|---|---|---|---|
| Uprn | Yes | String | |
| selectedNewBins | Array of bin IDs, indicating the user's selection of new bins to order | No | String Array |
| selectedReplacementBins | Array of bin IDs, indicating the user's selection of replacement bins to order | No | String Array |
Return
| Parameter name | Property Name | Description | Required | Type |
|---|---|---|---|---|
| Success | Whether the API call was successful | Yes | Boolean | |
| Bins | Array of objects, indicating all bins that were ordered | Yes | Obj Array | |
| Id | The ID of the bin, from the perspective of the provider | String | ||
| wasteType | i.e. "Food", "Recycling" | String | ||
| Size | Descriptive size of the bin, i.e. "240L" | String | ||
| binType | i.e. "Caddy", "Sack" | String | ||
| chargeType | "New" or "Replacement" | String | ||
| Charge | How much the bin costs | Float | ||
| Total | Total cost for all bins | Yes | Float |
Start Workflow
Once a user has request a new or replacement bin a workflow starts which creates a service request in the provider's system. Typically notification emails are also sent and records are added to a report history.
Share this page
