CartsApi extends UuidResourceApi
Carts API
The is the store management access for creating and viewing carts (not for customers to access carts)
Example fetching the contents of a cart:
$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);
$cart = $api->carts('abcdefg;)->get()->getCart();
Table of Contents
- __construct() : mixed
- create() : CartResponse
- get() : CartResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- getUuid() : string
- item() : CartItemsApi
- items() : CartItemsApi
- multipleResourceUrl() : string
- redirectUrls() : CartRedirectUrlsApi
- setUuid() : void
- singleResourceUrl() : string
- updateCustomerId() : CartResponse
Methods
__construct()
public
__construct(Client $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed
Parameters
- $client : Client
- $resourceId : int|null = null
- $parentResourceId : int|null = null
Return values
mixed —create()
public
create(Cart $cart) : CartResponse
Parameters
- $cart : Cart
Return values
CartResponse —get()
public
get() : CartResponse
Return values
CartResponse —getClient()
public
getClient() : Client
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Return values
int|null —getResourceId()
public
getResourceId() : int|null
Return values
int|null —getUuid()
public
getUuid() : string
Return values
string —item()
public
item(string $id) : CartItemsApi
Parameters
- $id : string
Return values
CartItemsApi —items()
public
items() : CartItemsApi
Return values
CartItemsApi —multipleResourceUrl()
public
multipleResourceUrl() : string
Return values
string —redirectUrls()
public
redirectUrls() : CartRedirectUrlsApi
Return values
CartRedirectUrlsApi —setUuid()
public
setUuid(string $uuid) : void
Parameters
- $uuid : string
Return values
void —singleResourceUrl()
public
singleResourceUrl() : string
Return values
string —updateCustomerId()
public
updateCustomerId(int $customerId) : CartResponse
Parameters
- $customerId : int