CustomFieldsApi
extends ResourceApi
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
- CUSTOM_FIELD_ENDPOINT = 'catalog/products/%d/custom-fields/%d'
- CUSTOM_FIELDS_ENDPOINT = 'catalog/products/%d/custom-fields'
- RESOURCE_NAME = 'custom-fields'
- __construct() : mixed
- create() : CustomFieldResponse
- delete() : ResponseInterface
- get() : CustomFieldResponse
- getAll() : CustomFieldsResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- multipleResourceUrl() : string
- singleResourceUrl() : string
- update() : CustomFieldResponse
Constants
CUSTOM_FIELD_ENDPOINT
public
mixed
CUSTOM_FIELD_ENDPOINT
= 'catalog/products/%d/custom-fields/%d'
Tags
CUSTOM_FIELDS_ENDPOINT
public
mixed
CUSTOM_FIELDS_ENDPOINT
= 'catalog/products/%d/custom-fields'
Tags
RESOURCE_NAME
public
mixed
RESOURCE_NAME
= 'custom-fields'
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 —create()
public
create(CustomField $customField) : CustomFieldResponse
Parameters
- $customField : CustomField
Tags
Return values
CustomFieldResponse —delete()
public
delete() : ResponseInterface
Tags
Return values
ResponseInterface —get()
public
get() : CustomFieldResponse
Tags
Return values
CustomFieldResponse —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : CustomFieldsResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Tags
Return values
CustomFieldsResponse —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 —multipleResourceUrl()
public
abstract multipleResourceUrl() : string
Tags
Return values
string —singleResourceUrl()
public
abstract singleResourceUrl() : string
Tags
Return values
string —update()
public
update(CustomField $customField) : CustomFieldResponse
Parameters
- $customField : CustomField