Inttegro PHP SDK

ProductLineItemProduct extends DomainValue
in package

FinalYes

Product Line Item Product details associated with order.

This immutable value hydrates decoded API snake_case data into typed camelCase properties. Use fromArray() for wire data; toArray(), array access, and JSON serialization expose the API wire representation. Nullable properties correspond to optional API fields.

Tags
see
DomainValue

Table of Contents

Properties

$about  : string|null
Additional explanatory text.
$category  : string|null
Category value for this product line item product.
$customData  : CustomData|null
Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.
$id  : string
Immutable order-line identifier with the `oli_` prefix.
$name  : string
Human-readable name.
$price  : Inline
An inline price returned by the API.
$priceId  : string|null
Source catalog price ID when this line snapshots a saved price.
$productId  : string|null
Source catalog product ID when this line snapshots a catalog product.
$quantity  : int
Quantity value for this product line item product.
$reference  : string|null
Reference value for this product line item product.
$taxCode  : string|null
Tax Code value for this product line item product.
$type  : string|null
Discriminator identifying the value's API variant.

Methods

__construct()  : mixed
Hydrates a ProductLineItemProduct from decoded Inttegro API data.
fromArray()  : static
Creates a ProductLineItemProduct from its decoded API wire representation.
jsonSerialize()  : array<string, mixed>
Returns the same API wire object as `toArray()` for `json_encode()`.
offsetExists()  : bool
Reports whether a non-null property exists for a PHP or API field name.
offsetGet()  : mixed
Reads a typed property through PHP `ArrayAccess`.
offsetSet()  : void
Rejects mutation because domain values are immutable.
offsetUnset()  : void
Rejects unsetting because domain values are immutable.
toArray()  : array<string, mixed>
Converts typed properties back to the API's wire representation.

Properties

$about read-only

Additional explanatory text.

public string|null $about

Optional response field. PHP type: string|null; wire field: about (string).

$category read-only

Category value for this product line item product.

public string|null $category

Optional response field. PHP type: string|null; wire field: category (string).

$customData read-only

Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.

public CustomData|null $customData

Optional response field. PHP type: \Inttegro\CustomData|null; wire field: custom_data (object).

$id read-only

Immutable order-line identifier with the `oli_` prefix.

public string $id

Required response field. PHP type: string; wire field: id (string).

$name read-only

Human-readable name.

public string $name

Required response field. PHP type: string; wire field: name (string).

$price read-only

An inline price returned by the API.

public Inline $price

Required response field. PHP type: \Inttegro\Price\Inline; wire field: price (object).

$priceId read-only

Source catalog price ID when this line snapshots a saved price.

public string|null $priceId

Optional response field. PHP type: string|null; wire field: price_id (string).

$productId read-only

Source catalog product ID when this line snapshots a catalog product.

public string|null $productId

Optional response field. PHP type: string|null; wire field: product_id (string).

$quantity read-only

Quantity value for this product line item product.

public int $quantity

Required response field. PHP type: int; wire field: quantity (integer).

$reference read-only

Reference value for this product line item product.

public string|null $reference

Optional response field. PHP type: string|null; wire field: reference (string).

$taxCode read-only

Tax Code value for this product line item product.

public string|null $taxCode

Optional response field. PHP type: string|null; wire field: tax_code (string).

$type read-only

Discriminator identifying the value's API variant.

public string|null $type

Optional response field. PHP type: string|null; wire field: type (string).

Methods

__construct()

Hydrates a ProductLineItemProduct from decoded Inttegro API data.

public __construct(array<string, mixed> $data) : mixed
Parameters
$data : array<string, mixed>

Wire object keyed by snake_case API field names.

fromArray()

Creates a ProductLineItemProduct from its decoded API wire representation.

public static fromArray(array<string, mixed> $data) : static
Parameters
$data : array<string, mixed>

Wire object keyed by snake_case API field names.

Return values
static —

A typed, immutable ProductLineItemProduct value.

jsonSerialize()

Returns the same API wire object as `toArray()` for `json_encode()`.

public jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>

offsetExists()

Reports whether a non-null property exists for a PHP or API field name.

public offsetExists(mixed $offset) : bool

Both paymentId and payment_id address the same typed property.

Parameters
$offset : mixed

PHP camelCase or wire snake_case field name.

Return values
bool

offsetGet()

Reads a typed property through PHP `ArrayAccess`.

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed

PHP camelCase or wire snake_case field name.

Return values
mixed —

The PHP-native property value.

offsetSet()

Rejects mutation because domain values are immutable.

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed

Ignored field name.

$value : mixed

Ignored replacement value.

Tags
throws
LogicException

Always.

offsetUnset()

Rejects unsetting because domain values are immutable.

public offsetUnset(mixed $offset) : void
Parameters
$offset : mixed

Ignored field name.

Tags
throws
LogicException

Always.

toArray()

Converts typed properties back to the API's wire representation.

public toArray() : array<string, mixed>

Property names become snake_case. Nested values, arrays, backed enums, and timestamps are normalized recursively so the result is safe to pass to json_encode().

Return values
array<string, mixed> —

The recursively normalized API object.

On this page

Search results