v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Add/Update Customer Preferences

Preferences are custom fields created under the preferences category which helps in capturing specific interests of a customer. Example: favorite color, favorite brand. This API allows you to set or update preferences of a customer.

post/customer/preferences

Query parameters

format'json' | 'xml'

Request body

RAW_BODYstring json

Response

200

Example response

{
  "response": {
    "status": {
      "success": "true",
      "code": "200",
      "message": "SUCCESS"
    },
    "customers": {
      "customer": {
        "user_id": "sa234",
        "mobile": "44700900000",
        "email": "tom.sawyer@example.com",
        "external_id": "ts1234",
        "custom_fields": {
          "field": [
            {
              "name": "Favorite Brand",
              "value": "Puma"
            }
          ]
        },
        "store": {
          "id": "12762390",
          "code": "storecode",
          "name": "store Name",
          "status": "SUCCESS"
        },
        "item_status": {
          "success": "true",
          "code": "200",
          "message": "Preferences Updated Successfully"
        }
      }
    }
  }
}