Overview

Namespaces

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

Classes

  • ShippoClient\Addresses
  • ShippoClient\Entity\Address
  • ShippoClient\Entity\AddressCollection
  • ShippoClient\Entity\EntityCollection
  • ShippoClient\Entity\Location
  • ShippoClient\Entity\ObjectInformation
  • ShippoClient\Entity\Parcel
  • ShippoClient\Entity\ParcelCollection
  • ShippoClient\Entity\Rate
  • ShippoClient\Entity\RateCollection
  • ShippoClient\Entity\Refund
  • ShippoClient\Entity\RefundCollection
  • ShippoClient\Entity\ServiceLevel
  • ShippoClient\Entity\Shipment
  • ShippoClient\Entity\ShipmentCollection
  • ShippoClient\Entity\TrackingHistory
  • ShippoClient\Entity\TrackingStatus
  • ShippoClient\Entity\Tracks
  • ShippoClient\Entity\Transaction
  • ShippoClient\Entity\TransactionCollection
  • ShippoClient\Entity\WebhookTracks
  • ShippoClient\Http\Request
  • ShippoClient\Http\Request\Addresses\CreateObject
  • ShippoClient\Http\Request\CommonParameter
  • ShippoClient\Http\Request\MockCollection
  • ShippoClient\Http\Request\Parcels\CreateObject
  • ShippoClient\Http\Request\Shipments\CreateObject
  • ShippoClient\Http\Request\Shipments\CreateObjectByNested
  • ShippoClient\Http\Request\Shipments\CreateReturnObject
  • ShippoClient\Http\Request\Transactions\CreateObject
  • ShippoClient\Http\Response\AddressList
  • ShippoClient\Http\Response\ListResponse
  • ShippoClient\Http\Response\ParcelList
  • ShippoClient\Http\Response\RateList
  • ShippoClient\Http\Response\RefundList
  • ShippoClient\Http\Response\ShipmentList
  • ShippoClient\Http\Response\TransactionList
  • ShippoClient\Parcels
  • ShippoClient\Rates
  • ShippoClient\Refunds
  • ShippoClient\Shipments
  • ShippoClient\ShippoClient
  • ShippoClient\Tracks
  • ShippoClient\Transactions

Exceptions

  • ShippoClient\Http\Response\Exception\BadResponseException
  • ShippoClient\Http\Response\Exception\ClientErrorException
  • ShippoClient\Http\Response\Exception\ServerErrorException
  • Overview
  • Namespace
  • Class
 1: <?php
 2: 
 3: namespace ShippoClient;
 4: 
 5: use ShippoClient\Entity\Parcel;
 6: use ShippoClient\Http\Request;
 7: use ShippoClient\Http\Request\Parcels\CreateObject;
 8: use ShippoClient\Http\Response\ParcelList;
 9: 
10: class Parcels
11: {
12:     private $request;
13: 
14:     public function __construct(Request $request)
15:     {
16:         $this->request = $request;
17:     }
18: 
19:     public function create(array $attributes)
20:     {
21:         $createObj = new CreateObject($attributes);
22:         $responseArray = $this->request->post('parcels', $createObj->toArray());
23: 
24:         return new Parcel($responseArray);
25:     }
26: 
27:     public function retrieve($objectId)
28:     {
29:         $responseArray = $this->request->get("parcels/$objectId");
30: 
31:         return new Parcel($responseArray);
32:     }
33: 
34:     /**
35:      * @param null|int $results
36:      * @return ParcelList
37:      */
38:     public function getList($results = null)
39:     {
40:         $responseArray = $this->request->get("parcels", ['results' => $results]);
41: 
42:         return new ParcelList($responseArray);
43:     }
44: }
45: 
API documentation generated by ApiGen