API Documentation
Back to top  

GXParcelTrackingCode

Class GXParcelTrackingCode

package

Default

Methods

OrderParcelTrackingCode constructor.

__construct()

Private to enforce usage of named constructors.

Returns the tracking code comment.par

comment() : \ParcelTrackingCodeComment

Response

\ParcelTrackingCodeComment

Creates a new order parcel tracking code entity.

create(\ParcelTrackingCodeServiceId $parcelServiceId, \ParcelTrackingCodeOrderId $orderId, \OrderParcelTrackingCode $trackingCode, \ParcelTrackingCodeLanguageId $languageId) : \GXParcelTrackingCode
static

This entity version will fetch the corresponding data from related tables.

Arguments

$parcelServiceId

\ParcelTrackingCodeServiceId

Id of related parcel service.

$orderId

\ParcelTrackingCodeOrderId

Id of related order.

$trackingCode

\OrderParcelTrackingCode

Tracking code for order.

$languageId

\ParcelTrackingCodeLanguageId

Language id (for language specific comment).

Response

\GXParcelTrackingCode

New instance.

Creates a new order parcel tracking code entity.

createLightweight(\ParcelTrackingCodeOrderId $orderId, \ParcelTrackingCodeServiceName $name, \ParcelTrackingCodeUrl $url, \ParcelTrackingCodeComment|null $comment = null) : \GXParcelTrackingCode
static

The lightweight version renounce on related data.

Arguments

$orderId

\ParcelTrackingCodeOrderId

Id of related order.

$name

\ParcelTrackingCodeServiceName

Name of parcel service-

$url

\ParcelTrackingCodeUrl

Tracking code url.

$comment

\ParcelTrackingCodeComment|null

Comment of tracking code for order.

Response

\GXParcelTrackingCode

New instance.

isLightweight

isLightweight()

Returns the language id.

languageId() : \ParcelTrackingCodeLanguageId

Response

\ParcelTrackingCodeLanguageId

Returns the order id.

orderId() : \ParcelTrackingCodeOrderId

Response

\ParcelTrackingCodeOrderId

Returns the parcels service id.

parcelServiceId() : \ParcelTrackingCodeServiceId

Response

\ParcelTrackingCodeServiceId

Returns the name of the parcel service name.

parcelServiceName() : \ParcelTrackingCodeServiceName

Response

\ParcelTrackingCodeServiceName

Returns the tracking code.

trackingCode() : \OrderParcelTrackingCode

Response

\OrderParcelTrackingCode

Returns the tracking code url.

url() : \ParcelTrackingCodeUrl

Response

\ParcelTrackingCodeUrl

Properties

parcelServiceId

parcelServiceId : \ParcelTrackingCodeServiceId
var

Type(s)

\ParcelTrackingCodeServiceId

orderId

orderId : \ParcelTrackingCodeOrderId
var

Type(s)

\ParcelTrackingCodeOrderId

trackingCode

trackingCode : \OrderParcelTrackingCode
var

Type(s)

\OrderParcelTrackingCode

languageId

languageId : \ParcelTrackingCodeLanguageId
var

Type(s)

\ParcelTrackingCodeLanguageId

isLightweight

isLightweight : boolean
var

Type(s)

boolean

name

name : \ParcelTrackingCodeServiceName
var

Type(s)

\ParcelTrackingCodeServiceName

url

url : \ParcelTrackingCodeUrl
var

Type(s)

\ParcelTrackingCodeUrl

comment

comment : \ParcelTrackingCodeComment
var

Type(s)

\ParcelTrackingCodeComment