GetPickupPoint API
Guide de référence et d’utilisation (version 1.2)
Table des matières :
1 / Présentation du webservice GetPickupPoint
2 / Point de terminaison
3 / En-têtes
4 / Paramètres
5 / Réponse
1/ Présentation du webservice GetPickUpPoint
L’API GetPickUpPoint permet aux utilisateurs de récupérer les points de ramassage les plus proches en fonction d’une adresse spécifiée ou de coordonnées géographiques. Cette API est conçue pour offrir de la flexibilité en permettant aux utilisateurs de rechercher soit par une adresse physique, soit par des coordonnées de latitude et de longitude. En spécifiant des paramètres tels que le nombre maximum de résultats à renvoyer et s’il faut inclure des points de relais en double, les utilisateurs peuvent adapter leurs demandes à leurs besoins spécifiques. Ce document décrit l’utilisation du point de terminaison GetPickUpPoint, en détaillant le format de demande requis, les paramètres optionnels et les exemples de réponses pour assurer une intégration transparente et une utilisation efficace du service.
2/ Point de terminaison
|
URL |
https://api.crossdeskmap.com/PointAvailability/GetPickUpPoint |
|
Request Type de requête |
POST |
|
Corps (Exemple) |
{
"duplicateRelay": false,
"limit": 4,
"address": "328 RUE D ARMENTIERES",
} |
3/ En-têtes
| Paramètre | Type | Requis | Exemple | Description |
|---|---|---|---|---|
|
Domain |
String |
Requis |
abc.com |
Domaine fourni pour l'authentification |
|
Key |
String |
Requis |
Tnecu48E… |
Clé API fournie pour l'authentification |
4/ Paramètres
| Paramètre | Type | Requis | Exemple | Description |
|---|---|---|---|---|
|
duplicateRelay |
boolean |
Requis |
False |
Indique s'il faut inclure des points de relais en double pour les emplacements les plus proches. |
|
limit |
integer |
Requis |
10 |
Le nombre maximum de points de ramassage les plus proches à récupérer. |
|
address |
string |
Optionnel |
22 Rue du Départ, Paris |
L'adresse pour rechercher les points de ramassage les plus proches. Ceci est optionnel si vous récupérez les enregistrements en fonction de la latitude et de la longitude. Si ce n'est pas nécessaire, passez null. |
|
latitude |
float |
Optionnel |
50.70272505 |
La coordonnée de latitude pour l'emplacement. Ceci est optionnel si vous récupérez les enregistrements en fonction de l'adresse. Si ce n'est pas nécessaire, passez null. |
|
longitude |
float |
Optionnel |
2.84280216 |
La coordonnée de longitude pour l'emplacement. Ceci est optionnel si vous récupérez les enregistrements en fonction de l'adresse. Si ce n'est pas nécessaire, passez null. |
Note : Vous devez fournir soit une adresse, soit la latitude et la longitude.
Exemple Postman : https://documenter.getpostman.com/view/361951/2sAXjGbYnk
5/ Réponse
La réponse sera un objet JSON contenant les points de ramassage les plus proches en fonction des critères fournis.
Exemple de demande
{
“duplicateRelay”: false,
“limit”: 4,
“address”: “328 RUE D ARMENTIERES”
}
Exemple de réponse
{
“locations”: [
[
{
“pickUpPointId”: “07e35bea-67c8-49a3-b61f-be5d15d054c2”,
“pickupPointTypeId”: “738c9037-b0eb-4a7b-bc9a-e15b8a71bfc9”,
“carrierServiceId”: “051581ba-9041-4f40-9528-5adab1ca008c”,
“name”: “AUX FLEURS INSOLITES”,
“address1”: “935 RUE D ARMENTIERES”,
“address2”: “”,
“city”: “NIEPPE”,
“postalCode”: “59850”,
“positionX”: “50.7020930”,
“positionY”: “2.84326040”,
“code”: “1876S”,
“active”: 1,
“locationImage”: null,
“locationMarker”: “api.crossdeskmap.com/wwwroot/LocationIcons/marker_20240110-114031_Chronopost.png”,
“homeMarker”: “api.crossdeskmap.com/wwwroot/LocationIcons/marker_Home.png”,
“distance”: “77.4 m”,
“pickupPointSchedules”: {
“Sunday”: [
“09:00 – 12:00”,
“14:00 – 19:00”
],
“Monday”: [
“”,
“”
],
“Tuesday”: [
“09:00 – 12:00”,
“14:00 – 19:00”
],
“Wednesday”: [
“09:00 – 12:00”,
“14:00 – 19:00”
],
“Thursday”: [
“09:00 – 12:00”,
“14:00 – 19:00”
],
“Friday”: [
“09:00 – 12:00”,
“14:00 – 19:00”
],
“Saturday”: [
“09:00 – 12:00”,
“14:00 – 19:00”
]},
“pickupPointType”: {
“pickupPointTypeId”: “738c9037-b0eb-4a7b-bc9a-e15b8a71bfc9”,
“carrierServiceId”: “051581ba-9041-4f40-9528-5adab1ca008c”,
“name”: “Standard”,
“instanceDelay”: 14,
“logoName”: “locator1.png”,
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
},
“carrierService”: {
“carrierServiceId”: “051581ba-9041-4f40-9528-5adab1ca008c”,
“carrierId”: “c5b6a063-b8fa-471f-b575-758e20c6b1a1”,
“code”: “439”,
“label”: “Chronopost Shop2Shop FR”,
“deliveryDelay”: 0,
“deliverySaturday”: 0,
“packReturn”: 0,
“logoName”: “20240110-114031_Chronopost.png”,
“description”: “”,
“name”: “Chronopost”,
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
},
“pickupPointSchedules1”: {
“pickupPointScheduleId”: “72c75e51-3991-41c6-a469-4e2bc2c6c286”,
“pickUpPointId”: “07e35bea-67c8-49a3-b61f-be5d15d054c2”,
“mondayOpenHourAM”: “”,
“mondayCloseHourAM”: “”,
“mondayOpenHourPM”: “”,
“mondayCloseHourPM”: “”,
“tuesdayOpenHourAM”: “09:00”,
“tuesdayCloseHourAM”: “12:00”,
“tuesdayOpenHourPM”: “14:00”,
“tuesdayCloseHourPM”: “19:00”,
“wednesdayOpenHourAM”: “09:00”,
“wednesdayCloseHourAM”: “12:00”,
“wednesdayOpenHourPM”: “14:00”,
“wednesdayCloseHourPM”: “19:00”,
“thursdayOpenHourAM”: “09:00”,
“thursdayCloseHourAM”: “12:00”,
“thursdayOpenHourPM”: “14:00”,
“thursdayCloseHourPM”: “19:00”,
“fridayOpenHourAM”: “09:00”,
“fridayCloseHourAM”: “12:00”,
“fridayOpenHourPM”: “14:00”,
“fridayCloseHourPM”: “19:00”,
“saturdayOpenHourAM”: “09:00”,
“saturdayCloseHourAM”: “12:00”,
“saturdayOpenHourPM”: “14:00”,
“saturdayCloseHourPM”: “19:00”,
“sundayOpenHourAM”: “09:00”,
“sundayCloseHourAM”: “12:00”,
“sundayOpenHourPM”: “14:00”,
“sundayCloseHourPM”: “19:00”,
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
},
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
}
],
[
{
“pickUpPointId”: “d526b4b5-0c94-4188-817e-36992c49892e”,
“pickupPointTypeId”: “738c9037-b0eb-4a7b-bc9a-e15b8a71bfc9”,
“carrierServiceId”: “051581ba-9041-4f40-9528-5adab1ca008c”,
“name”: “AUTO PRIMO”,
“address1”: “392 RUE DE L EPINETTE”,
“address2”: “”,
“city”: “NIEPPE”,
“postalCode”: “59850”,
“positionX”: “50.6868420”,
“positionY”: “2.83826900”,
“code”: “4469V”,
“active”: 1,
“locationImage”: null,
“locationMarker”: “api.crossdeskmap.com/wwwroot/LocationIcons/marker_20240110-114031_Chronopost.png”,
“homeMarker”: “api.crossdeskmap.com/wwwroot/LocationIcons/marker_Home.png”,
“distance”: “1.8 km”,
“pickupPointSchedules”: {
“Sunday”: [
“”,
“”
],
“Monday”: [
“08:00 – 12:00”,
“14:00 – 18:00”
],
“Tuesday”: [
“08:00 – 12:00”,
“14:00 – 18:00”
],
“Wednesday”: [
“08:00 – 12:00”,
“14:00 – 18:00”
],
“Thursday”: [
“08:00 – 12:00”,
“14:00 – 18:00”
],
“Friday”: [
“08:00 – 12:00”,
“14:00 – 18:00”
],
“Saturday”: [
“”,
“”
]},
“pickupPointType”: {
“pickupPointTypeId”: “738c9037-b0eb-4a7b-bc9a-e15b8a71bfc9”,
“carrierServiceId”: “051581ba-9041-4f40-9528-5adab1ca008c”,
“name”: “Standard”,
“instanceDelay”: 14,
“logoName”: “locator1.png”,
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
},
“carrierService”: {
“carrierServiceId”: “051581ba-9041-4f40-9528-5adab1ca008c”,
“carrierId”: “c5b6a063-b8fa-471f-b575-758e20c6b1a1”,
“code”: “439”,
“label”: “Chronopost Shop2Shop FR”,
“deliveryDelay”: 0,
“deliverySaturday”: 0,
“packReturn”: 0,
“logoName”: “20240110-114031_Chronopost.png”,
“description”: “”,
“name”: “Chronopost”,
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
},
“pickupPointSchedules1”: {
“pickupPointScheduleId”: “d2aa5158-1e64-4ea6-b42d-60e717ba3e9f”,
“pickUpPointId”: “d526b4b5-0c94-4188-817e-36992c49892e”,
“mondayOpenHourAM”: “08:00”,
“mondayCloseHourAM”: “12:00”,
“mondayOpenHourPM”: “14:00”,
“mondayCloseHourPM”: “18:00”,
“tuesdayOpenHourAM”: “08:00”,
“tuesdayCloseHourAM”: “12:00”,
“tuesdayOpenHourPM”: “14:00”,
“tuesdayCloseHourPM”: “18:00”,
“wednesdayOpenHourAM”: “08:00”,
“wednesdayCloseHourAM”: “12:00”,
“wednesdayOpenHourPM”: “14:00”,
“wednesdayCloseHourPM”: “18:00”,
“thursdayOpenHourAM”: “08:00”,
“thursdayCloseHourAM”: “12:00”,
“thursdayOpenHourPM”: “14:00”,
“thursdayCloseHourPM”: “18:00”,
“fridayOpenHourAM”: “08:00”,
“fridayCloseHourAM”: “12:00”,
“fridayOpenHourPM”: “14:00”,
“fridayCloseHourPM”: “18:00”,
“saturdayOpenHourAM”: “”,
“saturdayCloseHourAM”: “”,
“saturdayOpenHourPM”: “”,
“saturdayCloseHourPM”: “”,
“sundayOpenHourAM”: “”,
“sundayCloseHourAM”: “”,
“sundayOpenHourPM”: “”,
“sundayCloseHourPM”: “”,
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
},
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
}
],
[
{
“pickUpPointId”: “ed614c54-998e-43e0-ab3b-939a0e4102b0”,
“pickupPointTypeId”: “738c9037-b0eb-4a7b-bc9a-e15b8a71bfc9”,
“carrierServiceId”: “051581ba-9041-4f40-9528-5adab1ca008c”,
“name”: “HYPER U”,
“address1”: “199 RUELLE DU BAILLY”,
“address2”: “”,
“city”: “NIEPPE”,
“postalCode”: “59850”,
“positionX”: “50.6864663”,
“positionY”: “2.84160860”,
“code”: “2225S”,
“active”: 1,
“locationImage”: null,
“locationMarker”: “api.crossdeskmap.com/wwwroot/LocationIcons/marker_20240110-114031_Chronopost.png”,
“homeMarker”: “api.crossdeskmap.com/wwwroot/LocationIcons/marker_Home.png”,
“distance”: “1.8 km”,
“pickupPointSchedules”: {
“Sunday”: [
“09:00 – 12:30”,
“”
],
“Monday”: [
“08:30 – 12:00”,
“12:00 – 20:00”
],
“Tuesday”: [
“08:30 – 12:00”,
“12:00 – 20:00”
],
“Wednesday”: [
“08:30 – 12:00”,
“12:00 – 20:00”
],
“Thursday”: [
“08:30 – 12:00”,
“12:00 – 20:00”
],
“Friday”: [
“08:30 – 12:00”,
“12:00 – 20:00”
],
“Saturday”: [
“08:30 – 12:00”,
“12:00 – 20:00”
]},
“pickupPointType”: {
“pickupPointTypeId”: “738c9037-b0eb-4a7b-bc9a-e15b8a71bfc9”,
“carrierServiceId”: “051581ba-9041-4f40-9528-5adab1ca008c”,
“name”: “Standard”,
“instanceDelay”: 14,
“logoName”: “locator1.png”,
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
},
“carrierService”: {
“carrierServiceId”: “051581ba-9041-4f40-9528-5adab1ca008c”,
“carrierId”: “c5b6a063-b8fa-471f-b575-758e20c6b1a1”,
“code”: “439”,
“label”: “Chronopost Shop2Shop FR”,
“deliveryDelay”: 0,
“deliverySaturday”: 0,
“packReturn”: 0,
“logoName”: “20240110-114031_Chronopost.png”,
“description”: “”,
“name”: “Chronopost”,
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
},
“pickupPointSchedules1”: {
“pickupPointScheduleId”: “a25b3777-5887-4f06-bc32-35d97939e6a4”,
“pickUpPointId”: “ed614c54-998e-43e0-ab3b-939a0e4102b0”,
“mondayOpenHourAM”: “08:30”,
“mondayCloseHourAM”: “12:00”,
“mondayOpenHourPM”: “12:00”,
“mondayCloseHourPM”: “20:00”,
“tuesdayOpenHourAM”: “08:30”,
“tuesdayCloseHourAM”: “12:00”,
“tuesdayOpenHourPM”: “12:00”,
“tuesdayCloseHourPM”: “20:00”,
“wednesdayOpenHourAM”: “08:30”,
“wednesdayCloseHourAM”: “12:00”,
“wednesdayOpenHourPM”: “12:00”,
“wednesdayCloseHourPM”: “20:00”,
“thursdayOpenHourAM”: “08:30”,
“thursdayCloseHourAM”: “12:00”,
“thursdayOpenHourPM”: “12:00”,
“thursdayCloseHourPM”: “20:00”,
“fridayOpenHourAM”: “08:30”,
“fridayCloseHourAM”: “12:00”,
“fridayOpenHourPM”: “12:00”,
“fridayCloseHourPM”: “20:00”,
“saturdayOpenHourAM”: “08:30”,
“saturdayCloseHourAM”: “12:00”,
“saturdayOpenHourPM”: “12:00”,
“saturdayCloseHourPM”: “20:00”,
“sundayOpenHourAM”: “09:00”,
“sundayCloseHourAM”: “12:30”,
“sundayOpenHourPM”: “”,
“sundayCloseHourPM”: “”,
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
},
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
}
],
[
{
“pickUpPointId”: “9fc06072-9bca-445b-a923-9b8061d9a7d7”,
“pickupPointTypeId”: “738c9037-b0eb-4a7b-bc9a-e15b8a71bfc9”,
“carrierServiceId”: “051581ba-9041-4f40-9528-5adab1ca008c”,
“name”: “E.LECLERC DRIVE NIEPPE”,
“address1”: “ZI LES TROIS TILLEULS”,
“address2”: “”,
“city”: “NIEPPE”,
“postalCode”: “59850”,
“positionX”: “50.6849700”,
“positionY”: “2.84396000”,
“code”: “3896U”,
“active”: 1,
“locationImage”: null,
“locationMarker”: “api.crossdeskmap.com/wwwroot/LocationIcons/marker_20240110-114031_Chronopost.png”,
“homeMarker”: “api.crossdeskmap.com/wwwroot/LocationIcons/marker_Home.png”,
“distance”: “2.0 km”,
“pickupPointSchedules”: {
“Sunday”: [
“”,
“”
],
“Monday”: [
“07:30 – 20:00”,
“”
],
“Tuesday”: [
“07:30 – 20:00”,
“”
],
“Wednesday”: [
“07:30 – 20:00”,
“”
],
“Thursday”: [
“07:30 – 20:00”,
“”
],
“Friday”: [
“07:30 – 20:00”,
“”
],
“Saturday”: [
“07:30 – 20:00”,
“”
]},
“pickupPointType”: {
“pickupPointTypeId”: “738c9037-b0eb-4a7b-bc9a-e15b8a71bfc9”,
“carrierServiceId”: “051581ba-9041-4f40-9528-5adab1ca008c”,
“name”: “Standard”,
“instanceDelay”: 14,
“logoName”: “locator1.png”,
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
},
“carrierService”: {
“carrierServiceId”: “051581ba-9041-4f40-9528-5adab1ca008c”,
“carrierId”: “c5b6a063-b8fa-471f-b575-758e20c6b1a1”,
“code”: “439”,
“label”: “Chronopost Shop2Shop FR”,
“deliveryDelay”: 0,
“deliverySaturday”: 0,
“packReturn”: 0,
“logoName”: “20240110-114031_Chronopost.png”,
“description”: “”,
“name”: “Chronopost”,
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
},
“pickupPointSchedules1”: {
“pickupPointScheduleId”: “6949ee50-3f94-4565-88f8-aa2e6f54f87a”,
“pickUpPointId”: “9fc06072-9bca-445b-a923-9b8061d9a7d7”,
“mondayOpenHourAM”: “07:30”,
“mondayCloseHourAM”: “20:00”,
“mondayOpenHourPM”: “”,
“mondayCloseHourPM”: “”,
“tuesdayOpenHourAM”: “07:30”,
“tuesdayCloseHourAM”: “20:00”,
“tuesdayOpenHourPM”: “”,
“tuesdayCloseHourPM”: “”,
“wednesdayOpenHourAM”: “07:30”,
“wednesdayCloseHourAM”: “20:00”,
“wednesdayOpenHourPM”: “”,
“wednesdayCloseHourPM”: “”,
“thursdayOpenHourAM”: “07:30”,
“thursdayCloseHourAM”: “20:00”,
“thursdayOpenHourPM”: “”,
“thursdayCloseHourPM”: “”,
“fridayOpenHourAM”: “07:30”,
“fridayCloseHourAM”: “20:00”,
“fridayOpenHourPM”: “”,
“fridayCloseHourPM”: “”,
“saturdayOpenHourAM”: “07:30”,
“saturdayCloseHourAM”: “20:00”,
“saturdayOpenHourPM”: “”,
“saturdayCloseHourPM”: “”,
“sundayOpenHourAM”: “”,
“sundayCloseHourAM”: “”,
“sundayOpenHourPM”: “”,
“sundayCloseHourPM”: “”,
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
},
“trackingState”: 0,
“modifiedProperties”: null,
“entityIdentifier”: “00000000-0000-0000-0000-000000000000”
}
]],
“latitude”: 50.70272505,
“longitude”: 2.84280216
}