Class: Peddler::APIs::Tracking20260130

Inherits:
Peddler::API show all
Defined in:
lib/peddler/apis/tracking_2026_01_30.rb,
lib/peddler/apis/tracking_2026_01_30/error.rb,
lib/peddler/apis/tracking_2026_01_30/error_list.rb,
lib/peddler/apis/tracking_2026_01_30/tracking_detail.rb,
lib/peddler/apis/tracking_2026_01_30/bounded_interval.rb,
lib/peddler/apis/tracking_2026_01_30/carrier_tracking.rb,
lib/peddler/apis/tracking_2026_01_30/tracking_estimate.rb,
lib/peddler/apis/tracking_2026_01_30/tracking_milestone.rb,
lib/peddler/apis/tracking_2026_01_30/tracking_identifier.rb,
lib/peddler/apis/tracking_2026_01_30/tracking_milestone_status.rb,
lib/peddler/apis/tracking_2026_01_30/tracking_milestone_address.rb,
lib/peddler/apis/tracking_2026_01_30/tracking_milestone_location.rb,
lib/peddler/apis/tracking_2026_01_30/get_shipment_tracking_response.rb,
sig/peddler/apis/tracking_2026_01_30.rbs

Overview

The Selling Partner API for tracking services provided by Amazon.

The Tracking Selling Partner API allows users to track shipments to and from Amazon-owned storage warehouses, fulfillment centers, and external warehouses.

See Also:

Defined Under Namespace

Classes: BoundedInterval, CarrierTracking, Error, ErrorList, GetShipmentTrackingResponse, TrackingDetail, TrackingEstimate, TrackingIdentifier, TrackingMilestone, TrackingMilestoneAddress, TrackingMilestoneLocation, TrackingMilestoneStatus

Constant Summary

Constants inherited from Peddler::API

Peddler::API::TRANSIENT_STATUSES

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #base_url, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #host_header, #http, #initialize, #must_sandbox!, #parse_base_url, #patch, #percent_encode, #post, #put, #request, #sandbox, #sandbox?, #stringify_array, #timestamp, #user_agent

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#get_shipment_tracking(id: nil, acsin: nil, aftn: nil, container_number: nil, house_bill_of_lading_number: nil, carrier_tracking_tracking_number: nil, carrier_tracking_carrier_code: nil, accept_language: nil) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns tracking information for a shipment.

Parameters:

  • id (String) (defaults to: nil) —

    The unique tracking request identifier.

  • acsin (String) (defaults to: nil) —

    The Air Cargo Shipment Identification Number.

  • aftn (String) (defaults to: nil) —

    The Amazon Fulfillment Tracking Number.

  • container_number (String) (defaults to: nil) —

    The container number provided by the Logistics Service Provider.

  • house_bill_of_lading_number (String) (defaults to: nil) —

    The House Bill of Lading (HBL) number.

  • carrier_tracking_tracking_number (String) (defaults to: nil) —

    The tracking number assigned by the carrier.

  • carrier_tracking_carrier_code (String) (defaults to: nil) —

    The carrier code associated with the carrier tracking number.

  • accept_language (String) (defaults to: nil) —

    The preferred natural language and locale of the client, in POSIX locale format. Currently supports en-US only.

  • id: (String, nil) (defaults to: nil)
  • acsin: (String, nil) (defaults to: nil)
  • aftn: (String, nil) (defaults to: nil)
  • container_number: (String, nil) (defaults to: nil)
  • house_bill_of_lading_number: (String, nil) (defaults to: nil)
  • carrier_tracking_tracking_number: (String, nil) (defaults to: nil)
  • carrier_tracking_carrier_code: (String, nil) (defaults to: nil)
  • accept_language: (String, nil) (defaults to: nil)

Returns:



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/peddler/apis/tracking_2026_01_30.rb', line 27

def get_shipment_tracking(id: nil, acsin: nil, aftn: nil, container_number: nil, house_bill_of_lading_number: nil,
  carrier_tracking_tracking_number: nil, carrier_tracking_carrier_code: nil, accept_language: nil)
  path = "/tracking/2026-01-30/shipments/track"
  params = {
    "id" => id,
    "acsin" => acsin,
    "aftn" => aftn,
    "containerNumber" => container_number,
    "houseBillOfLadingNumber" => house_bill_of_lading_number,
    "carrierTracking.trackingNumber" => carrier_tracking_tracking_number,
    "carrierTracking.carrierCode" => carrier_tracking_carrier_code,
  }.compact
  parser = -> { GetShipmentTrackingResponse }
  get(path, params:, parser:)
end