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 Rate

Each valid Shipment object will automatically trigger the calculation of all available Rates. Depending on your Addresses and Parcel, there may be none, one or multiple Rates.

By default, the calculated Rates will return the price in two currencies under the "amount" and "amount_local" keys, respectively. The "amount" key will contain the price of a Rate expressed in the currency that is used in the country from which Parcel originates, and the "amount_local" key will contain the price expressed in the currency that is used in the country the Parcel is shipped to. You can request Rates with prices expressed in a different currency by adding the desired currency code in the end of the resource URL. The full list of supported currencies along with their codes can be viewed on open exchange rates.

Rates are created asynchronously. The response time depends exclusively on the carrier's server.

ShippoClient\Entity\ObjectInformation uses TurmericSpice\ReadableAttributes (not available)
Extended by ShippoClient\Entity\Rate uses TurmericSpice\ReadableAttributes (not available)
Namespace: ShippoClient\Entity
Located at Entity/Rate.php
Methods summary
public mixed|null
# getAvailableShippo( )

Description is not found in Shippo API doc, but this key is returned in fact.

Description is not found in Shippo API doc, but this key is returned in fact.

Returns

mixed|null
public mixed|null
# getOutboundEndpoint( )

Description is not found in Shippo API doc, but this key is returned in fact.

Description is not found in Shippo API doc, but this key is returned in fact.

Returns

mixed|null
public mixed|null
# getInboundEndpoint( )

Description is not found in Shippo API doc, but this key is returned in fact.

Description is not found in Shippo API doc, but this key is returned in fact.

Returns

mixed|null
public mixed|null
# getArrivesBy( )

Description is not found in Shippo API doc, but this key is returned in fact.

Description is not found in Shippo API doc, but this key is returned in fact.

Returns

mixed|null
public mixed|null
# getDeliveryAttempts( )

Description is not found in Shippo API doc, but this key is returned in fact.

Description is not found in Shippo API doc, but this key is returned in fact.

Returns

mixed|null
Methods inherited from ShippoClient\Entity\ObjectInformation
getObjectCreated(), getObjectUpdated()
API documentation generated by ApiGen