Module: PaypalAPI::ShipmentTracking::APIs

Included in:

PaypalAPI::ShipmentTracking, PaypalAPI::ShipmentTracking

Defined in:

lib/paypal-api/api_collections/shipment_tracking.rb

Overview

Common methods for PaypalAPI::ShipmentTracking class and client.shipment_tracking instance

Instance Method Summary

• #add(query: nil, body: nil, headers: nil) ⇒ Response

  Add tracking information for multiple PayPal transactions.

• #show(id, query: nil, body: nil, headers: nil) ⇒ Response

  Shows tracking information, by tracker ID, for a PayPal transaction.

• #update(id, query: nil, body: nil, headers: nil) ⇒ Response

  Update or cancel tracking information for PayPal transaction.

Instance Method Details

#add(query: nil, body: nil, headers: nil) ⇒ Response

Add tracking information for multiple PayPal transactions

Parameters:

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/tracking/v1/#trackers-batch_post

# File 'lib/paypal-api/api_collections/shipment_tracking.rb', line 27

def add(query: nil, body: nil, headers: nil)
  client.post("/v1/shipping/trackers-batch", query: query, body: body, headers: headers)
end

#show(id, query: nil, body: nil, headers: nil) ⇒ Response

Shows tracking information, by tracker ID, for a PayPal transaction.

Parameters:

• id (String) —

  Order ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/tracking/v1/#trackers_get

# File 'lib/paypal-api/api_collections/shipment_tracking.rb', line 51

def show(id, query: nil, body: nil, headers: nil)
  client.get("/v1/shipping/trackers/#{encode(id)}", query: query, body: body, headers: headers)
end

#update(id, query: nil, body: nil, headers: nil) ⇒ Response

Update or cancel tracking information for PayPal transaction

Parameters:

• id (String) —

  Tracker ID

• query (Hash, nil) (defaults to: nil) —

  Request query parameters

• body (Hash, nil) (defaults to: nil) —

  Request body parameters

• headers (Hash, nil) (defaults to: nil) —

  Request headers

Returns:

• (Response) —

  Response object

See Also:

• https://developer.paypal.com/docs/api/tracking/v1/#trackers_put

# File 'lib/paypal-api/api_collections/shipment_tracking.rb', line 39

def update(id, query: nil, body: nil, headers: nil)
  client.put("/v1/shipping/trackers/#{encode(id)}", query: query, body: body, headers: headers)
end