API Release order
Emplacement : API
URL de consultation
Environnement de non production
Url de consultation : https://[ENVIRONNEMENT].gw.apis.ci5.io/p/release-order
Il faut remplacer [ENVIRONNEMENT] par l’environnement souhaité (en minuscule et avec le séparateur tiret pour mco-mgi et dev-mgi)
Exemple pour PREPROD : https://preprod.gw.apis.ci5.io/p/release-order
Environnement de production
https://gw.apis.ci5.io/p/release-order
Exemple de message envoyé :
json { "community": "NOU", (Obligatoire) (Obligatoire) "business": "FORW", (Obligatoire) "agentTraderCode": "MSC", code du SHAG de l’annonce (Obligatoire) "cargoRef": "SLEU1234567", (Obligatoire) "referenceBL": "AU00767600" (Facultatif) }
Le header x-api-key est obligatoire
Contrôle technique:
si une donnée obligatoire n’est pas renseignée → message erreur informant que des données obligatoires sont absentes
json { "httpMethod": "POST", "requestUri": "/release-order", "statusCode": 400, "statusCodeText": "Bad Request", "errorDateTime": "2024-09-26T07:23:41+00:00", "errors": [ { "reason": "00002", "message": "The business criteria is missing" } ] }
Contrôles fonctionnels:
1- Si le demandeur a une activité FORW
Rechercher des Release Order VAL taggués “merchant” pour lequel le demandeur de cette API est nommé comme:
- representative si pas de last representative
- last representative s’il existe
sinon → message retour:
json { "httpMethod": "POST", "requestUri": "/release-order", "statusCode": 404, "statusCodeText": "Not Found", "errorDateTime": "2024-09-26T07:18:16+00:00", "errors": [ { "reason": "10001", "message": "No result found" } ] }
Si les données de la requête permettent d’identifier plusieurs release order répondant aux droits du demandeur alors:
- remonter les données de celui dont le BL est associé au call avec la ETA la plus proche
2- Si le demandeur a une activité INCA
Rechercher des Release Order VAL pour lequel le demandeur de cette API est nommé comme:
- inland carrier
sinon → message retour: No result found
Si les données de la requête permettent d’identifier plusieurs release order répondant aux droits du demandeur alors:
- remonter les données de celui dont le BL est associé au call avec la ETA la plus proche
Dans les 2 cas :
Données à renvoyer:
- code du terminal location renseigné dans “empty return”
- code random
- inland carrier
{ "emptyReturnLocation": "2XLSY", "random": "454545", "inlandCarrierCode": "LEYRIS" }
Références
Source : https://mgi-team.atlassian.net/wiki/spaces/DOCI5/pages/3936124930