Skip to content

Latest commit

 

History

History
83 lines (63 loc) · 4.86 KB

SubscriberAPI.md

File metadata and controls

83 lines (63 loc) · 4.86 KB

SubscriberAPI

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

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

subscriberList

    open class func subscriberList(start: Int? = nil, count: Int? = nil, pageCursor: String? = nil, subscribed: Bool? = nil, storeId: String? = nil, email: String? = nil, createdFrom: String? = nil, createdTo: String? = nil, modifiedFrom: String? = nil, modifiedTo: String? = nil, responseFields: String? = nil, params: String? = nil, exclude: String? = nil, completion: @escaping (_ data: ModelResponseSubscriberList?, _ error: Error?) -> Void)

subscriber.list

Get subscribers list

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let start = 987 // Int | This parameter sets the number from which you want to get entities (optional) (default to 0)
let count = 987 // Int | This parameter sets the entity amount that has to be retrieved. Max allowed count=250 (optional) (default to 10)
let pageCursor = "" // String | Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) (optional)
let subscribed = false // Bool | Filter by subscription status (optional)
let storeId = "storeId_example" // String | Store Id (optional)
let email = "email_example" // String | Filter subscribers by email (optional)
let createdFrom = "createdFrom_example" // String | Retrieve entities from their creation date (optional)
let createdTo = "createdTo_example" // String | Retrieve entities to their creation date (optional)
let modifiedFrom = "modifiedFrom_example" // String | Retrieve entities from their modification date (optional)
let modifiedTo = "modifiedTo_example" // String | Retrieve entities to their modification date (optional)
let responseFields = "responseFields_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional)
let params = "params_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional) (default to "force_all")
let exclude = "exclude_example" // String | Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all (optional)

// subscriber.list
SubscriberAPI.subscriberList(start: start, count: count, pageCursor: pageCursor, subscribed: subscribed, storeId: storeId, email: email, createdFrom: createdFrom, createdTo: createdTo, modifiedFrom: modifiedFrom, modifiedTo: modifiedTo, responseFields: responseFields, params: params, exclude: exclude) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
start Int This parameter sets the number from which you want to get entities [optional] [default to 0]
count Int This parameter sets the entity amount that has to be retrieved. Max allowed count=250 [optional] [default to 10]
pageCursor String Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter) [optional]
subscribed Bool Filter by subscription status [optional]
storeId String Store Id [optional]
email String Filter subscribers by email [optional]
createdFrom String Retrieve entities from their creation date [optional]
createdTo String Retrieve entities to their creation date [optional]
modifiedFrom String Retrieve entities from their modification date [optional]
modifiedTo String Retrieve entities to their modification date [optional]
responseFields String Set this parameter in order to choose which entity fields you want to retrieve [optional]
params String Set this parameter in order to choose which entity fields you want to retrieve [optional] [default 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]

Return type

ModelResponseSubscriberList

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

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

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