Skip to main content

Retrieve Customer LLD

Review Status: Reviewed

Reviewed By - Srinivasappa

Description:

Retrieve Customer API provides a detailed snapshot of a Customer record based on the below parameters. Any external application who has access to this service can use this, the CMD Portal can use or any other backend service can use it.

Retrieval can happen by using various fields like :

  1. Customer Code
  2. Alternate Code and Alternate Code Type (altCodeType) for example, SCV Code, BPMA Code etc.
  3. Alternate Code, Alternate Code Type (altCodeType) and Country Code (countryCode) if Alternate Code Type is BE Code

Refer High Level Design (HLD) for the flow.

API Contract(OAS):

Refer below document to understand the request/response structure (path for RetrieveCustomer is /customers/)

https://github.com/Maersk-Global/smds-cmd-search-customer-service/blob/feature/single-module-epic/src/main/resources/search-retrieve-customer-api.yml

Service/Sequence Diagram:

Validation Rules:

  1. Code is a mandatory parameter for Retrieve Customer.
  2. Code Type and Country are optional parameters.
  3. If Code Type is 'MODS', then Country Code should be provided (Retrieve by BE Code).
Was this page helpful?