Overview

Namespaces

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

Classes

  • CreateObject
  • Overview
  • Namespace
  • Class

Class CreateObject

A Transaction is the purchase of a Shipment Label for a given Shipment Rate. Transactions can be as simple as posting a Rate ID, but also allow you to define further parameters of the desired Label, such as pickup and notifications. Transactions can only be created for Rates that are less than 7 days old and that have an object_purpose of "PURCHASE". Transactions are created asynchronous. The response time depends exclusively on the carrier's server.

ShippoClient\Http\Request\CommonParameter uses TurmericSpice\ReadWriteAttributes (not available)
Extended by ShippoClient\Http\Request\Transactions\CreateObject
Namespace: ShippoClient\Http\Request\Transactions
Located at Http/Request/Transactions/CreateObject.php
Methods summary
public string
# getRate( )

ID of the Rate object for which a Label has to be obtained. Please note that only rates that are not older than 7 days can be purchased in order to ensure up-to-date pricing.

ID of the Rate object for which a Label has to be obtained. Please note that only rates that are not older than 7 days can be purchased in order to ensure up-to-date pricing.

Returns

string

Throws

TurmericSpice\Container\InvalidAttributeException
Methods inherited from ShippoClient\Http\Request\CommonParameter
getMetadata()
API documentation generated by ApiGen