DOCSEARCHbyAlgolia
Submit Docs

RocketShipIt Documentation

website·Indexed 31 days ago

https://docs.rocketshipit.com/rs/docs/getting-started.html

API documentation for RocketShipIt, featuring guides for shipment creation, tracking, and rating across carriers including UPS, FedEx, USPS, and DHL. Includes technical references for the PHP 1.0 environment, parameters for configuring shipments, and instructions for the RocketShipIt Print Server.

Tokens
277.4K
Snippets
947
Records
1.3K
Agent score
51%

What's inside RocketShipIt

  1. Overview of RocketShipIt Print Server

    RocketShipIt Print Server is a cross-platform web server (Windows, Mac, Linux, ARM/Raspberry Pi) that allows developers to send base64 encoded labels to thermal printers via HTTP POST. It bypasses browser security restrictions that prevent raw text communication with thermal printers. Key features include automatic printing without user interaction, support for print queues, and a heartbeat sensor to monitor printer availability from a central location.

  2. Overview of FedEx Ground Economy (SmartPost)

    FedEx Ground Economy (formerly known as FedEx SmartPost) is a hybrid shipping service where FedEx handles the long-haul transport and the U.S. Postal Service (USPS) performs the final-mile delivery. It is most cost-effective for low-weight (typically under 10 lb), low-value, non-time-sensitive residential parcels. Key characteristics include transit times of 2–7 business days, no guaranteed delivery commitment, and the ability to deliver to PO boxes (unlike standard FedEx Ground).

  3. Overview of RocketShipIt Scale Server

    The RocketShipIt Scale Server allows programmatic interaction with shipping scales via an HTTPS REST JSON API. The server uses a self-signed certificate by default, creating key.pem and cert.pem in the executable directory on start. Users can replace these with their own certificates or use mkcert for valid localhost certificates. Note that this is beta software and not all scales may be supported.

  4. Understand how Address Validation works in RocketShipIt

    Address validation is only available for addresses within the United States. All validation is processed through the United States Post Office (USPS), which serves as the backend for UPS and FedEx. Consequently, results across all three carriers are nearly identical.

    Crucially, these APIs do not provide a simple 'valid' or 'invalid' status; instead, they function as address suggestion APIs, returning alternative address suggestions and an accuracy rate.

  5. Understand Return Label characteristics

    A return label is used for non-forward shipments (shipping back to the shipper). Key characteristics include:

    • Charges are typically not applied until the label is actually used.
    • The shipper can schedule a pickup on the customer's behalf.
    • Labels cannot be voided once they have been printed.

  6. RocketShipIt system and platform requirements

    RocketShipIt has no external dependencies and does not require installation. It is compatible with almost any platform, with official support for Linux, Windows, macOS, and FreeBSD.

  7. Declare battery details for FedEx packages

    Use the batteryDetails array to provide information about batteries or cells contained in a package. Each object in the array should include:

    • batteryMaterialType: LITHIUM_METAL or LITHIUM_ION.
    • batteryPackingType: CONTAINED_IN_EQUIPMENT or PACKED_WITH_EQUIPMENT.
    • batteryRegulatoryType: e.g., IATA_SECTION_II.

  8. Use RocketShipIt to unify shipping carrier requests

    RocketShipIt provides a single API interface that abstracts the complexity of multiple shipping carriers. Instead of integrating with each carrier's unique API, you send a standardized request shape for rating, labels, tracking, or address validation. RocketShipIt translates this request into the specific format required by the carrier (e.g., UPS, FedEx, USPS, DHL) and normalizes the response back into a consistent format.

  9. Understand Return Label behavior and constraints

    Return labels (also known as Call Tags) allow customers to send items back to the original shipper. Key characteristics include:

    • Billing: You are typically not charged until the label is actually used.
    • Voiding: Return labels generally cannot be voided because they are provided to end-users who may use them at a later date.
    • Delivery: Some carriers (UPS, FedEx) can email the return label directly to the customer. Note that these emails are not sent when using the RocketShipIt test parameter set to true.
    • Availability: Return services are only available in selected countries; verify support with the specific carrier.

  10. Understand the UPS Time in Transit response structure

    The UPS Time in Transit response is returned as a nested array. Key data points include:

    • ResponseStatusCode: A value of 1 indicates success.
    • TransitResponse: Contains details about the origin (TransitFrom) and destination (TransitTo).
    • ServiceSummary: An array of available services. Each service entry includes:
      • Service -> Code and Description (e.g., 1DA for UPS Next Day Air).
      • Guaranteed: Indicates if the service is guaranteed (Y).
      • EstimatedArrival: Contains BusinessTransitDays, the estimated Date of delivery, and the DayOfWeek.

  11. Create a USPS-eVS shipping label for APO addresses

    To generate a shipping label for an APO address using USPS-eVS, use the submitshipment action. Because APO addresses are treated as international/military shipments, you must include a customs array containing details about the commodities being shipped, such as quantity, value, weight, and country of manufacture. For APO destinations, the to_state is typically set to 'AP' and to_city to 'APO'.
    {
  "carrier": "USPS-eVS",
  "action": "submitshipment",
  "params": {
    "username": "YOUR_USERNAME",
    "password": "YOUR_PASSWORD",
    "packages": [
      {
        "weight": 4.3,
        "length": 7,
        "width": 7,
        "height": 8
      }
    ],
    "customs": [
      {
        "customs_quantity_units": "EA",
        "customs_quantity": 1,
        "customs_line_amount": 50.00,
        "country_of_manufacture": "US",
        "customs_weight": 2.5,
        "customs_description": "My Description"
      }
    ],
    "service": "PRIORITY",
    "shipper": "RocketShipIt",
    "ship_contact": "John Doe",
    "ship_addr1": "123 Main St",
    "ship_city": "Whitehall",
    "ship_state": "MT",
    "ship_code": "59759",
    "ship_phone": "1231231234",
    "ship_country": "US",
    "to_name": "CPT JOHN DOE",
    "to_addr1": "PSC 556 BOX 177",
    "to_state": "AP",
    "to_city": "APO",
    "to_code": "96386",
    "to_phone": "1231231234",
    "to_country": "US",
    "image_type": "PDF",
    "test": true
  }
}

  12. Understand RocketShipIt's real-time shipment processing

    Unlike desktop shipping software (e.g., UPS WorldShip or FedEx Ship Manager) that requires an 'End-of-Day' or 'Close' step to upload batches of shipments, RocketShipIt processes shipments in real-time. Every submitshipment request is a live API call to the carrier. This means the tracking number is active, the shipment is tied to the billing account, and the driver can scan the package immediately upon pickup without any further upload steps. Similarly, voidshipment cancels shipments with the carrier immediately.