Prices
in package
Prices resource for managing catalog prices.
Table of Contents
Methods
- __construct() : mixed
- activate() : CatalogPrice
- Activate a price (POST /prices/activate).
- archive() : CatalogPrice
- Archive a price and mark it inactive (POST /prices/archive).
- create() : CatalogPrice
- Create a price (POST /prices/create).
- deactivate() : CatalogPrice
- Deactivate a price (POST /prices/deactivate).
- lookup() : CatalogPrice
- Lookup a price by ID (POST /prices/lookup).
- page() : PricePage
- Page through prices (POST /prices/page).
- update() : CatalogPrice
- Update a price (POST /prices/update).
Methods
__construct()
public
__construct(HttpClient $http) : mixed
Parameters
- $http : HttpClient
activate()
Activate a price (POST /prices/activate).
public
activate(string $priceId) : CatalogPrice
Parameters
- $priceId : string
Return values
CatalogPricearchive()
Archive a price and mark it inactive (POST /prices/archive).
public
archive(string $priceId[, string|null $idempotencyKey = null ]) : CatalogPrice
Parameters
- $priceId : string
- $idempotencyKey : string|null = null
Return values
CatalogPricecreate()
Create a price (POST /prices/create).
public
create(array<string|int, mixed>|CatalogPriceParams $payload) : CatalogPrice
Parameters
- $payload : array<string|int, mixed>|CatalogPriceParams
Return values
CatalogPricedeactivate()
Deactivate a price (POST /prices/deactivate).
public
deactivate(string $priceId) : CatalogPrice
Parameters
- $priceId : string
Return values
CatalogPricelookup()
Lookup a price by ID (POST /prices/lookup).
public
lookup(string $priceId) : CatalogPrice
Parameters
- $priceId : string
Return values
CatalogPricepage()
Page through prices (POST /prices/page).
public
page([array<string|int, mixed> $payload = [] ]) : PricePage
Parameters
- $payload : array<string|int, mixed> = []
Return values
PricePageupdate()
Update a price (POST /prices/update).
public
update(array<string|int, mixed> $payload) : CatalogPrice
Parameters
- $payload : array<string|int, mixed>