Customer Data

{
  "status": 200,
  "code": "customer_ewallet_automatic_reload_succeed",
  "message": "Configuration retrieved successfully.",
  "data": {
    "automaticEwalletReloadActive": true,
    "automaticEwalletReloadMinBalance": 500,
    "automaticEwalletReloadAmount": 2000,
    "automaticEwalletReloadCardId": 12345
  }
}

{
  "status": 200,
  "code": "balance_count_succeed",
  "message": "Balance count retrieved.",
  "data": {
    "total": 142
  }
}

multipart/form-data with a 'file' field containing the CSV or Excel file.

{
  "status": 200,
  "code": "customers_import_create_succeed",
  "message": "Import completed successfully.",
  "data": {
    "customersCreated": 15,
    "customersUpdated": 3,
    "customersUnchanged": 82
  }
}

file=[binary]

{
  "status": 200,
  "code": "customers_import_create_succeed",
  "message": "Customers have been imported successfully.",
  "data": {
    "customersCreated": 15,
    "customersUpdated": 3,
    "customersUnchanged": 82,
    "customersError": [
      {
        "line": 7,
        "email": "invalid@example.com",
        "invalidFields": [
          "email"
        ]
      }
    ],
    "customersWarn": [
      {
        "line": 8,
        "email": "duplicate@example.com",
        "invalidFields": [
          "email"
        ]
      }
    ],
    "otherWarnings": [
      {
        "type": "pricingRule",
        "list": [
          "UNKNOWN-RULE"
        ]
      }
    ],
    "validationErrors": []
  }
}

Binary attachment. Content-Type is text/csv for csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for xlsx; Content-Disposition contains the filename.

{
  "status": 200,
  "code": "customer_base_export_request_created",
  "message": "Customer base export request is created successfully."
}

{
  "status": 200,
  "code": "report_generations_succeed",
  "message": "The list of report generations have been found.",
  "data": [
    {
      "reportGenerationId": 812,
      "name": "customer-base-export-3325-2026-07-11.xlsx",
      "createdAt": "Fri Jul 11 2026 09:15:00 GMT+0000 (Coordinated Universal Time)",
      "reportType": "customer_base_export",
      "status": "succeed",
      "expired": false
    }
  ]
}

{
  "status": 200,
  "code": "report_generations_succeed",
  "message": "The list of report generations have been found.",
  "data": {
    "url": "https://storage.googleapis.com/<signed-report-url>"
  }
}

{
  "status": 200,
  "code": "customer_unarchive_succeed",
  "message": "Customer has been successfully unarchived.",
  "data": {
    "success": true
  }
}

Binary PDF file (Content-Type: application/pdf). The response is an attachment; read the filename from the Content-Disposition response header.

{
  "count": 142
}

Binary PDF file (Content-Type: application/pdf). Read the total matching ticket count from X-Total-Count and the filename from Content-Disposition.

{
  "data": "{\"preferredLanguage\":\"fr\",\"dietaryRestrictions\":[\"vegetarian\"]}",
  "namespace": "preferences"
}

{
  "status": 200,
  "code": "customer_metadata_saved",
  "message": "Metadata saved successfully.",
  "data": {
    "customerMetadataId": 1234,
    "customerId": 5337578,
    "brandId": 100,
    "data": "{\"preferredLanguage\":\"fr\",\"dietaryRestrictions\":[\"vegetarian\"]}",
    "namespace": "preferences"
  }
}

{
  "status": 200,
  "code": "customer_metadata_fetched",
  "message": "Metadata retrieved successfully.",
  "data": [
    {
      "customerMetadataId": 1234,
      "customerId": 5337578,
      "brandId": 100,
      "data": "{\"preferredLanguage\":\"fr\",\"dietaryRestrictions\":[\"vegetarian\"]}",
      "namespace": "preferences"
    },
    {
      "customerMetadataId": 1235,
      "customerId": 5337578,
      "brandId": 100,
      "data": "{\"externalId\":\"EXT-99887\"}",
      "namespace": "external_ids"
    }
  ]
}

{
  "status": 200,
  "code": "customer_metadata_deleted",
  "message": "Metadata deleted successfully.",
  "data": {}
}