Documentation

CartItemsApi extends UuidResourceWithUuidParentApi
in package
Uses DeleteResource

Cart Items API

Example for adding a line item to a cart:

$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);

$lineItem = new CartItem();
$lineItem->line_items[] = [
    "sku"        => "made-up",
    "name"       => "My product",
    "quantity"   => 33,
    "list_price" => 55
];

$api()->cart($id)->items()->add($lineItem, CartItemsApi::INCLUDE_REDIRECT_URLS);
Tags

Table of Contents

INCLUDE_DIGITAL_ITEMS  = 'line_items.digital_items.options'
The Cart returns an abbreviated result. Use this to return digital items product options.
INCLUDE_PHYSICAL_ITEMS  = 'line_items.physical_items.options'
The Cart returns an abbreviated result. Use this to return physical items product options.
INCLUDE_REDIRECT_URLS  = 'redirect_urls'
Create a direct link to a Cart.
__construct()  : mixed
add()  : CartResponse
delete()  : ResponseInterface
getClient()  : Client
getParentResourceId()  : int|null
getParentUuid()  : string
getResourceId()  : int|null
getUuid()  : string
multipleResourceUrl()  : string
setParentUuid()  : void
setUuid()  : void
singleResourceUrl()  : string
update()  : CartResponse

Constants

INCLUDE_DIGITAL_ITEMS

The Cart returns an abbreviated result. Use this to return digital items product options.

public mixed INCLUDE_DIGITAL_ITEMS = 'line_items.digital_items.options'
Tags

INCLUDE_PHYSICAL_ITEMS

The Cart returns an abbreviated result. Use this to return physical items product options.

public mixed INCLUDE_PHYSICAL_ITEMS = 'line_items.physical_items.options'
Tags

INCLUDE_REDIRECT_URLS

Create a direct link to a Cart.

public mixed INCLUDE_REDIRECT_URLS = 'redirect_urls'
Tags

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
Tags
Return values
mixed —

delete()

public delete() : ResponseInterface
Tags
Return values
ResponseInterface —

getParentResourceId()

public getParentResourceId() : int|null
Tags
Return values
int|null —

getResourceId()

public getResourceId() : int|null
Tags
Return values
int|null —

multipleResourceUrl()

public multipleResourceUrl() : string
Tags
Return values
string —

setParentUuid()

public setParentUuid(string $parentUuid) : void
Parameters
$parentUuid : string
Tags
Return values
void —

setUuid()

public setUuid(string $uuid) : void
Parameters
$uuid : string
Tags
Return values
void —

singleResourceUrl()

public singleResourceUrl() : string
Tags
Return values
string — 

        

        
    




    

    

                

    

        

            
Search results