Opretter og aktiverer brugerdefinerede agentlister.
Afsnit i denne artikel:
Opret en agentliste
POST /agents
Opretter en brugerdefineret agentliste baseret på geolokalisering eller postnummerinterval.
- Hvis agentlisten skal aktiveres med det samme, skal activate sættes til true.
-
type skal sættes til normal for geolokalisering og zipcode for postnummerinterval.
- Hvis normal, er mapLongitude og mapLatitude påkrævet.
- Hvis zipcode, kræves et agentZipcodes-array for hver agent.
-
countryCode er altid påkrævet.
Body-eksempel – geolokalisering
{
"key": "listkey",
"activate": "true",
"type": "normal",
"countryCode": "SE",
"agents": [
{
"id": "1",
"name": "Agent name 1",
"address1": "Test gatan 1",
"address2": "",
"zipcode": "41118",
"city": "Göteborg",
"state": "",
"countryCode": "SE",
"mapLongitude": "22.2",
"mapLatitude": "-11.1",
"phone": "07443332211",
"email": "test@test.com",
"additionalInfo": "Additional information",
"flags": [
"express",
"hem"
],
"openingHourWeekdays": [
{
"weekday": "monday",
"hours": [
{
"start": "08:00",
"stop": "22:00"
}
]
},
{
"weekday": "tuesday",
"hours": [
{
"start": "08:00",
"stop": "22:00"
}
]
},
{
"weekday": "wednesday",
"hours": [
{
"start": "08:00",
"stop": "22:00"
}
]
},
{
"weekday": "thursday",
"hours": [
{
"start": "08:00",
"stop": "22:00"
}
]
},
{
"weekday": "friday",
"hours": [
{
"start": "08:00",
"stop": "22:00"
}
]
},
{
"weekday": "saturday",
"hours": [
{
"start": "08:00",
"stop": "22:00"
}
]
},
{
"weekday": "sunday",
"hours": [
{
"start": "08:00",
"stop": "22:00"
}
]
}
],
"openingHourSpecialDays": [
{
"date": "2018-04-27",
"hours": [
{
"start": "10:00",
"stop": "16:00"
}
]
},
{
"date": "2018-04-28",
"hours": [
{
"start": "10:00",
"stop": "16:00"
}
]
},
{
"date": "2018-10-10",
"hours": [
{
"start": "10:00",
"stop": "16:00"
}
]
}
]
},
{
"id": "2",
"name": "Agent name 2",
"address1": "Testvägen 10",
"address2": "",
"zipcode": "11359",
"city": "Stockholm",
"state": "",
"countryCode": "SE",
"mapLongitude": "33.3",
"mapLatitude": "17.4",
"phone": "0700331122",
"email": "test2@test2.com",
"additionalInfo": "Additional information",
"flags": [
"hem"
],
"openingHourWeekdays": [
{
"weekday": "monday",
"hours": [
{
"start": "10:00",
"stop": "23:00"
}
]
},
{
"weekday": "tuesday",
"hours": [
{
"start": "10:00",
"stop": "23:00"
}
]
},
{
"weekday": "wednesday",
"hours": [
{
"start": "10:00",
"stop": "23:00"
}
]
},
{
"weekday": "thursday",
"hours": [
{
"start": "10:00",
"stop": "23:00"
}
]
},
{
"weekday": "friday",
"hours": [
{
"start": "10:00",
"stop": "23:00"
}
]
},
{
"weekday": "saturday",
"hours": [
{
"start": "10:00",
"stop": "23:00"
}
]
},
{
"weekday": "sunday",
"hours": [
{
"start": "10:00",
"stop": "23:00"
}
]
}
],
"openingHourSpecialDays": [
{
"date": "2020-12-24",
"hours": [
{
"start": "10:00",
"stop": "16:00"
}
]
},
{
"date": "2020-12-25",
"hours": [
{
"start": "10:00",
"stop": "16:00"
}
]
},
{
"date": "2020-12-26",
"hours": [
{
"start": "10:00",
"stop": "16:00"
}
]
}
]
}
]
}
Body-eksempel – postnummer
{
"key": "listkey",
"activate": "true",
"type": "zipcode",
"countryCode": "SE",
"agents": [
{
"id": "1",
"name": "Agent name 1",
"address1": "Test gatan 1",
"address2": "",
"zipcode": "41118",
"city": "Göteborg",
"state": "",
"country": "SE",
"phone": "07443332211",
"email": "test@test.com",
"additionalInfo": "Additional information",
"flags": [
"express",
"hem"
],
"agentZipcodes": [
{
"from": "40000",
"to": "45000"
},
{
"from": "46000",
"to": ""
}
],
"openingHourWeekdays": [
{
"weekday": "monday",
"hours": [
{
"start": "08:00",
"stop": "22:00"
}
]
},
{
"weekday": "tuesday",
"hours": [
{
"start": "08:00",
"stop": "22:00"
}
]
},
{
"weekday": "wednesday",
"hours": [
{
"start": "08:00",
"stop": "22:00"
}
]
},
{
"weekday": "thursday",
"hours": [
{
"start": "08:00",
"stop": "22:00"
}
]
},
{
"weekday": "friday",
"hours": [
{
"start": "08:00",
"stop": "22:00"
}
]
},
{
"weekday": "saturday",
"hours": [
{
"start": "08:00",
"stop": "22:00"
}
]
},
{
"weekday": "sunday",
"hours": [
{
"start": "08:00",
"stop": "22:00"
}
]
}
],
"openingHourSpecialDays": [
{
"date": "2018-04-27",
"hours": [
{
"start": "10:00",
"stop": "16:00"
}
]
},
{
"date": "2018-04-28",
"hours": [
{
"start": "10:00",
"stop": "16:00"
}
]
},
{
"date": "2018-10-10",
"hours": [
{
"start": "10:00",
"stop": "16:00"
}
]
}
]
}
]
}
Svar-eksempel
{
"id": "11111"
}For en beskrivelse af egenskaber henvises til Egenskabsreferenceguiden.
For skema og testning henvises til https://api.unifaun.com/rs-docs/, og naviger til /agents POST.
Hent agentlister
GET /agents
Henter alle brugerdefinerede agentlister i Delivery Checkout.
Svar-eksempel
[
{
"id": "11111",
"name": "listkey",
"active": true,
"status": "OK",
"created": "2021-05-19T14:08:00.179+0000"
}
]For en beskrivelse af egenskaber henvises til Egenskabsreferenceguiden.
For skema og testning henvises til https://api.unifaun.com/rs-docs/, og naviger til /agents GET.
Aktivér en agentliste
POST /agents/{id}Aktiverer en brugerdefineret agentliste.
URI-parametre
| Agent list id | string | Identifikation af agentlisten | Påkrævet |
Der returneres ingen svartekst, når en agentliste er aktiveret korrekt.
For en beskrivelse af egenskaber henvises til Egenskabsreferenceguiden.
For skema og testning henvises til https://api.unifaun.com/rs-docs/, og naviger til /agents/{id} POST.
Slet en agentliste
DELETE /agents/{id}Sletter en agentliste.
URI-parametre
| Agent list id | string | Identifikation af agentlisten | Påkrævet |
Der returneres ingen svartekst, når en agentliste er slettet korrekt.
For en beskrivelse af egenskaber henvises til Egenskabsreferenceguiden.
For skema og testning henvises til https://api.unifaun.com/rs-docs/, og naviger til
/agents/{id} DELETE.