curl --request POST \
--url https://int-prodtest.m1amdocs.io/v1/merchant_eligibility/check \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"merchantProductCode": "PARTNER-STANDALONE-MONTHLY",
"identifierType": "email",
"identifier": "customer@example.com",
"identifierEncoding": "PLAIN",
"metadata": {
"country": "US"
}
}
'{
"eligible": true
}Check merchant pre-purchase eligibility
Pre-purchase check whether a customer is eligible for a merchant product/offer before creating a partner subscription or entitlement. Stateless single-product pre-purchase eligibility check. partnerCode is not on the request; PartnerSubscriptionMS resolves it from merchantProductCode (or commerceProductCode → merchantProductCode via SLM). At least one of commerceProductCode or merchantProductCode is required (scalar only; arrays → 400). metadata is an object with string→string key/value pairs ($ref METADATA).
curl --request POST \
--url https://int-prodtest.m1amdocs.io/v1/merchant_eligibility/check \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"merchantProductCode": "PARTNER-STANDALONE-MONTHLY",
"identifierType": "email",
"identifier": "customer@example.com",
"identifierEncoding": "PLAIN",
"metadata": {
"country": "US"
}
}
'{
"eligible": true
}Authorizations
The authorization key obtained from MarketONE.
Headers
The TraceId indicates the overall ID of the trace. Every span in a trace shares this ID. The X-B3-TraceId header is encoded as 32 or 16 lower-hex characters. For example, a 128-bit TraceId header might look like 463ac35c9f6413ad48485a3953bb6124.
The SpanId is 64-bit in length and indicates the position of the current operation in the trace tree. The value should not be interpreted; it may or may not be derived from the value of the TraceId. The X-B3-SpanId header is encoded as 16 lower-hex characters. For example, a SpanId header might look like a2fb4a1d1a96d312. Unless propagating only the Sampling State, the X-B3-SpanId header is required.
The ParentSpanId is 64-bit in length and indicates the position of the parent operation in the trace tree. When the span is the root of the trace tree, there is no ParentSpanId. The X-B3-ParentSpanId header may be present on a child span and must be absent on the root span. It is encoded as 16 lower-hex characters. For example, a ParentSpanId header might look like 0020000000000001.
The aggregator organization code. Organization code must be provided either via HTTP header or query parameter. If both are provided, HTTP header will be used.
16Query Parameters
The aggregator organization code. Organization code must be provided either via HTTP header or query parameter. If both are provided, HTTP header will be used.
16Body
Reseller (CSP) request for a stateless single-product pre-purchase eligibility check. partnerCode is not part of this request; PartnerSubscriptionMS resolves it from merchantProductCode (or commerceProductCode → merchantProductCode via SLM). At least one of commerceProductCode or merchantProductCode must be supplied as a scalar string; arrays are not supported and result in 400 invalid-request.
Customer ID type for merchant eligibility. Accepted types are partnership-specific.
email, msisdn Customer identifier value for merchant eligibility. Format validated per identifierType.
256How the eligibility identifier is encoded. Accepted values are partnership-specific; unsupported values are rejected by the partner MS (400 invalid-request).
PLAIN, HASH, ENCRYPTED Commerce (reseller/service provider) product code. Used to resolve merchantProductCode via SLM when merchantProductCode is omitted. Scalar only.
128Merchant product code for the merchant offer. Scalar only.
36A set of key/value pairs that you can attach to an object. Useful for storing additional information.
Show child attributes
Show child attributes
Response
Eligibility decision (metadata is object string→string key/value pairs)
Reseller-facing eligibility decision.
true if the customer is eligible for the offer/merchantProductCode; false if not eligible.
M1-normalized eligibility reason (kebab-case), typically when eligible is false. Merchant-native code remains in metadata.code.
already-entitled, already-entitled-redirect-required, base-plan-missing, merchant-other A set of key/value pairs that you can attach to an object. Useful for storing additional information.
Show child attributes
Show child attributes
Was this page helpful?