Skip to content

SubscriberApi.md

Latest commit

 

History

History
102 lines (76 loc) · 4.61 KB

SubscriberApi.md

File metadata and controls

102 lines (76 loc) · 4.61 KB

.SubscriberApi

All URIs are relative to https://api.api2cart.local.com/v1.1

Method HTTP request Description
subscriberList GET /subscriber.list.json subscriber.list

subscriberList

ModelResponseSubscriberList subscriberList()

Get subscribers list

Example

import { createConfiguration, SubscriberApi } from '';
import type { SubscriberApiSubscriberListRequest } from '';

const configuration = createConfiguration();
const apiInstance = new SubscriberApi(configuration);

const request: SubscriberApiSubscriberListRequest = {
    // Retrieves subscribers specified by ids (optional)
  ids: "24,25",
    // This parameter sets the number from which you want to get entities (optional)
  start: 0,
    // This parameter sets the entity amount that has to be retrieved. Max allowed count=250 (optional)
  count: 20,
    // Used to retrieve entities via cursor-based pagination (it can\'t be used with any other filtering parameter) (optional)
  pageCursor: "",
    // Filter by subscription status (optional)
  subscribed: false,
    // Store Id (optional)
  storeId: "1",
    // Filter subscribers by email (optional)
  email: "mail@example.com",
    // Retrieve entities from their creation date (optional)
  createdFrom: "2010-07-29 13:45:52",
    // Retrieve entities to their creation date (optional)
  createdTo: "2100-08-29 13:45:52",
    // Retrieve entities from their modification date (optional)
  modifiedFrom: "2010-07-29 13:45:52",
    // Retrieve entities to their modification date (optional)
  modifiedTo: "2100-08-29 13:45:52",
    // Set this parameter in order to choose which entity fields you want to retrieve (optional)
  responseFields: "{return_code,return_message,pagination,result}",
    // Set this parameter in order to choose which entity fields you want to retrieve (optional)
  params: "id,model,price,images",
    // Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all (optional)
  exclude: "false",
};

const data = await apiInstance.subscriberList(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
ids [string] Retrieves subscribers specified by ids (optional) defaults to undefined
start [number] This parameter sets the number from which you want to get entities (optional) defaults to 0
count [number] This parameter sets the entity amount that has to be retrieved. Max allowed count=250 (optional) defaults to 10
pageCursor [string] Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) (optional) defaults to undefined
subscribed [boolean] Filter by subscription status (optional) defaults to undefined
storeId [string] Store Id (optional) defaults to undefined
email [string] Filter subscribers by email (optional) defaults to undefined
createdFrom [string] Retrieve entities from their creation date (optional) defaults to undefined
createdTo [string] Retrieve entities to their creation date (optional) defaults to undefined
modifiedFrom [string] Retrieve entities from their modification date (optional) defaults to undefined
modifiedTo [string] Retrieve entities to their modification date (optional) defaults to undefined
responseFields [string] Set this parameter in order to choose which entity fields you want to retrieve (optional) defaults to undefined
params [string] Set this parameter in order to choose which entity fields you want to retrieve (optional) defaults to 'force_all'
exclude [string] Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all (optional) defaults to undefined

Return type

ModelResponseSubscriberList

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -

[Back to top] [Back to API list] [Back to Model list] [Back to README]