Agents
Creates and activates custom agent lists.
POST |
Creates a custom agent list based on geolocation or zipcode range.
Note
Geolocation can only be used in Belgium (BE), Denmark (DK), Estonia (EE), Finland (FI), Germany (DE), Luxembourg (LU), the Netherlands (NL), Norway (NO), Sweden (SE) and Åland (AX).
Note
If the agent list should be activated immediately, activate should be set to true.
type should be set to normal for geolocation and zipcode for zipcode range.
If normal, mapLongitude and mapLatitude are required.
If zipcode, an agentZipcodes array for each agent is required.
countryCode is always required.
For description of properties, please refer to the Property reference guide.
For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /agents POST.
GET |
Fetches all custom agent lists on the delivery checkout.
For description of properties, please refer to the Property reference guide.
For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /agents GET.
POST |
Activates a custom agent list.
URI parameters
Agent list id | string | Identification of the agent list | Required |
No response body is returned when an agent list is successfully activated.
For description of properties, please refer to the Property reference guide.
For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /agents/{id} POST.
DELETE |
Deletes an agent list.
Note
No response body is returned when an agent list is successfully deleted.
URI parameters
Agent list id | string | Identification of the agent list | Required |
For description of properties, please refer to the Property reference guide.
For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /agents/{id} DELETE.