Set Customer Opt-in

POST

/api

Last modified:2025-02-07 15:15:57

This web service update the customer opt-it data for the passed fidelity card barcode.

To update the customer, it's necessary to make a POST call, passing a JSON body as specified below.

The web service response will be composed of:

success: Boolean that indicated wether the request was successful or not

message: An error message

Possible errors are:

missing_parameter

customer_not_found

Actors

API Client: The system or user initiating the request.

4ws.trade: The backend system that processes the request.

# Examples

Update Opt-in

{
    "barcode": "9999003622498",
    "optinWallet": "Y",
    "walletId": "captainwallet"
}

Fields

Customer data

Field	Description	Type	Mandatory
barcode	Main address	String	✓
optinWallet	Y/N if opt-in is enable	String	✓
walletId	The wallet id	String

Request

Query Params

Header Params

Body Params text/plain

Example

Example:{ "barcode": "9999003622498", "optinWallet": "Y", "walletId": "captainwallet" }

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api?cmd=setCustomerOptIn_v1&applicationId=MOBILE_SHOP&appId=MOBILE_SHOP' \
--header 'applicationId: {{APPLICATION_ID}}' \
--header 'appId: {{APPLICATION_ID}}' \
--header 'namespace: {{NAMESPACE}}' \
--header 'languageId: {{LANGUAGE}}' \
--header 'username: {{USERNAME}}' \
--header 'password: {{PASSWORD}}' \
--header 'companyId: {{COMPANY_ID}}' \
--header 'siteId: {{SITE_ID}}' \
--header 'loadRoles: Y' \
--header 'Content-Type: text/plain' \
--data-raw '{
    "barcode": "9999003622498",
    "optinWallet": "Y",
    "walletId": "captainwallet"
}'

Responses

🟢200Set Customer Opt-in - Success

application/json

Body

Example

{
    "success": true
}

🟢200Set Customer Opt-in - Fail

🟠422Unique constraint error

Modified at 2025-02-07 15:15:57

Get Customer

Get customer loyalty vouchers

Set Customer Opt-in

Actors#

Update Opt-in#

Fields#