Instances
version 1.0.1
Description
API description
This API is built to Expose REST API for MCI.
Intended Use
This API has below functionality:
| No. | Resource | Method | Description |
|---|
| 1 | /health | GET | Get the system's health |
| 2 | /{brand}/customer-events | POST | Push Customer Events |
Technical details
Requirement Fulfillment
| API No | Action | Mule API Endpoint |
|---|
| 1 | Get the system's health | /health |
| 2 | Push Customer Events | /{brand}/customer-events |
Request Body Description:
| Resource | Method | Media Type |
|---|
| /{brand}/customer-events | POST | application/json |
Request Body Fields:
| Resource | Field Name | Type | Field Description |
|---|
| /{brand}/customer-events | channel | object | channel info |
| channel.channelId (required) | string | registration channel ID: Tmall =TM, JD =JD, Tmall mini program =TmallMNP |
| store | object | store info |
| store.storeCode (required) | string | storeCode |
| customer | object | customer info |
| customer.openId (required) | string | customer store dimension identification |
| customer.unionId | string | customer brand dimension cross-store identification |
| customer.loyaltyProgramCode | string | The user chooses to join the membership system code, if the same store belongs to the multi-member system, it must be transmitted |
| customer.name | string | customer nickname |
| customer. memberNo | string | customer no |
| customer. mixMobile | string | platform ciphertext mobile phone number |
| customer. mobile (required) | string | mobile no |
| customer. gender | string | Gender: 01= male, 02= female, 03= unknown |
| customer. province | string | province |
| customer. city | string | city |
| customer. birthDay | date | customer's birthday in the format YYYY-MM-DD |
| customer. email | string | email |
| customer. localName | string | name |
| customer. babyBirthday | string | baby birth month and day |
| customer. babyGender | string | Baby sex: 01= male, 02= female, 03= unknown |
| customer. ext | string | Extended information, JSON format, structure depending on specific requirements |
| eventType (required) | string(Enum) | Create/Update/Unbind |
| timestamp (required) | string | timestamp customer event happened |
Response Body Fields:
| Resource | Field Name | Type | Field Description |
|---|
| /{brand}/customer-events | statusCode | number | customer event status |
| statusType | string | status type |
| statusMessage | string | customer event message |
| statusDetails | string | customer event detail |
| eventType | string | event type |
| timestamp | string | customer event finished |
| correlationId | string | customer event correlationId |
Release Notes
| Version | Status | Release Date | End-of-Life Date |
|---|
| v1.0.0 | Released | 7-MAR-2024 | NA |
| v1.0.1 | Released | 8-MAR-2024 | NA |