CMD Modernization API Path
Ingest Customer
https://github.com/Maersk-Global/smds-cmd-ingest-customer-service
| APIGEE Proxy | API Path | URL | Method | Purpose | Description |
|---|---|---|---|---|---|
| customer-ingest | /global-mdm/customers | https://api-stage.maersk.com/global-mdm/customer-ingestion/customers | POST | Create customer record | |
| customer-ingest | /global-mdm/customers/{customerCode} | https://api-stage.maersk.com/global-mdm/customer-ingestion/customers/{customerCode} | PUT | Update customer record | |
| customer-ingest | /global-mdm/customers/{customerCode}/segments | https://api-stage.maersk.com/global-mdm/customer-ingestion/customers/{customerCode}/segment | PATCH | Relate - customer segments | |
| customer-ingest | /global-mdm/customer-types-queries | https://api-stage.maersk.com/global-mdm/customer-ingestion/customers-type-queries | POST | Identify customer type (Internal/External) | |
| customer-ingest | /global-mdm/customers/{customerCode}/relationships | https://api-stage.maersk.com/global-mdm/customer-ingestion/customers/{customerCode}/relationships | PATCH | Relate - customer relationship | |
| customer-ingest | /global-mdm/customers/validate-identifiers | https://api-stage.maersk.com/global-mdm/customer-ingestion/customers/validate-identifiers | POST | Validate customer identifier(TAX) | |
| customer-ingest | /global-mdm/customers/rule-sets/{rulesetId} | https://api-stage.maersk.com/global-mdm/customer-ingestion/customers | GET | Fetch country ruleset for a country | |
| customer-ingest | /global-mdm/customers/validate-customer | https://api-stage.maersk.com/global-mdm/customer-ingestion/validate-customer | POST | Validate customer payload before customer creation/updation | |
| customer-ingest | /global-mdm/customers/synchronize | https://api-stage.maersk.com/global-mdm/customer-ingestion/customers/synchronize | POST | Sync customer data from Write DB to Elastic DB |
Search Customer
| APIGEE Proxy | API Path | URL | Method | Description |
|---|---|---|---|---|
| customer-search | /global-mdm/customers/ | https://api-stage.maersk.com/global-mdm/customer-search/customers/{customerCode} | GET | Fetch customer record for given customer code |
| customer-search | /global-mdm/customers | https://api-stage.maersk.com/global-mdm/customer-search/customers | GET | Fetch customer list |
| customer-search | /global-mdm/customers/{customerCode}/becode | https://api-stage.maersk.com/global-mdm/customer-search/customers/{customerCode}/becode | GET | Fetch BE code for a given customer code |
| customer-search | /global-mdm/customers/duplicate | https://api-stage.maersk.com/global-mdm/customer-search/customers/duplicate | POST | Identify duplicate customers |
Ingest Contact
| APIGEE Proxy | API Path | URL | Method | Description |
|---|---|---|---|---|
| customer-contact-ingestion | /global-mdm/customers/{customerCode}/contacts | https://api-stage.maersk.com/global-mdm/contact-ingestion/customers/{customerCode}/contacts | POST | create contact |
| customer-contact-ingestion | /global-mdm/customers/{customerCode}/contacts/{contactCode} | https://api-stage.maersk.com/global-mdm/contact-ingestion/customers/{customerCode}/contacts/{contactCode} | PUT | Update contact |
| customer-contact-ingestion | /global-mdm/customers/{customerCode}/contacts/validate | https://api-stage.maersk.com/global-mdm/contact-ingestion/customers/{customerCode}/contacts/validate | POST | Validate contact. |
| customer-contact-ingestion | /global-mdm/customers/{customerCode}/contacts/{contactCode} | https://api-stage.maersk.com/global-mdm/contact-ingestion/customers/{customerCode}/contacts/{contactCode} | PATCH | Assign Customer Contact |
Search Contact
| APIGEE Proxy | API Path | URL | Method | Description |
|---|---|---|---|---|
| contact-search | /global-mdm/customers/{customerCode}/contacts/{contactCode} | https://api-stage.maersk.com/global-mdm/customer-contact-search/customers/{customerCode}/contacts/{contactCode} | GET | Fetch contact record for given contact code |
| contact-search | /global-mdm/contacts | https://api-stage.maersk.com/global-mdm/customer-contact-search/contacts | GET | Fetch contact list |
| contact-search | /global-mdm/contacts/duplicate | https://api-stage.maersk.com/global-mdm/customer-contact-search/contacts/duplicate | GET | Identify duplicate contact |
Search Concern
| APIGEE Proxy | API Path | URL | Method | Description |
|---|---|---|---|---|
| concern-search | /global-mdm/concerns | https://api-stage.maersk.com/global-mdm/concern-search/concerns | GET | search the concern status based on status code and few more properties |
| concern-search | /global-mdm/concerns/ | https://api-stage.maersk.com/global-mdm/concern-search/{concernCode} | GET | Retrieve specific concern details |
Ingest Concern
| APIGEE Proxy | API Path | URL | Method | Description |
|---|---|---|---|---|
| concern-search | /global-mdm/concerns | https://api-stage.maersk.com/global-mdm/concern-search/concerns | POST | Used to create new concern. |
| concern-search | /global-mdm/concerns/{concernCode} | https://api-stage.maersk.com/global-mdm/concern-search/{concernCode} | PUT | Used to update a particular concern detail. |
Ingest Facility
| APIGEE Proxy | API Path | URL | Method | Description |
|---|---|---|---|---|
| customer-facility-ingestion | /global-mdm/facilities | https://api-stage.maersk.com/global-mdm/customer-facility-ingestion/facilities | POST | Create facility |
| customer-facility-ingestion | /global-mdm/facilities/{facilityCode} | https://api-stage.maersk.com/global-mdm/customer-facility-ingestion/facilities/{facilityCode} | PUT | Update facility |
| customer-facility-ingestion | /global-mdm/facilities/validate | https://api-stage.maersk.com/global-mdm/customer-facility-ingestion/facilities/validate | POST | Validate facility payload |
| customer-facility-ingestion | /global-mdm/facilities | https://api-stage.maersk.com/global-mdm/customer-facility-ingestion/facilities | PATCH | Assign Facility relationship |
Search Facility
| APIGEE Proxy | API Path | Method | Description | |
|---|---|---|---|---|
| customer-facility-search | /global-mdm/facilities/ | https://api-stage.maersk.com/global-mdm/customer-facility-search/facilities/ | GET | Fetch facility record for given facility code |
| customer-facility-search | /global-mdm/facilities | https://api-stage.maersk.com/global-mdm/customer-facility-search/facilities | GET | Fetch facility list |
CBU
| APIGEE Proxy | API Path | URL | Method | Description |
|---|---|---|---|---|
| customer-cbu-ingestion | /global-mdm/collectionbusinessunits/ | https://api-stage.maersk.com/global-mdm/customer-cbu-ingestion/collection-business-units/ | GET | Search CBU details |
| customer-cbu-ingestion | /global-mdm/collectionbusinessunits/{collectionBusinessUnitCode} | https://api-stage.maersk.com/global-mdm/customer-cbu-ingestion/collection-business-units/{collectionBusinessUnitCode} | GET | endpoint to retrieve CBU details |
| customer-cbu-ingestion | /global-mdm/collectionbusinessunits | https://api-stage.maersk.com/global-mdm/customer-cbu-ingestion/collection-business-units | POST | Create CBU data |
| customer-cbu-ingestion | /global-mdm/collectionbusinessunits/{collectionBusinessUnitCode} | https://api-stage.maersk.com/global-mdm/customer-cbu-ingestion/collection-business-units/{collectionBusinessUnitCode} | PUT | update CBU data |
Reference Data
| APIGEE Proxy | API Path | URL | Method | Description | Note |
|---|---|---|---|---|---|
| customer-reference | /customers/reference-data/brands | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/brands | GET | Retrieve brands | |
| customer-reference | /customers/reference-data/communicationPrefTypes | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/communicationPrefTypes | GET | Retrieve communication Pref Types | /customers/reference-data/communication-preferences |
| customer-reference | /customers/reference-data/customerGroups | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/customerGroups | GET | Retrieve customer groups | /customers/reference-data/customer-groups |
| customer-reference | /customers/reference-data/customerStatusReasons | https://api-stage.maersk.com/global-mdm/customerreference/customers/reference-data/customerStatusReasons | GET | Retrieve customer status reasons | /customers/reference-data/status-reasons |
| customer-reference | /customers/reference-data/isoLanguages | https://api-stage.maersk.com/global-mdm/customerreference/customers/reference-data/isoLanguages | GET | Retrieve isolanguages | /customers/reference-data/languages |
| customer-reference | /customers/reference-data/statusReasons | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/statusReasons | GET | Retrieve status reasons (Low ) | /customers/reference-data/status-reasons . should have query param filter. example A/I |
| customer-reference | /customers/reference-data/contactTypes | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/conatactTypes | GET | Retrieve contact types | /customers/reference-data/contact-types |
| customer-reference | /customers/reference-data/customerStatus | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/customerStatus | GET | Retrieve customer status | /customers/reference-data/statuses Example A, I, S |
| customer-reference | /customers/reference-data/customerTypes | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/customerTypes | GET | Retrieve customer types | /customers/reference-data/customer-types |
| customer-reference | /customers/reference-data/documentTypes | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/documentTypes | GET | Retrieve document types | /customers/reference-data/document-types |
| customer-reference | /customers/reference-data/internationalContactSalutations | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/documentTypes | GET | Retrieve international contact salutations | /customers/reference-data/salutations query param should contain primary/international filter. Default is primary. should have country code filter |
| customer-reference | /customers/reference-data/internationalDialingPrefixes | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/internationalDialingPrefixes | GET | Retrieve international dailing prefixes | /customers/reference-data/dialing-codes should have country code filter |
| customer-reference | /customers/reference-data/invoiceIsoLanguages | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/invoiceIsoLanguages | GET | Retrieve invoice isolanguages | /customers/reference-data/invoice-anguages Should return all and specific to country provided as query param |
| customer-reference | /customers/reference-data/primaryContactSalutations | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/primaryContactSalutation | GET | Retrieve primary contact salutations | refer salutations api |
| customer-reference | /customers/reference-data/referenceNumberCodes | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/referenceNumberCodes | GET | Retrieve reference number codes | /customers/reference-data/reference-codes . should have country code filter |
| customer-reference | /customers/reference-data/regionReferences | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/regionReferences | GET | Retrieve region references | /customers/reference-data/regions |
| customer-reference | /customers/reference-data/relationshipTypes | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/relationshipTypes | GET | Retrieve relationship types | /customers/reference-data/relationship-types |
| customer-reference | /customers/reference-data/segmentationTypes | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/segmentationTypes | GET | Retrieve segmentation types | /customers/reference-data/segment-types |
| customer-reference | /customers/reference-data/segmentationValues | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/segmentationValues | GET | Retrieve segmentation values | /customers/reference-data/segments |
| customer-reference | /customers/reference-data/taxNumberCodes | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/taxNumbersCodes | GET | Retrieve tax number codes | customers/reference-data/tax-types should be able to return tax type for all the countries along with local and standard values and have country code fileter |
| customer-reference | /customers/reference-data/taxTypeLocalNames | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-taxTypeLocalNames | GET | Retrieve tax type local names | |
| customer-reference | /customers/reference-data/taxTypeLocalNumbers | https://api-stage.maersk.com/global-mdm/customer-reference/customers/reference-data/taxTypeLocalNumbers | GET | Retrieve tax type local numbers |
Was this page helpful?