Skip to main content

Search Customer LLD

Introduction:

Search Customer API provides one or more Customer summary result based on various filter criteria.

Search can happen on various filters like :

  1. Trading Name
  2. Address
  3. Customer Reference / Tax Reference
  4. BE Code

Refer Modern CMD Detailed Architecture and Step-wise cloud migration (Infrastructure & Application) for the flow.

API Contract:

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

https://github.com/Maersk-Global/API-JSON-Schema-Definitions/blob/master/apis/901-SMDS-CMD/v1-Bundled/CustomerSearch-API-bundled.v1.yaml

Mandatory Rules:

  1. Both Reference Type and Reference Value are mandatory while searching by Customer Reference
  2. Country is mandatory while searching without Customer Reference or Tax Number or BE Code
  3. At least one more field is required while searching by Country :

LegalName TradingName City HouseNumber StreetName RegionCode RegionName PoBox PostalCode

Was this page helpful?