ChannelCurrencyAssignmentsApi
extends V3ApiBase
in package
Uses
GetAllResources, DeleteResource, UpdateResource, CreateResource, BatchUpdateResource, BatchCreateResource
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();
Tags
Table of Contents
- __construct() : mixed
- batchCreate() : ChannelCurrencyAssignmentsResponse
- batchUpdate() : ChannelCurrencyAssignmentsResponse
- create() : ChannelCurrencyAssignmentsResponse
- delete() : ResponseInterface
- getAll() : ChannelCurrencyAssignmentsResponse
- getClient() : Client
- getMaxRetries() : int
- 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.
- setMaxRetries() : void
- 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
Tags
Return values
mixed —batchCreate()
public
batchCreate(array<string|int, ChannelCurrencyAssignment> $resources) : ChannelCurrencyAssignmentsResponse
Parameters
- $resources : array<string|int, ChannelCurrencyAssignment>
Tags
Return values
ChannelCurrencyAssignmentsResponse —batchUpdate()
public
batchUpdate(array<string|int, ChannelCurrencyAssignment> $resources) : ChannelCurrencyAssignmentsResponse
Parameters
- $resources : array<string|int, ChannelCurrencyAssignment>
Tags
Return values
ChannelCurrencyAssignmentsResponse —create()
public
create(ChannelCurrencyAssignment $currencyAssignment) : ChannelCurrencyAssignmentsResponse
Parameters
- $currencyAssignment : ChannelCurrencyAssignment
Tags
Return values
ChannelCurrencyAssignmentsResponse —delete()
public
delete() : ResponseInterface
Tags
Return values
ResponseInterface —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
Tags
Return values
ChannelCurrencyAssignmentsResponse —getClient()
public
getClient() : Client
Tags
Return values
Client —getMaxRetries()
public
getMaxRetries() : int
Tags
Return values
int —getParentResourceId()
public
getParentResourceId() : int|null
Tags
Return values
int|null —getResourceId()
public
getResourceId() : int|null
Tags
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
Tags
Return values
string —setMaxRetries()
public
setMaxRetries(int $maxRetries) : void
Parameters
- $maxRetries : int
Tags
Return values
void —singleResourceUrl()
public
singleResourceUrl() : string
Tags
Return values
string —update()
public
update(ChannelCurrencyAssignment $currencyAssignment) : ChannelCurrencyAssignmentsResponse
Parameters
- $currencyAssignment : ChannelCurrencyAssignment