shipcloud PHP Client

ApiClient

in package

• shipcloud
• phpclient

ApiClient class that encapsulates request methods for shipcloud API.

Tags

category

Class

author

Daniel Muenter info@msltns.com

version

0.0.1

since

0.0.1

license

GPL 3 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 3, as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Table of Contents

$max_redirects  : int

Maximum number of redirects.

$request_timeout  : int

Timeout for requests.

$affiliate_id  : string

Affiliate ID.

$api_key  : string

Key of the customer to access the API.

$base_url  : string

URL to the API.

$logger  : Logger

Logger.

__construct()  : void

ApiClient constructor.

address_exists()  : array<string|int, mixed>

Checks a given array of addresses if a certain address exists filtered by certain criteria.

create_address()  : array<string|int, mixed>

This method is to create an address. It forces a validation against required fields before sending the request to API.

create_pickup_request()  : array<string|int, mixed>|bool

There are two ways you can request shipments to be picked up by a specific carrier. By simply stating that all shipments that haven't been picked up already should be picked up or by specifying which shipments should by picked up.

create_shipment()  : array<string|int, mixed>

This method is to create a shipment.

create_shipment_quote()  : array<string|int, mixed>|bool

With this call you can find out how much we will charge you for a specific shipment.

create_tracker()  : array<string|int, mixed>|bool

If you want to create a tracker, this is the way to go.

create_webhook()  : array<string|int, mixed>|bool

If you want to create a webhook, this is the way to go.

delete_shipment()  : array<string|int, mixed>|bool

This method is to delete an existing shipment.

delete_webhook()  : array<string|int, mixed>|bool

This method is to delete an existing webhook.

get_address()  : array<string|int, mixed>

If you want to obtain a certain address, this is the way to go.

get_addresses()  : array<string|int, mixed>

If you want to obtain a list of addresses, this is the way to go.

get_carriers()  : array<string|int, mixed>

Get all carriers available for your account.

get_default_returns_address()  : array<string|int, mixed>

This is the default address that will be used for returns shipments when no address was specified using the 'to' attribute.

get_default_shipping_address()  : array<string|int, mixed>

This is the default address that will be used for shipments when no address was specified using the 'from' attribute.

get_invoice_address()  : array<string|int, mixed>

This is the address that a user has specified as being their invoice address.

get_me()  : array<string|int, mixed>

If you need more details about the current user that is making a request, you can get it by querying the /me endpoint.

get_pickup_request()  : array<string|int, mixed>|bool

Getting information about a certain pickup request.

get_pickup_requests()  : array<string|int, mixed>

Getting a list of pickup requests.

get_shipment()  : array<string|int, mixed>

If you want to obtain a certain shipment, this is the way to go.

get_shipments()  : array<string|int, mixed>

If you want to obtain a list of shipments, this is the way to go.

get_shipping_rate()  : array<string|int, mixed>|bool

With this call you can find out how much we will charge you for a specific shipment.

get_tracker()  : array<string|int, mixed>|bool

Getting information about a certain tracker.

get_trackers()  : array<string|int, mixed>

Getting a list of trackers.

get_webhook()  : array<string|int, mixed>|bool

Getting information about a certain webhook.

get_webhooks()  : array<string|int, mixed>

Getting a list of webhooks.

log()  : void

Output a debug message.

update_shipment()  : array<string|int, mixed>

This method is to update an existing shipment.

delete()  : array<string|int, mixed>

DELETE request.

get()  : array<string|int, mixed>

GET request.

post()  : array<string|int, mixed>

POST request.

put()  : array<string|int, mixed>

PUT request.

request()  : array<string|int, mixed>

The actual request function.

shipment_is_editable()  : bool

Precheck before updating a shipment.

validate_address()  : bool

Validates an array of address data.

validate_api_key()  : bool

Validates an id.

validate_carrier()  : bool

Validates a carrier string.

validate_country()  : bool

Validates a country string.

validate_id()  : bool

Validates an id.

validate_pickup()  : bool

Validates pickup data. It throws an ApiException if the validation fails. A message with concrete details is given then.

validate_shipment()  : bool

Validates shipment data. It throws an ApiException if the validation fails. A message with concrete details is given then.

validate_tracker()  : bool

Validates tracker data. It throws an ApiException if the validation fails. A message with concrete details is given then.

validate_webhook()  : bool

Validates webhook data. It throws an ApiException if the validation fails. A message with concrete details is given then.

Response:
{
  "id": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
  "carrier_tracking_no": "84168117830018",
  "tracking_url": "https://track.shipcloud.io/3a186c51d4",
  "label_url": "https://shipping-labels.shipcloud.io/shipments/01370b4d/199f803bf8/label/shipping_label_199f803bf8.pdf",
  "price": 3.4
}

NOTE:
Prepared shipments (create_shipping_label is false) can be deleted
at any time, because no transaction with the carrier has happened
until this point and no actual shipping label has been created. In
case you've created a shipping label you can delete it before the
cutoff time of the carrier. Cutoff times differ from carrier to
carrier and are some time between 5pm and 8pm.

carrier, e.g. 'carrier=dhl'
carrier_tracking_no, e.g. 'carrier_tracking_no=43128000105'
created_at_gt, e.g. 'created_at_gt=20180712T1300Z'
created_at_lt, e.g. 'created_at_lt=20180712T1400Z'
page, show page number x, e.g. 'page=2'
per_page, show x number of shipments on a page (default & max: 100), e.g. 'per_page=25'
reference_number, e.g. 'reference_number=ref123456'
service, e.g. 'service=returns'
shipcloud_tracking_no, e.g. 'shipcloud_tracking_no=86afb143f9c9c0cfd4eb7a7c26a5c616585a6271'
shipment_type, e.g. 'shipment_type=prepared'
source, e.g. 'source=api'
tracking_status, e.g. 'tracking_status=out_for_delivery'
tracking_status_not, e.g. 'tracking_status_not=delivered'

shipment_type: Specifies the type of a shipment. The following types are available:

prepared: a shipment which was saved in shipcloud but doesn't have a shipping label yet
label_created: a shipment containing a shipping label.
tracking_only: a shipment that was imported via its carrier tracking number (see trackers for more details)

created_at_gt / created_at_lt: You can filter the list by using these parameters to specify a timerange to
find the shipments that were created during this time. The timestamp will be evaluated as ISO 8601 using the
following format: YYYYMMDDThhmmZ.

source: Filter shipments by platform they were created through. The following keys can be used:

api: a shipment created through our api
webui: a shipment created using the shipcloud ui
return_portal: a shipment created using the shipcloud return portal

Response:
{
  "id": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
  "carrier_tracking_no": "84168117830018",
  "tracking_url": "https://track.shipcloud.io/3a186c51d4",
  "label_url": "https://shipping-labels.shipcloud.io/shipments/01370b4d/199f803bf8/label/shipping_label_199f803bf8.pdf",
  "price": 3.4
}