This API is used to enrol or issue a promotion to a customer based on the promotion type. This API operates differently depending on the type of promotion being processed.

If the promotion type is,

Direct Issue - The API issues the promotion to the customer.
Enrol and Issue - The API enrols the customer to the promotion, but does not issue.

The API adjusts its behaviour based on the promotion type being handled.

API endpoint example

`https://eucrm.cc.capillarytech.com/v2/promotion/issue?identifierName=mobile&identifierValue=18767431754&source=INSTORE

Prerequisites

Authentication - Basic or OAuth authentication
Access group resource - Write access to customer group resource

Resource information


URI	/v2/promotion/issue
HTTP method	POST
Pagination supported?	NA
Rate limit	NA
Batch support	NA

Query Parameters

Parameter (Parameters marked with * are mandatory)	Data type	Description
identifierName*	Enum	Identifier type to identify the customer. Values allowed: email, mobile, externalId, id
identifierValue*	String	Value of the identifier.
source*	Enum	Specifies the source from where customer details are retrieved. Values allowed: FACEBOOK, WEB_ENGAGE, WECHAT, INSTORE, MARTJACK, TMALL, TAOBAO, JD, ECOMMERCE, WEBSITE, LINE, MOBILE_APP
type	Enum	Type of entity. Values allowed: CUSTOMER, USERGROUP2.
accountId	String	Unique account ID of the customer.

Body Parameters

Parameter (Parameters marked with * are mandatory)	Data type	Description
programId*	Long	Unique ID for the program associated with the promotion.
promotionId*	Long	Unique ID for the promotion into which enrol or issue occurs.

curl --location 'https://eucrm.cc.capillarytech.com/v2/promotion/issue?identifierName=mobile&identifierValue=18767431754&source=INSTORE' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic XZ5TZjM2M0Y2NmY2OWZmZmR==' \
--header 'Cookie: CS=17999bae3c0f41269ea0947f75896090' \
--data '{
    "programId": 469,
    "promotionId": 57099
}'

curl --location 'https://eucrm.cc.capillarytech.com/v2/promotion/issue?identifierName=externalId&identifierValue=000003873354&source=INSTORE' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic YTEyThMWNlYzdiNmY2g==' \
--header 'Cookie: CS=17999bae3c0f41269ea0947f75896090' \
--data '{
    "programId": 469,
    "promotionId": 57099
}'

curl --location 'https://eucrm.cc.capillarytech.com/v2/promotion/issue?identifierName=email&identifierValue=test%40capillarytech.com&source=INSTORE' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic yMzpjM2MMWNlYzdiNmY2==' \
--header 'Cookie: CS=17999bae3c0f41269ea0947f75896090' \
--data '{
    "programId": 469,
    "promotionId": 57099
}'

curl --location 'https://eucrm.cc.capillarytech.com/v2/promotion/issue?identifierName=id&identifierValue=555380204&source=INSTORE&type=CUSTOMER' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic TEyMzpkNGFiY2UxNTZjM2Yzg==' \
--header 'Cookie: CS=17999bae3c0f41269ea0947f75896090' \
--data '{
    "programId": 469,
    "promotionId": 57099
}'

Response parameters

Parameter Name	Data Type	Description
warnings	Object	A list of warnings, if any, in the response.
errors	Object	A list of errors, if any, in the response.
sideEffects	Object	Resultant object generated on running the API. This includes details related to the promotion and program on which promotion issued.
- programId	Long	Unique ID for the program associated with the promotion.
- issualId	Integer	Internal ID generated when promotion is issued.
- promotionId	Long	Unique ID for the promotion into which enrol or issue occurs.
- type	String	The value of the field is `Points promotion`. This parameter is not valid.

{
    "warnings": [],
    "errors": [],
    "sideEffects": [
        {
            "programId": 469,
            "issualId": 3,
            "promotionId": 57099,
            "type": "Points promotion"
        }
    ]
}

{
    "warnings": [],
    "errors": [],
    "sideEffects": [
        {
            "programId": 469,
            "issualId": 3,
            "promotionId": 57099,
            "type": "Points promotion"
        }
    ]
}

{
    "warnings": [],
    "errors": [],
    "sideEffects": [
        {
            "programId": 469,
            "issualId": 3,
            "promotionId": 57099,
            "type": "Points promotion"
        }
    ]
}

{
    "warnings": [],
    "errors": [],
    "sideEffects": [
        {
            "programId": 469,
            "issualId": 3,
            "promotionId": 57099,
            "type": "Points promotion"
        }
    ]
}

API-specific error codes

Error Code	Description
11013	Mandatory parameters identifierName, identifierValue, or source missing.
1212	Entity type invalid.
8874	Promotion ID is invalid.
1101	Program ID is invalid.