impl

Documentation

Index

• type AfterShipApiV4Impl
  • func (api *AfterShipApiV4Impl) AddNotification(id apiV4.TrackingId, notification apiV4.NotificationSetting) (apiV4.NotificationSetting, apiV4.AfterShipApiError)
  • func (api *AfterShipApiV4Impl) CreateTracking(newTracking apiV4.NewTracking) (apiV4.Tracking, apiV4.AfterShipApiError)
  • func (api *AfterShipApiV4Impl) DeleteTracking(id apiV4.TrackingId) (apiV4.DeletedTracking, apiV4.AfterShipApiError)
  • func (api *AfterShipApiV4Impl) DetectCouriers(params apiV4.CourierDetectParam) ([]apiV4.Courier, apiV4.AfterShipApiError)
  • func (api *AfterShipApiV4Impl) GetAllCouriers() ([]apiV4.Courier, apiV4.AfterShipApiError)
  • func (api *AfterShipApiV4Impl) GetCouriers() ([]apiV4.Courier, apiV4.AfterShipApiError)
  • func (api *AfterShipApiV4Impl) GetLastCheckPoint(id apiV4.TrackingId, fields string, lang string) (apiV4.LastCheckPoint, apiV4.AfterShipApiError)
  • func (api *AfterShipApiV4Impl) GetNotificationSetting(id apiV4.TrackingId, fields string) (apiV4.NotificationSetting, apiV4.AfterShipApiError)
  • func (api *AfterShipApiV4Impl) GetTracking(id apiV4.TrackingId, fields string, lang string) (apiV4.Tracking, apiV4.AfterShipApiError)
  • func (api *AfterShipApiV4Impl) GetTrackings(params apiV4.GetTrackingsParams) (apiV4.TrackingsData, apiV4.AfterShipApiError)
  • func (api *AfterShipApiV4Impl) GetTrackingsExport(params apiV4.GetTrackingsParams) (apiV4.TrackingsData, apiV4.AfterShipApiError)
  • func (api *AfterShipApiV4Impl) ReTrack(id apiV4.TrackingId) (apiV4.Tracking, apiV4.AfterShipApiError)
  • func (api *AfterShipApiV4Impl) RemoveNotification(id apiV4.TrackingId, notification apiV4.NotificationSetting) (apiV4.NotificationSetting, apiV4.AfterShipApiError)
  • func (api *AfterShipApiV4Impl) UpdateTracking(id apiV4.TrackingId, update apiV4.TrackingUpdate) (apiV4.Tracking, apiV4.AfterShipApiError)

Types

type AfterShipApiV4Impl

type AfterShipApiV4Impl struct {
	ApiKey      string
	RetryPolicy *apiV4.RetryPolicy
	Client      *http.Client
}

func (*AfterShipApiV4Impl) AddNotification

func (api *AfterShipApiV4Impl) AddNotification(id apiV4.TrackingId,
	notification apiV4.NotificationSetting) (apiV4.NotificationSetting, apiV4.AfterShipApiError)

AddNotification Adds notifications to a tracking number.

func (*AfterShipApiV4Impl) CreateTracking

func (api *AfterShipApiV4Impl) CreateTracking(newTracking apiV4.NewTracking) (apiV4.Tracking, apiV4.AfterShipApiError)

CreateTracking creates a new tracking

func (*AfterShipApiV4Impl) DeleteTracking

func (api *AfterShipApiV4Impl) DeleteTracking(id apiV4.TrackingId) (apiV4.DeletedTracking, apiV4.AfterShipApiError)

DeleteTracking Deletes a tracking.

func (*AfterShipApiV4Impl) DetectCouriers

func (api *AfterShipApiV4Impl) DetectCouriers(params apiV4.CourierDetectParam) ([]apiV4.Courier, apiV4.AfterShipApiError)

DetectCouriers returns a list of matched couriers based on tracking number format and selected couriers or a list of couriers.

func (*AfterShipApiV4Impl) GetAllCouriers

func (api *AfterShipApiV4Impl) GetAllCouriers() ([]apiV4.Courier, apiV4.AfterShipApiError)

GetAll returns a list of all couriers.

func (*AfterShipApiV4Impl) GetCouriers

func (api *AfterShipApiV4Impl) GetCouriers() ([]apiV4.Courier, apiV4.AfterShipApiError)

GetCouriers returns a list of couriers activated at your AfterShip account.

func (*AfterShipApiV4Impl) GetLastCheckPoint

func (api *AfterShipApiV4Impl) GetLastCheckPoint(id apiV4.TrackingId, fields string,
	lang string) (apiV4.LastCheckPoint, apiV4.AfterShipApiError)

LastCheckPoint Return the tracking information of the last checkpoint of a single tracking.

func (*AfterShipApiV4Impl) GetNotificationSetting

func (api *AfterShipApiV4Impl) GetNotificationSetting(id apiV4.TrackingId, fields string) (apiV4.NotificationSetting,
	apiV4.AfterShipApiError)

GetNotificationSetting Gets notifications value from a tracking number.

func (*AfterShipApiV4Impl) GetTracking

func (api *AfterShipApiV4Impl) GetTracking(id apiV4.TrackingId, fields string, lang string) (apiV4.Tracking, apiV4.AfterShipApiError)

GetTracking Gets tracking results of a single tracking.

func (*AfterShipApiV4Impl) GetTrackings

func (api *AfterShipApiV4Impl) GetTrackings(params apiV4.GetTrackingsParams) (apiV4.TrackingsData, apiV4.AfterShipApiError)

GetTrackings Gets tracking results of multiple trackings.

func (*AfterShipApiV4Impl) GetTrackingsExport

func (api *AfterShipApiV4Impl) GetTrackingsExport(params apiV4.GetTrackingsParams) (apiV4.TrackingsData, apiV4.AfterShipApiError)

GetTrackingsExport Gets all trackings results (for backup or analytics purpose)

func (*AfterShipApiV4Impl) ReTrack

func (api *AfterShipApiV4Impl) ReTrack(id apiV4.TrackingId) (apiV4.Tracking, apiV4.AfterShipApiError)

ReTrack an expired tracking once. Max. 3 times per tracking.

func (*AfterShipApiV4Impl) RemoveNotification

func (api *AfterShipApiV4Impl) RemoveNotification(id apiV4.TrackingId,
	notification apiV4.NotificationSetting) (apiV4.NotificationSetting, apiV4.AfterShipApiError)

RemoveNotification Removes notifications from a tracking number.

func (*AfterShipApiV4Impl) UpdateTracking

func (api *AfterShipApiV4Impl) UpdateTracking(id apiV4.TrackingId, update apiV4.TrackingUpdate) (apiV4.Tracking, apiV4.AfterShipApiError)

UpdateTracking Updates a tracking.