production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/customers/segments/retrieve
post /v1/customers/segments/retrieve
retrieve-customer-segment
To retrieve the customer segment information for a customer.
This API will be used to retrieve customer segment and birthday flag indicator that will be used by channels to prioritize attention to customer according to the segment
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified durin application registration
ChannelId
Required in header
string
Channel where request originated
sid
Optional in header
string
Session is generated and returned on the first API call of the key exchange (GET e2e call) as response header, which needs to be resent on succesive calls of same session.
retrieveCustomerSegmentRequest
Optional in body
object
200
Successful operation.
400
| Type | Code | Details |
| error | invalidRequest | Missing or invalid Parameters |
401
| Type | Code | Details |
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| Type | Code | Details | More Info |
| error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
| Type | Code | Details | More Info |
| error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
| Type | Code | Details |
| error | businessValidationFailed | Business validation error occured on one or more parameters |
500
| Type | Code | Details |
| fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/customers/segments/retrieve
Definitions
{
"type": "object",
"properties": {
"customerId": {
"description": "Unique identifier of the customer",
"type": "string",
"example": "321116471234",
"maxLength": 12,
"pattern": "^[0-9]*$"
},
"cardNumber": {
"description": "Number Embossed/ Printed on the Card.",
"type": "string",
"example": "4969452123456110",
"maxLength": 16,
"pattern": "^[0-9]*$"
}
}
}
{
"type": "object",
"properties": {
"customer": {
"$ref": "#/definitions/Customer"
}
},
"required": [
"customer"
]
}
{
"type": "object",
"properties": {
"fullName": {
"description": "Full name of the customer",
"type": "string",
"example": "Luis Diaz Salinas"
},
"customerSegment": {
"description": "Segment where the Customer belongs",
"type": "string",
"example": "20"
},
"birthdayTodayFlag": {
"description": "Flag that indicates if it is customer's birthday today or not.",
"type": "boolean",
"example": true
}
},
"required": [
"fullName",
"customerSegment",
"birthdayTodayFlag"
]
}
{
"properties": {
"type": {
"type": "string",
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
]
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation or detailed description of the error",
"type": "string"
},
"uuid": {
"description": "128 bit UUID that you generate for every request",
"type": "string"
},
"timestamp": {
"description": "Timestamp of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}