Overview

Namespaces

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

Classes

  • CreateObject
  • CreateObjectByNested
  • CreateReturnObject
  • Overview
  • Namespace
  • Class

Class CreateObjectByNested

The heart of the Shippo API, a Shipment is made up of "to" and "from" Address and the Parcel to be shipped. Once created, a Shipment object can be used to retrieve shipping Rates and purchase a shipping Label.

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

ID of the Address object that should be used as sender Address.

ID of the Address object that should be used as sender Address.

Required

Returns

string

Throws

InvalidAttributeException

Overrides

ShippoClient\Http\Request\Shipments\CreateObject::getAddressFrom()
public string
# getAddressTo( )

ID of the Address object that should be used as recipient Address.

ID of the Address object that should be used as recipient Address.

Required

Returns

string

Throws

InvalidAttributeException

Overrides

ShippoClient\Http\Request\Shipments\CreateObject::getAddressTo()
public string
# getParcel( )

ID of the Parcel object to be shipped.

ID of the Parcel object to be shipped.

Required

Returns

string

Throws

InvalidAttributeException

Overrides

ShippoClient\Http\Request\Shipments\CreateObject::getParcel()
Methods inherited from ShippoClient\Http\Request\Shipments\CreateObject
getAddressReturn(), getCarrierAccounts(), getCustomsDeclaration(), getExtra(), getInsuranceAmount(), getInsuranceCurrency(), getObjectPurpose(), getReference1(), getReference2(), getReturnOf(), getSubmissionDate(), getSubmissionType(), toArray()
Methods inherited from ShippoClient\Http\Request\CommonParameter
getMetadata()
Constants inherited from ShippoClient\Http\Request\Shipments\CreateObject
OBJECT_PURPOSE_PURCHASE, OBJECT_PURPOSE_QUOTE, SUBMISSION_TYPE_DROPOFF, SUBMISSION_TYPE_PICKUP
API documentation generated by ApiGen