CartAPI

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

Method	HTTP request	Description
cartBridge	GET /cart.bridge.json	cart.bridge
cartCatalogPriceRulesCount	GET /cart.catalog_price_rules.count.json	cart.catalog_price_rules.count
cartCatalogPriceRulesList	GET /cart.catalog_price_rules.list.json	cart.catalog_price_rules.list
cartClearCache	POST /cart.clear_cache.json	cart.clear_cache
cartConfig	GET /cart.config.json	cart.config
cartConfigUpdate	PUT /cart.config.update.json	cart.config.update
cartCouponAdd	POST /cart.coupon.add.json	cart.coupon.add
cartCouponConditionAdd	POST /cart.coupon.condition.add.json	cart.coupon.condition.add
cartCouponCount	GET /cart.coupon.count.json	cart.coupon.count
cartCouponDelete	DELETE /cart.coupon.delete.json	cart.coupon.delete
cartCouponList	GET /cart.coupon.list.json	cart.coupon.list
cartCreate	POST /cart.create.json	cart.create
cartDelete	DELETE /cart.delete.json	cart.delete
cartDisconnect	GET /cart.disconnect.json	cart.disconnect
cartGiftcardAdd	POST /cart.giftcard.add.json	cart.giftcard.add
cartGiftcardCount	GET /cart.giftcard.count.json	cart.giftcard.count
cartGiftcardDelete	DELETE /cart.giftcard.delete.json	cart.giftcard.delete
cartGiftcardList	GET /cart.giftcard.list.json	cart.giftcard.list
cartInfo	GET /cart.info.json	cart.info
cartList	GET /cart.list.json	cart.list
cartMetaDataList	GET /cart.meta_data.list.json	cart.meta_data.list
cartMetaDataSet	POST /cart.meta_data.set.json	cart.meta_data.set
cartMetaDataUnset	DELETE /cart.meta_data.unset.json	cart.meta_data.unset
cartMethods	GET /cart.methods.json	cart.methods
cartPluginList	GET /cart.plugin.list.json	cart.plugin.list
cartScriptAdd	POST /cart.script.add.json	cart.script.add
cartScriptDelete	DELETE /cart.script.delete.json	cart.script.delete
cartScriptList	GET /cart.script.list.json	cart.script.list
cartShippingZonesList	GET /cart.shipping_zones.list.json	cart.shipping_zones.list
cartValidate	GET /cart.validate.json	cart.validate

cartBridge

    open class func cartBridge(completion: @escaping (_ data: CartBridge200Response?, _ error: Error?) -> Void)

cart.bridge

Get bridge key and store key

Example

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


// cart.bridge
CartAPI.cartBridge() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

CartBridge200Response

Authorization

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]

cartCatalogPriceRulesCount

    open class func cartCatalogPriceRulesCount(completion: @escaping (_ data: CartCatalogPriceRulesCount200Response?, _ error: Error?) -> Void)

cart.catalog_price_rules.count

Get count of cart catalog price rules discounts.

Example

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


// cart.catalog_price_rules.count
CartAPI.cartCatalogPriceRulesCount() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

CartCatalogPriceRulesCount200Response

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]

cartCatalogPriceRulesList

    open class func cartCatalogPriceRulesList(start: Int? = nil, count: Int? = nil, pageCursor: String? = nil, ids: String? = nil, responseFields: String? = nil, params: String? = nil, exclude: String? = nil, completion: @escaping (_ data: ModelResponseCartCatalogPriceRulesList?, _ error: Error?) -> Void)

cart.catalog_price_rules.list

Get cart catalog price rules discounts.

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 ids = "ids_example" // String | Retrieves  catalog_price_rules by ids (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 "id,name,description")
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)

// cart.catalog_price_rules.list
CartAPI.cartCatalogPriceRulesList(start: start, count: count, pageCursor: pageCursor, ids: ids, 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]
ids	String	Retrieves catalog_price_rules by ids	[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 "id,name,description"]
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

ModelResponseCartCatalogPriceRulesList

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]

cartClearCache

    open class func cartClearCache(cacheType: String, completion: @escaping (_ data: CartClearCache200Response?, _ error: Error?) -> Void)

cart.clear_cache

Clear cache on store.

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 cacheType = "cacheType_example" // String | Defines which cache should be cleared.

// cart.clear_cache
CartAPI.cartClearCache(cacheType: cacheType) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
cacheType	String	Defines which cache should be cleared.

Return type

CartClearCache200Response

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]

cartConfig

    open class func cartConfig(params: String? = nil, exclude: String? = nil, completion: @escaping (_ data: CartConfig200Response?, _ error: Error?) -> Void)

cart.config

Get list of cart configs

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 params = "params_example" // String | Set this parameter in order to choose which entity fields you want to retrieve (optional) (default to "store_name,store_url,db_prefix")
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)

// cart.config
CartAPI.cartConfig(params: params, exclude: exclude) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
params	String	Set this parameter in order to choose which entity fields you want to retrieve	[optional] [default to "store_name,store_url,db_prefix"]
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

CartConfig200Response

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]

cartConfigUpdate

    open class func cartConfigUpdate(cartConfigUpdate: CartConfigUpdate, completion: @escaping (_ data: CartConfigUpdate200Response?, _ error: Error?) -> Void)

cart.config.update

Use this API method to update custom data in client database.

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 cartConfigUpdate = CartConfigUpdate(dbTablesPrefix: "dbTablesPrefix_example", customFields: 123, storeId: "storeId_example", userAgent: "userAgent_example") // CartConfigUpdate | 

// cart.config.update
CartAPI.cartConfigUpdate(cartConfigUpdate: cartConfigUpdate) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
cartConfigUpdate	CartConfigUpdate

Return type

CartConfigUpdate200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

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

cartCouponAdd

    open class func cartCouponAdd(cartCouponAdd: CartCouponAdd, completion: @escaping (_ data: CartCouponAdd200Response?, _ error: Error?) -> Void)

cart.coupon.add

Use this method to create a coupon with specified conditions.

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 cartCouponAdd = CartCouponAdd(code: "code_example", actionType: "actionType_example", actionApplyTo: "actionApplyTo_example", actionScope: "actionScope_example", actionAmount: 123, codes: ["codes_example"], name: "name_example", dateStart: "dateStart_example", dateEnd: "dateEnd_example", usageLimit: 123, usageLimitPerCustomer: 123, actionConditionEntity: "actionConditionEntity_example", actionConditionKey: "actionConditionKey_example", actionConditionOperator: "actionConditionOperator_example", actionConditionValue: "actionConditionValue_example", includeTax: true, storeId: "storeId_example") // CartCouponAdd | 

// cart.coupon.add
CartAPI.cartCouponAdd(cartCouponAdd: cartCouponAdd) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
cartCouponAdd	CartCouponAdd

Return type

CartCouponAdd200Response

Authorization

StoreKeyAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

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

cartCouponConditionAdd

    open class func cartCouponConditionAdd(couponId: String, entity: Entity_cartCouponConditionAdd, key: Key_cartCouponConditionAdd, _operator: String, value: String, target: String? = nil, includeTax: Bool? = nil, includeShipping: Bool? = nil, storeId: String? = nil, completion: @escaping (_ data: BasketLiveShippingServiceDelete200Response?, _ error: Error?) -> Void)

cart.coupon.condition.add

Use this method to add additional conditions for coupon application.

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 couponId = "couponId_example" // String | Coupon Id
let entity = "entity_example" // String | Defines condition entity type
let key = "key_example" // String | Defines condition entity attribute key
let _operator = "_operator_example" // String | Defines condition operator
let value = "value_example" // String | Defines condition value, can be comma separated according to the operator.
let target = "target_example" // String | Defines condition operator (optional) (default to "coupon_prerequisite")
let includeTax = true // Bool | Indicates whether to apply a discount for taxes. (optional) (default to false)
let includeShipping = true // Bool | Indicates whether to apply a discount for shipping. (optional) (default to false)
let storeId = "storeId_example" // String | Store Id (optional)

// cart.coupon.condition.add
CartAPI.cartCouponConditionAdd(couponId: couponId, entity: entity, key: key, _operator: _operator, value: value, target: target, includeTax: includeTax, includeShipping: includeShipping, storeId: storeId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
couponId	String	Coupon Id
entity	String	Defines condition entity type
key	String	Defines condition entity attribute key
_operator	String	Defines condition operator
value	String	Defines condition value, can be comma separated according to the operator.
target	String	Defines condition operator	[optional] [default to "coupon_prerequisite"]
includeTax	Bool	Indicates whether to apply a discount for taxes.	[optional] [default to false]
includeShipping	Bool	Indicates whether to apply a discount for shipping.	[optional] [default to false]
storeId	String	Store Id	[optional]

Return type

BasketLiveShippingServiceDelete200Response

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]

cartCouponCount

    open class func cartCouponCount(storeId: String? = nil, avail: Bool? = nil, dateStartFrom: String? = nil, dateStartTo: String? = nil, dateEndFrom: String? = nil, dateEndTo: String? = nil, completion: @escaping (_ data: CartCouponCount200Response?, _ error: Error?) -> Void)

cart.coupon.count

This method allows you to get the number of coupons. On some platforms, you can filter the coupons by the date they were active.

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 storeId = "storeId_example" // String | Store Id (optional)
let avail = false // Bool | Defines category's visibility status (optional) (default to true)
let dateStartFrom = "dateStartFrom_example" // String | Filter entity by date_start (greater or equal) (optional)
let dateStartTo = "dateStartTo_example" // String | Filter entity by date_start (less or equal) (optional)
let dateEndFrom = "dateEndFrom_example" // String | Filter entity by date_end (greater or equal) (optional)
let dateEndTo = "dateEndTo_example" // String | Filter entity by date_end (less or equal) (optional)

// cart.coupon.count
CartAPI.cartCouponCount(storeId: storeId, avail: avail, dateStartFrom: dateStartFrom, dateStartTo: dateStartTo, dateEndFrom: dateEndFrom, dateEndTo: dateEndTo) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
storeId	String	Store Id	[optional]
avail	Bool	Defines category's visibility status	[optional] [default to true]
dateStartFrom	String	Filter entity by date_start (greater or equal)	[optional]
dateStartTo	String	Filter entity by date_start (less or equal)	[optional]
dateEndFrom	String	Filter entity by date_end (greater or equal)	[optional]
dateEndTo	String	Filter entity by date_end (less or equal)	[optional]

Return type

CartCouponCount200Response

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]

cartCouponDelete

    open class func cartCouponDelete(id: String, storeId: String? = nil, completion: @escaping (_ data: AttributeDelete200Response?, _ error: Error?) -> Void)

cart.coupon.delete

Delete coupon

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 id = "id_example" // String | Entity id
let storeId = "storeId_example" // String | Store Id (optional)

// cart.coupon.delete
CartAPI.cartCouponDelete(id: id, storeId: storeId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	Entity id
storeId	String	Store Id	[optional]

Return type

AttributeDelete200Response

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]

cartCouponList

    open class func cartCouponList(start: Int? = nil, count: Int? = nil, pageCursor: String? = nil, couponsIds: String? = nil, storeId: String? = nil, langId: String? = nil, avail: Bool? = nil, dateStartFrom: String? = nil, dateStartTo: String? = nil, dateEndFrom: String? = nil, dateEndTo: String? = nil, responseFields: String? = nil, params: String? = nil, exclude: String? = nil, completion: @escaping (_ data: ModelResponseCartCouponList?, _ error: Error?) -> Void)

cart.coupon.list

Get cart coupon discounts.

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 couponsIds = "couponsIds_example" // String | Filter coupons by ids (optional)
let storeId = "storeId_example" // String | Filter coupons by store id (optional)
let langId = "langId_example" // String | Language id (optional)
let avail = false // Bool | Filter coupons by avail status (optional)
let dateStartFrom = "dateStartFrom_example" // String | Filter entity by date_start (greater or equal) (optional)
let dateStartTo = "dateStartTo_example" // String | Filter entity by date_start (less or equal) (optional)
let dateEndFrom = "dateEndFrom_example" // String | Filter entity by date_end (greater or equal) (optional)
let dateEndTo = "dateEndTo_example" // String | Filter entity by date_end (less or equal) (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 "id,code,name,description")
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)

// cart.coupon.list
CartAPI.cartCouponList(start: start, count: count, pageCursor: pageCursor, couponsIds: couponsIds, storeId: storeId, langId: langId, avail: avail, dateStartFrom: dateStartFrom, dateStartTo: dateStartTo, dateEndFrom: dateEndFrom, dateEndTo: dateEndTo, 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]
couponsIds	String	Filter coupons by ids	[optional]
storeId	String	Filter coupons by store id	[optional]
langId	String	Language id	[optional]
avail	Bool	Filter coupons by avail status	[optional]
dateStartFrom	String	Filter entity by date_start (greater or equal)	[optional]
dateStartTo	String	Filter entity by date_start (less or equal)	[optional]
dateEndFrom	String	Filter entity by date_end (greater or equal)	[optional]
dateEndTo	String	Filter entity by date_end (less or equal)	[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 "id,code,name,description"]
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

ModelResponseCartCouponList

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]

cartCreate

    open class func cartCreate(cartCreate: CartCreate, completion: @escaping (_ data: AccountCartAdd200Response?, _ error: Error?) -> Void)

cart.create

Add store to the account

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 cartCreate = CartCreate(cartId: "cartId_example", storeUrl: "storeUrl_example", bridgeUrl: "bridgeUrl_example", storeRoot: "storeRoot_example", storeKey: "storeKey_example", sharedSecret: "sharedSecret_example", validateVersion: true, verify: false, dbTablesPrefix: "dbTablesPrefix_example", userAgent: "userAgent_example", ftpHost: "ftpHost_example", ftpUser: "ftpUser_example", ftpPassword: "ftpPassword_example", ftpPort: 123, ftpStoreDir: "ftpStoreDir_example", apiKey3dcart: "apiKey3dcart_example", adminAccount: "adminAccount_example", apiPath: "apiPath_example", apiKeyBigcommerce: "apiKeyBigcommerce_example", clientId: "clientId_example", accessToken: "accessToken_example", context: "context_example", accessToken: "accessToken_example", apiKeyShopify: "apiKeyShopify_example", apiPassword: "apiPassword_example", accessTokenShopify: "accessTokenShopify_example", apiKey: "apiKey_example", apiUsername: "apiUsername_example", encryptedPassword: "encryptedPassword_example", login: "login_example", apiUserAdnsf: "apiUserAdnsf_example", apiPass: "apiPass_example", privateKey: "privateKey_example", appToken: "appToken_example", etsyKeystring: "etsyKeystring_example", etsySharedSecret: "etsySharedSecret_example", tokenSecret: "tokenSecret_example", etsyClientId: "etsyClientId_example", etsyRefreshToken: "etsyRefreshToken_example", ebayClientId: "ebayClientId_example", ebayClientSecret: "ebayClientSecret_example", ebayRuname: "ebayRuname_example", ebayAccessToken: "ebayAccessToken_example", ebayRefreshToken: "ebayRefreshToken_example", ebayEnvironment: "ebayEnvironment_example", ebaySiteId: 123, dwClientId: "dwClientId_example", dwApiPass: "dwApiPass_example", demandwareUserName: "demandwareUserName_example", demandwareUserPassword: "demandwareUserPassword_example", storeId: "storeId_example", sellerId: "sellerId_example", environment: "environment_example", hybrisClientId: "hybrisClientId_example", hybrisClientSecret: "hybrisClientSecret_example", hybrisUsername: "hybrisUsername_example", hybrisPassword: "hybrisPassword_example", hybrisWebsites: [AccountCartAdd_hybris_websites_inner(uid: "uid_example", url: "url_example", storeIds: ["storeIds_example"])], walmartClientId: "walmartClientId_example", walmartClientSecret: "walmartClientSecret_example", walmartEnvironment: "walmartEnvironment_example", walmartChannelType: "walmartChannelType_example", walmartRegion: "walmartRegion_example", lightspeedApiKey: "lightspeedApiKey_example", lightspeedApiSecret: "lightspeedApiSecret_example", shoplazzaAccessToken: "shoplazzaAccessToken_example", shoplazzaSharedSecret: "shoplazzaSharedSecret_example", shopwareAccessKey: "shopwareAccessKey_example", shopwareApiKey: "shopwareApiKey_example", shopwareApiSecret: "shopwareApiSecret_example", commercehqApiKey: "commercehqApiKey_example", commercehqApiPassword: "commercehqApiPassword_example", _3dcartPrivateKey: "_3dcartPrivateKey_example", _3dcartAccessToken: "_3dcartAccessToken_example", wcConsumerKey: "wcConsumerKey_example", wcConsumerSecret: "wcConsumerSecret_example", magentoConsumerKey: "magentoConsumerKey_example", magentoConsumerSecret: "magentoConsumerSecret_example", magentoAccessToken: "magentoAccessToken_example", magentoTokenSecret: "magentoTokenSecret_example", prestashopWebserviceKey: "prestashopWebserviceKey_example", wixAppId: "wixAppId_example", wixAppSecretKey: "wixAppSecretKey_example", wixInstanceId: "wixInstanceId_example", wixRefreshToken: "wixRefreshToken_example", mercadoLibreAppId: "mercadoLibreAppId_example", mercadoLibreAppSecretKey: "mercadoLibreAppSecretKey_example", mercadoLibreRefreshToken: "mercadoLibreRefreshToken_example", zidClientId: 123, zidClientSecret: "zidClientSecret_example", zidAccessToken: "zidAccessToken_example", zidAuthorization: "zidAuthorization_example", zidRefreshToken: "zidRefreshToken_example", flipkartClientId: "flipkartClientId_example", flipkartClientSecret: "flipkartClientSecret_example", allegroClientId: "allegroClientId_example", allegroClientSecret: "allegroClientSecret_example", allegroAccessToken: "allegroAccessToken_example", allegroRefreshToken: "allegroRefreshToken_example", allegroEnvironment: "allegroEnvironment_example") // CartCreate | 

// cart.create
CartAPI.cartCreate(cartCreate: cartCreate) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
cartCreate	CartCreate

Return type

AccountCartAdd200Response

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

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

cartDelete

    open class func cartDelete(deleteBridge: Bool? = nil, completion: @escaping (_ data: CartDelete200Response?, _ error: Error?) -> Void)

cart.delete

Remove store from API2Cart

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 deleteBridge = true // Bool | Identifies if there is a necessity to delete bridge (optional) (default to true)

// cart.delete
CartAPI.cartDelete(deleteBridge: deleteBridge) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
deleteBridge	Bool	Identifies if there is a necessity to delete bridge	[optional] [default to true]

Return type

CartDelete200Response

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]

cartDisconnect

    open class func cartDisconnect(deleteBridge: Bool? = nil, completion: @escaping (_ data: CartDisconnect200Response?, _ error: Error?) -> Void)

cart.disconnect

Disconnect with the store and clear store session data.

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 deleteBridge = true // Bool | Identifies if there is a necessity to delete bridge (optional) (default to false)

// cart.disconnect
CartAPI.cartDisconnect(deleteBridge: deleteBridge) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
deleteBridge	Bool	Identifies if there is a necessity to delete bridge	[optional] [default to false]

Return type

CartDisconnect200Response

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]

cartGiftcardAdd

    open class func cartGiftcardAdd(amount: Double, code: String? = nil, ownerEmail: String? = nil, recipientEmail: String? = nil, recipientName: String? = nil, ownerName: String? = nil, completion: @escaping (_ data: CartGiftcardAdd200Response?, _ error: Error?) -> Void)

cart.giftcard.add

Use this method to create a gift card for a specified amount.

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 amount = 987 // Double | Defines the gift card amount value.
let code = "code_example" // String | Gift card code (optional)
let ownerEmail = "ownerEmail_example" // String | Gift card owner email (optional)
let recipientEmail = "recipientEmail_example" // String | Gift card recipient email (optional)
let recipientName = "recipientName_example" // String | Gift card recipient name (optional)
let ownerName = "ownerName_example" // String | Gift card owner name (optional)

// cart.giftcard.add
CartAPI.cartGiftcardAdd(amount: amount, code: code, ownerEmail: ownerEmail, recipientEmail: recipientEmail, recipientName: recipientName, ownerName: ownerName) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
amount	Double	Defines the gift card amount value.
code	String	Gift card code	[optional]
ownerEmail	String	Gift card owner email	[optional]
recipientEmail	String	Gift card recipient email	[optional]
recipientName	String	Gift card recipient name	[optional]
ownerName	String	Gift card owner name	[optional]

Return type

CartGiftcardAdd200Response

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]

cartGiftcardCount

    open class func cartGiftcardCount(storeId: String? = nil, completion: @escaping (_ data: CartGiftcardCount200Response?, _ error: Error?) -> Void)

cart.giftcard.count

Get gift cards count.

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 storeId = "storeId_example" // String | Store Id (optional)

// cart.giftcard.count
CartAPI.cartGiftcardCount(storeId: storeId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
storeId	String	Store Id	[optional]

Return type

CartGiftcardCount200Response

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]

cartGiftcardDelete

    open class func cartGiftcardDelete(id: String, completion: @escaping (_ data: AttributeDelete200Response?, _ error: Error?) -> Void)

cart.giftcard.delete

Delete giftcard

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 id = "id_example" // String | Entity id

// cart.giftcard.delete
CartAPI.cartGiftcardDelete(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	Entity id

Return type

AttributeDelete200Response

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]

cartGiftcardList

    open class func cartGiftcardList(start: Int? = nil, count: Int? = nil, pageCursor: String? = nil, storeId: String? = nil, responseFields: String? = nil, params: String? = nil, exclude: String? = nil, completion: @escaping (_ data: ModelResponseCartGiftCardList?, _ error: Error?) -> Void)

cart.giftcard.list

Get gift cards 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 storeId = "storeId_example" // String | Store Id (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 "id,code,name")
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)

// cart.giftcard.list
CartAPI.cartGiftcardList(start: start, count: count, pageCursor: pageCursor, storeId: storeId, 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]
storeId	String	Store Id	[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 "id,code,name"]
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

ModelResponseCartGiftCardList

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]

cartInfo

    open class func cartInfo(storeId: String? = nil, responseFields: String? = nil, params: String? = nil, exclude: String? = nil, completion: @escaping (_ data: CartInfo200Response?, _ error: Error?) -> Void)

cart.info

This method allows you to get various information about the store, including a list of stores (in the case of a multistore configuration), a list of supported languages, currencies, carriers, warehouses, and many other information. This information contains data that is relatively stable and rarely changes, so API2Cart can cache certain data to reduce the load on the store and speed up the execution of the request. We also recommend that you cache the response of this method on your side to save requests. If you need to clear the cache for a specific store, then use the cart.validate method.

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 storeId = "storeId_example" // String | Store Id (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 "store_name,store_url,db_prefix")
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)

// cart.info
CartAPI.cartInfo(storeId: storeId, 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
storeId	String	Store Id	[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 "store_name,store_url,db_prefix"]
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

CartInfo200Response

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]

cartList

    open class func cartList(completion: @escaping (_ data: CartList200Response?, _ error: Error?) -> Void)

cart.list

Get list of supported carts

Example

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


// cart.list
CartAPI.cartList() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

CartList200Response

Authorization

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]

cartMetaDataList

    open class func cartMetaDataList(entityId: String, count: Int? = nil, pageCursor: String? = nil, entity: String? = nil, storeId: String? = nil, langId: String? = nil, key: String? = nil, responseFields: String? = nil, params: String? = nil, exclude: String? = nil, completion: @escaping (_ data: ModelResponseCartMetaDataList?, _ error: Error?) -> Void)

cart.meta_data.list

Using this method, you can get a list of metadata for various entities (products, options, customers, orders). Usually this is data created by third-party plugins.

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 entityId = "entityId_example" // String | Entity Id
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 entity = "entity_example" // String | Entity (optional) (default to "product")
let storeId = "storeId_example" // String | Store Id (optional)
let langId = "langId_example" // String | Language id (optional)
let key = "key_example" // String | Key (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 "key,value")
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)

// cart.meta_data.list
CartAPI.cartMetaDataList(entityId: entityId, count: count, pageCursor: pageCursor, entity: entity, storeId: storeId, langId: langId, key: key, 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
entityId	String	Entity Id
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]
entity	String	Entity	[optional] [default to "product"]
storeId	String	Store Id	[optional]
langId	String	Language id	[optional]
key	String	Key	[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 "key,value"]
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

ModelResponseCartMetaDataList

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]

cartMetaDataSet

    open class func cartMetaDataSet(entityId: String, key: String, value: String, namespace: String, entity: String? = nil, storeId: String? = nil, langId: String? = nil, completion: @escaping (_ data: AttributeAdd200Response?, _ error: Error?) -> Void)

cart.meta_data.set

Set meta data for a specific entity

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 entityId = "entityId_example" // String | Entity Id
let key = "key_example" // String | Key
let value = "value_example" // String | Value
let namespace = "namespace_example" // String | Metafield namespace
let entity = "entity_example" // String | Entity (optional) (default to "product")
let storeId = "storeId_example" // String | Store Id (optional)
let langId = "langId_example" // String | Language id (optional)

// cart.meta_data.set
CartAPI.cartMetaDataSet(entityId: entityId, key: key, value: value, namespace: namespace, entity: entity, storeId: storeId, langId: langId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
entityId	String	Entity Id
key	String	Key
value	String	Value
namespace	String	Metafield namespace
entity	String	Entity	[optional] [default to "product"]
storeId	String	Store Id	[optional]
langId	String	Language id	[optional]

Return type

AttributeAdd200Response

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]

cartMetaDataUnset

    open class func cartMetaDataUnset(entityId: String, key: String, id: String, entity: String? = nil, storeId: String? = nil, completion: @escaping (_ data: BasketLiveShippingServiceDelete200Response?, _ error: Error?) -> Void)

cart.meta_data.unset

Unset meta data for a specific entity

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 entityId = "entityId_example" // String | Entity Id
let key = "key_example" // String | Key
let id = "id_example" // String | Entity id
let entity = "entity_example" // String | Entity (optional) (default to "product")
let storeId = "storeId_example" // String | Store Id (optional)

// cart.meta_data.unset
CartAPI.cartMetaDataUnset(entityId: entityId, key: key, id: id, entity: entity, storeId: storeId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
entityId	String	Entity Id
key	String	Key
id	String	Entity id
entity	String	Entity	[optional] [default to "product"]
storeId	String	Store Id	[optional]

Return type

BasketLiveShippingServiceDelete200Response

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]

cartMethods

    open class func cartMethods(completion: @escaping (_ data: CartMethods200Response?, _ error: Error?) -> Void)

cart.methods

Returns a list of supported API methods.

Example

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


// cart.methods
CartAPI.cartMethods() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

CartMethods200Response

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]

cartPluginList

    open class func cartPluginList(start: Int? = nil, count: Int? = nil, storeId: String? = nil, completion: @escaping (_ data: CartPluginList200Response?, _ error: Error?) -> Void)

cart.plugin.list

Get a list of third-party plugins installed on the store.

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 storeId = "storeId_example" // String | Store Id (optional)

// cart.plugin.list
CartAPI.cartPluginList(start: start, count: count, storeId: storeId) { (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]
storeId	String	Store Id	[optional]

Return type

CartPluginList200Response

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]

cartScriptAdd

    open class func cartScriptAdd(name: String? = nil, description: String? = nil, html: String? = nil, src: String? = nil, loadMethod: String? = nil, scope: String? = nil, events: String? = nil, storeId: String? = nil, completion: @escaping (_ data: CartScriptAdd200Response?, _ error: Error?) -> Void)

cart.script.add

Add new script to the storefront

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 name = "name_example" // String | The user-friendly script name (optional)
let description = "description_example" // String | The user-friendly description (optional)
let html = "html_example" // String | An html string containing exactly one `script` tag. (optional)
let src = "src_example" // String | The URL of the remote script (optional)
let loadMethod = "loadMethod_example" // String | The load method to use for the script (optional)
let scope = "scope_example" // String | The page or pages on the online store where the script should be included (optional) (default to "storefront")
let events = "events_example" // String | Event for run scripts (optional)
let storeId = "storeId_example" // String | Store Id (optional)

// cart.script.add
CartAPI.cartScriptAdd(name: name, description: description, html: html, src: src, loadMethod: loadMethod, scope: scope, events: events, storeId: storeId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
name	String	The user-friendly script name	[optional]
description	String	The user-friendly description	[optional]
html	String	An html string containing exactly one `script` tag.	[optional]
src	String	The URL of the remote script	[optional]
loadMethod	String	The load method to use for the script	[optional]
scope	String	The page or pages on the online store where the script should be included	[optional] [default to "storefront"]
events	String	Event for run scripts	[optional]
storeId	String	Store Id	[optional]

Return type

CartScriptAdd200Response

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]

cartScriptDelete

    open class func cartScriptDelete(id: String, storeId: String? = nil, completion: @escaping (_ data: AttributeDelete200Response?, _ error: Error?) -> Void)

cart.script.delete

Remove script from the storefront

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 id = "id_example" // String | Entity id
let storeId = "storeId_example" // String | Store Id (optional)

// cart.script.delete
CartAPI.cartScriptDelete(id: id, storeId: storeId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	Entity id
storeId	String	Store Id	[optional]

Return type

AttributeDelete200Response

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]

cartScriptList

    open class func cartScriptList(start: Int? = nil, count: Int? = nil, pageCursor: String? = nil, scriptIds: String? = nil, storeId: 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: ModelResponseCartScriptList?, _ error: Error?) -> Void)

cart.script.list

Get scripts installed to the storefront

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 scriptIds = "scriptIds_example" // String | Retrieves only scripts with specific ids (optional)
let storeId = "storeId_example" // String | Store Id (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 "id,name,description")
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)

// cart.script.list
CartAPI.cartScriptList(start: start, count: count, pageCursor: pageCursor, scriptIds: scriptIds, storeId: storeId, 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]
scriptIds	String	Retrieves only scripts with specific ids	[optional]
storeId	String	Store Id	[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 "id,name,description"]
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

ModelResponseCartScriptList

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]

cartShippingZonesList

    open class func cartShippingZonesList(start: Int? = nil, count: Int? = nil, storeId: String? = nil, responseFields: String? = nil, params: String? = nil, exclude: String? = nil, completion: @escaping (_ data: ModelResponseCartShippingZonesList?, _ error: Error?) -> Void)

cart.shipping_zones.list

Get list of shipping zones

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 storeId = "storeId_example" // String | Store Id (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 "id,name,enabled")
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)

// cart.shipping_zones.list
CartAPI.cartShippingZonesList(start: start, count: count, storeId: storeId, 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]
storeId	String	Store Id	[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 "id,name,enabled"]
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

ModelResponseCartShippingZonesList

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]

cartValidate

    open class func cartValidate(validateVersion: Bool? = nil, completion: @escaping (_ data: CartValidate200Response?, _ error: Error?) -> Void)

cart.validate

This method clears the cache in API2Cart for a particular store and checks whether the connection to the store is available. Use this method if there have been any changes in the settings on the storе, for example, if a new plugin has been installed or removed.

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 validateVersion = true // Bool | Specify if api2cart should validate cart version (optional) (default to false)

// cart.validate
CartAPI.cartValidate(validateVersion: validateVersion) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
validateVersion	Bool	Specify if api2cart should validate cart version	[optional] [default to false]

Return type

CartValidate200Response

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]

Files

CartAPI.md

Latest commit

History

CartAPI.md

File metadata and controls

CartAPI

cartBridge

Example

Parameters

Return type

Authorization

HTTP request headers

cartCatalogPriceRulesCount

Example

Parameters

Return type

Authorization

HTTP request headers

cartCatalogPriceRulesList

Example

Parameters

Return type

Authorization

HTTP request headers

cartClearCache

Example

Parameters

Return type

Authorization

HTTP request headers

cartConfig

Example

Parameters

Return type

Authorization

HTTP request headers

cartConfigUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

cartCouponAdd

Example

Parameters

Return type

Authorization

HTTP request headers

cartCouponConditionAdd

Example

Parameters

Return type

Authorization

HTTP request headers

cartCouponCount

Example

Parameters

Return type

Authorization

HTTP request headers

cartCouponDelete

Example

Parameters

Return type

Authorization

HTTP request headers

cartCouponList

Example

Parameters

Return type

Authorization

HTTP request headers

cartCreate

Example

Parameters

Return type

Authorization

HTTP request headers

cartDelete