Overview

Namespaces

  • ShippoClient
    • Entity
    • Http
      • Request
        • Addresses
        • Parcels
        • Shipments
        • Transactions
      • Response
        • Exception

Classes

  • Address
  • AddressCollection
  • EntityCollection
  • Location
  • ObjectInformation
  • Parcel
  • ParcelCollection
  • Rate
  • RateCollection
  • Refund
  • RefundCollection
  • ServiceLevel
  • Shipment
  • ShipmentCollection
  • TrackingHistory
  • TrackingStatus
  • Tracks
  • Transaction
  • TransactionCollection
  • WebhookTracks
  • Overview
  • Namespace
  • Class

Class Transaction

ShippoClient\Entity\ObjectInformation uses TurmericSpice\ReadableAttributes (not available)
Extended by ShippoClient\Entity\Transaction uses TurmericSpice\ReadableAttributes (not available)
Namespace: ShippoClient\Entity
Located at Entity/Transaction.php
Methods summary
public string
# getObjectStatus( )

Indicates the status of the Transaction. - "WAITING" - "QUEUED" - "SUCCESS" - "ERROR" - "REFUNDED" - "REFUNDPENDING" - "REFUNDREJECTED"

Indicates the status of the Transaction. - "WAITING" - "QUEUED" - "SUCCESS" - "ERROR" - "REFUNDED" - "REFUNDPENDING" - "REFUNDREJECTED"

Returns

string
public boolean
# getWasTest( )

Indicates whether the transaction has been sent to the corresponding carrier's test or production server.

Indicates whether the transaction has been sent to the corresponding carrier's test or production server.

Returns

boolean
public string
# getRate( )

Rate object id.

Rate object id.

Returns

string
public string
# getTrackingNumber( )

The carrier-specific tracking number that can be used to track the Shipment. A value will only be returned if the Rate is for a trackable Shipment and if the Transactions has been processed successfully.

The carrier-specific tracking number that can be used to track the Shipment. A value will only be returned if the Rate is for a trackable Shipment and if the Transactions has been processed successfully.

Returns

string
public ShippoClient\Entity\TrackingStatus
# getTrackingStatus( )

The tracking information we currently have on file for this shipment. We regularly update this information.

The tracking information we currently have on file for this shipment. We regularly update this information.

Returns

ShippoClient\Entity\TrackingStatus
public ShippoClient\Entity\TrackingHistory
# getTrackingHistory( )

Returns

ShippoClient\Entity\TrackingHistory
public string
# getTrackingUrlProvider( )

A link to track this item on the carrier-provided tracking website. A value will only be returned if tracking is available and the carrier provides such a service.

A link to track this item on the carrier-provided tracking website. A value will only be returned if tracking is available and the carrier provides such a service.

Returns

string
public string
# getLabelUrl( )

A URL pointing directly to the label in the format you've set in your settings. A value will only be returned if the Transactions has been processed successfully.

A URL pointing directly to the label in the format you've set in your settings. A value will only be returned if the Transactions has been processed successfully.

Returns

string
public string
# getCommercialInvoiceUrl( )

A URL pointing to the commercial invoice as a 8.5x11 inch PDF file. A value will only be returned if the Transactions has been processed successfully and if the shipment is international.

A URL pointing to the commercial invoice as a 8.5x11 inch PDF file. A value will only be returned if the Transactions has been processed successfully and if the shipment is international.

Returns

string
public array
# getMessages( )

An array containing elements of the following schema: "code" (string): an identifier for the corresponding message (not always available") "message" (string): a publishable message containing further information.

An array containing elements of the following schema: "code" (string): an identifier for the corresponding message (not always available") "message" (string): a publishable message containing further information.

Returns

array
public mixed|null
# getOrder( )

Returns

mixed|null
public string
# getMetadata( )

Returns

string
public
# toArray( )
Methods inherited from ShippoClient\Entity\ObjectInformation
getObjectCreated(), getObjectUpdated()
API documentation generated by ApiGen