Follow

Consumer Loyalty Cards

Creates full loyalty card instances for a consumer.

 

Attributes 

Attribute

Value

Path

/v3/ConsumerLoyaltyCards

Support Formats

JSON, XML

HTTP Method

POST

Secure

Yes

Rate Limited

No

HTTP Codes

·        201 - Created

·        400 - Bad Request. 

·        500 - Internal Server Error. 

 

Request

The following table contains the details of a typical HTTP Request for this service:

Type

Value

Header

POST /v3/consumerLoyaltyCards/1 HTTP/1.1

Host: merchant.api.vmob.co

Content-Type: application/json

Accept-Language: en-US

x-vmob-authorization: dm1vYi53aW5kb3dzLjE6

Body

{

 "loyaltyCardId": {LoyaltyCardId},

 "accessToken": {accessToken},

 "transactionId": {transactionId},

 "loyaltyCardCount": {loyaltyCardCount}

}

Notes:

  • Loyalty Card ID must be a valid, published and active loyalty card.
  • Access Token must be a valid access token of a consumer
  • Transaction ID must be a unique string. 
  • Loyalty Card Count must be an integer. Indicates the number of loyalty card instances to be created.

 

Successful Response

The following table contains the details of a typical successful HTTP Request for this service.

Type

Value

Header

HTTP/1.1 201 Created

Content-Type: application/json

Cache-Control: no-store

Pragma: no-cache

Body

{       

"instancesRequested" : 5,

"instancesCreated" : 5

}

Notes:

  • Instances Requested is the same value as LoyaltyCardCount
  • Instances Created is the actual number of loyalty card instances created. The total number of card instances a consumer can have is limited by the maximum instance count.
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.