ShippingOrderLineItem
extends DomainValue
in package
Immutable shipping order-line snapshot attached to a refund.
Table of Contents
Properties
- $id : string
- Immutable order-line identifier.
- $shipping : OrderLineItemAdjustment
- Shipping label and description captured on the order.
- $type : string
- Discriminator identifying this snapshot as a shipping line.
Methods
- __construct() : mixed
- fromArray() : static
- Creates a typed value from a decoded API object.
- 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
$id read-only
Immutable order-line identifier.
public
string
$id
Required response field. PHP type: string; wire field: id (string).
$shipping read-only
Shipping label and description captured on the order.
public
OrderLineItemAdjustment
$shipping
Required response field. PHP type: OrderLineItemAdjustment; wire field: shipping (object).
$type read-only
Discriminator identifying this snapshot as a shipping line.
public
string
$type
Required response field. PHP type: string; wire field: type (string, always shipping).
Methods
__construct()
public
__construct(array<string, mixed> $data) : mixed
Parameters
- $data : array<string, mixed>
fromArray()
Creates a typed value from a decoded API object.
public
static fromArray(array<string, mixed> $data) : static
Parameters
- $data : array<string, mixed>
Return values
static —A typed, immutable domain 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
camelCaseor wiresnake_casefield name.
Return values
booloffsetGet()
Reads a typed property through PHP `ArrayAccess`.
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
-
PHP
camelCaseor wiresnake_casefield 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
offsetUnset()
Rejects unsetting because domain values are immutable.
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
-
Ignored field name.
Tags
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.