Overview
  • Namespace
  • Class

Namespaces

  • MailChimp
    • AuthorizedApps
    • Automations
    • Batches
    • CampaignFolders
    • Campaigns
    • Conversations
    • Ecommerce
    • FileManager
    • Lists
    • Reports
    • TemplateFolders
    • Templates

Classes

  • Carts
  • Customers
  • Ecommerce
  • Orders
  • Products

Class Carts

MailChimp\MailChimp
Extended by MailChimp\Ecommerce\Ecommerce
Extended by MailChimp\Ecommerce\Carts
Namespace: MailChimp\Ecommerce
Located at Ecommerce/Carts.php

Methods summary

public object
# getCarts( string $store_id, array $query = [] )

Get information about a store’s carts.

Get information about a store’s carts.

array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") array["count"] int number of records to return array["offset"] int number of records from a collection to skip.

Parameters

$store_id
$query
(See Above) OPTIONAL associative array of query parameters.

Returns

object
public
# getCart( $store_id, $cart_id, array $query = [] )

Get information about a specific cart.

Get information about a specific cart.

array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields")

public object
# addCart( string $store_id, string $cart_id, string $currency_code, number $cart_total, array $customer = [], array $lines = [], array $optional_settings = null )

Add a new cart to a store.

Add a new cart to a store.

Parameters

$store_id
$cart_id
$currency_code
$cart_total
$customer
See addCustomer method in Customer class
$lines
See addOrderLine method below
$optional_settings

Returns

object
public object
# updateCart( string $store_id, string $cart_id, array $data = [] )

Update a cart

Update a cart

Parameters

$store_id
$cart_id
$cart+id
$data

Returns

object
public object
# getCartLines( string $store_id, string $cart_id, array $query = [] )

Get information about a cart’s line items

Get information about a cart’s line items

array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") array["count"] int number of records to return array["offset"] int number of records from a collection to skip.

Parameters

$store_id
$cart_id
$query
(See Above) OPTIONAL associative array of query parameters.

Returns

object
public object
# getCartLine( string $store_id, string $cart_id, array $line_id, array $query = [] )

Get information about a specific cart line item.

Get information about a specific cart line item.

array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields")

Parameters

$store_id
$cart_id
$line_id
$query (See Above) OPTIONAL associative array of query parameters.
$query

Returns

object
public object
# addCartLine( string $store_id, string $cart_id, string $line_id, string $product_id, string $product_variant_id, integer $quantity, number $price )

Add a new line item to an existing cart

Add a new line item to an existing cart

Parameters

$store_id
$cart_id
$line_id
$product_id
$product_variant_id
$quantity
$price
price

Returns

object
public object
# updateCartLine( string $store_id, string $cart_id, string $line_id, array $data = [] )

Update a line item to an existing cart

Update a line item to an existing cart

Parameters

$store_id
$cart_id
$line_id
$data

Returns

object
public
# deleteCartLine( string $store_id, string $cart_id, string $line_id )

Delete a line item to an existing cart

Delete a line item to an existing cart

Parameters

$store_id
$cart_id
$line_id
public
# deleteCart( string $store_id, string $cart_id )

Delete a cart

Delete a cart

Parameters

$store_id
$cart_id

Methods inherited from MailChimp\Ecommerce\Ecommerce

addStore(), carts(), customers(), deleteStore(), getStore(), getStores(), orders(), products(), updateStore()

Methods inherited from MailChimp\MailChimp

__construct(), authorizedApps(), automations(), batchOps(), campaignFolders(), campaigns(), conversations(), createLog(), ecommerce(), execute(), fileManager(), fileManagerFolders(), getAccountInfo(), getMemberHash(), lists(), logData(), optionalFields(), reports(), searchMembers(), templateFolders(), templates()

API documentation generated by ApiGen