PriceListRecordsApi
extends V3ApiBase
in package
V3ApiBase
Add constructors and some basic scaffolding that will work for all API classes regardless of which endpoints they implement
Tags
Table of Contents
- __construct() : mixed
- delete() : ResponseInterface
- deleteByCurrencyCode() : ResponseInterface
- getAll() : PriceListRecordsResponse
- getAllByVariant() : PriceListRecordsResponse
- getByCurrencyCode() : PriceListRecordResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- setByCurrencyCode() : ResponseInterface
- upsert() : ResponseInterface
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(array<string|int, mixed> $ids) : ResponseInterface
Parameters
- $ids : array<string|int, mixed>
Tags
Return values
ResponseInterface —deleteByCurrencyCode()
public
deleteByCurrencyCode(int $variantId, string $currencyCode) : ResponseInterface
Parameters
- $variantId : int
- $currencyCode : string
Tags
Return values
ResponseInterface —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : PriceListRecordsResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Tags
Return values
PriceListRecordsResponse —getAllByVariant()
public
getAllByVariant(int $variantId) : PriceListRecordsResponse
Parameters
- $variantId : int
Tags
Return values
PriceListRecordsResponse —getByCurrencyCode()
public
getByCurrencyCode(int $variantId, string $currencyCode) : PriceListRecordResponse
Parameters
- $variantId : int
- $currencyCode : string
Tags
Return values
PriceListRecordResponse —getClient()
public
getClient() : Client
Tags
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Tags
Return values
int|null —getResourceId()
public
getResourceId() : int|null
Tags
Return values
int|null —setByCurrencyCode()
public
setByCurrencyCode(int $variantId, string $currencyCode, PriceListRecord $record) : ResponseInterface
Parameters
- $variantId : int
- $currencyCode : string
- $record : PriceListRecord
Tags
Return values
ResponseInterface —upsert()
public
upsert(array<string|int, mixed> $records) : ResponseInterface
Parameters
- $records : array<string|int, mixed>