ChannelCurrencyAssignmentsApi extends V3ApiBase
Channel Currency Assignments API
Example for finding all the currency assignments. Note that the parent id is effectively just a filter.
$api = new BigCommerce\ApiV3\Client($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);
$allCurrencyAssignments = $api->channels()->currencyAssignments()->getAll()->getCurrencyAssignments();
$channelCurrencyAssignments = $api->channel(1)->currencyAssignments()->getAll()->getCurrencyAssignments();
Table of Contents
- __construct() : mixed
- batchCreate() : ChannelCurrencyAssignmentsResponse
- batchUpdate() : ChannelCurrencyAssignmentsResponse
- create() : ChannelCurrencyAssignmentsResponse
- getAll() : ChannelCurrencyAssignmentsResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- multipleResourceUrl() : string
- Currency Assignment endpoints are different, they are all multiple resource endpoints, that may or may not be filtered by channel id.
- singleResourceUrl() : string
- update() : ChannelCurrencyAssignmentsResponse
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 —batchCreate()
public
batchCreate(array<string|int, ChannelCurrencyAssignment> $resources) : ChannelCurrencyAssignmentsResponse
Parameters
- $resources : array<string|int, ChannelCurrencyAssignment>
Return values
ChannelCurrencyAssignmentsResponse —batchUpdate()
public
batchUpdate(array<string|int, ChannelCurrencyAssignment> $resources) : ChannelCurrencyAssignmentsResponse
Parameters
- $resources : array<string|int, ChannelCurrencyAssignment>
Return values
ChannelCurrencyAssignmentsResponse —create()
public
create(ChannelCurrencyAssignment $currencyAssignment) : ChannelCurrencyAssignmentsResponse
Parameters
- $currencyAssignment : ChannelCurrencyAssignment
Return values
ChannelCurrencyAssignmentsResponse —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : ChannelCurrencyAssignmentsResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Return values
ChannelCurrencyAssignmentsResponse —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 —multipleResourceUrl()
Currency Assignment endpoints are different, they are all multiple resource endpoints, that may or may not be filtered by channel id.
public
multipleResourceUrl() : string
Return values
string —singleResourceUrl()
public
singleResourceUrl() : string
Return values
string —update()
public
update(ChannelCurrencyAssignment $currencyAssignment) : ChannelCurrencyAssignmentsResponse
Parameters
- $currencyAssignment : ChannelCurrencyAssignment