OrderProductsApi
extends V2ApiBase
in package
Uses
GetResource, GetAllResources
Order Products v2 API
For listing the products in an order.
Example
Get Order Products
$api = new BigCommerce\ApiV2\V2ApiClient($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);
$orderId = 231;
$products = $api->order($orderId)->products();
$productNamesOrdered = array_column('name', $products);
Tags
Table of Contents
- __construct() : mixed
- get() : OrderProduct
- getAll() : array<string|int, OrderProduct>
- getClient() : BaseApiClient
- getParentResourceId() : int|null
- getResourceId() : int|null
- multipleResourceUrl() : string
- singleResourceUrl() : string
Methods
__construct()
public
__construct(BaseApiClient $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed
Parameters
- $client : BaseApiClient
- $resourceId : int|null = null
- $parentResourceId : int|null = null
Tags
Return values
mixed —get()
public
get() : OrderProduct
Tags
Return values
OrderProduct —getAll()
public
getAll([int $page = 1 ][, int $limit = 250 ]) : array<string|int, OrderProduct>
Parameters
- $page : int = 1
- $limit : int = 250
Tags
Return values
array<string|int, OrderProduct> —getClient()
public
getClient() : BaseApiClient
Tags
Return values
BaseApiClient —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 —singleResourceUrl()
public
singleResourceUrl() : string