Products
in package
Products resource for managing catalog products.
Table of Contents
Methods
- __construct() : mixed
- addPrice() : CatalogPrice
- Add a price to a product (POST /products/add_price).
- archive() : Product
- Archive a product (POST /products/archive).
- create() : Product
- Create a product (POST /products/create).
- lookup() : Product
- Lookup a product by ID (POST /products/lookup).
- page() : ProductPage
- Page through products (POST /products/page).
- publish() : Product
- Publish a product (POST /products/publish).
- setDefaultUnitPrice() : Product
- Set a product's default unit price (POST /products/set_default_unit_price).
- unpublish() : Product
- Unpublish a product (POST /products/unpublish).
- update() : Product
- Update a product (POST /products/update).
Methods
__construct()
public
__construct(HttpClient $http) : mixed
Parameters
- $http : HttpClient
addPrice()
Add a price to a product (POST /products/add_price).
public
addPrice(array<string|int, mixed> $payload) : CatalogPrice
Parameters
- $payload : array<string|int, mixed>
Return values
CatalogPricearchive()
Archive a product (POST /products/archive).
public
archive(string $productId) : Product
Parameters
- $productId : string
Return values
Productcreate()
Create a product (POST /products/create).
public
create(array<string|int, mixed> $payload) : Product
Parameters
- $payload : array<string|int, mixed>
Return values
Productlookup()
Lookup a product by ID (POST /products/lookup).
public
lookup(string $productId) : Product
Parameters
- $productId : string
Return values
Productpage()
Page through products (POST /products/page).
public
page([array<string|int, mixed> $payload = [] ]) : ProductPage
Parameters
- $payload : array<string|int, mixed> = []
Return values
ProductPagepublish()
Publish a product (POST /products/publish).
public
publish(string $productId) : Product
Parameters
- $productId : string
Return values
ProductsetDefaultUnitPrice()
Set a product's default unit price (POST /products/set_default_unit_price).
public
setDefaultUnitPrice(array<string|int, mixed> $payload) : Product
Parameters
- $payload : array<string|int, mixed>
Return values
Productunpublish()
Unpublish a product (POST /products/unpublish).
public
unpublish(string $productId) : Product
Parameters
- $productId : string
Return values
Productupdate()
Update a product (POST /products/update).
public
update(array<string|int, mixed> $payload) : Product
Parameters
- $payload : array<string|int, mixed>