All API Examples

UPS - Label Return w/ Email Delivery

Carrier: UPS
Action: Label Return w/ Email Delivery
Description: Example implementation for UPS Label Return w/ Email Delivery 
{
  "carrier": "UPS",
  "action": "SubmitShipment",
  "params": {
    "account_number": "YOUR_ACCOUNT_NUMBER",
    "key": "YOUR_UPS_KEY",
    "username": "YOUR_USERNAME",
    "password": "YOUR_PASSWORD",
    "return_code": "8",
    "notify": [
      {
        "type": "RETURN",
        "email": "bob@email.com",
        "undeliverable_email": "foo@bar.com",
        "from_email": "blah@email.com",
        "from_name": "John Doe"
      }
    ],
    "packages": [
      {
        "weight": 4
      }
    ],
    "service": "03",
    "shipper": "RocketShipIt",
    "ship_addr1": "123 Main St",
    "ship_city": "Whitehall",
    "ship_state": "MT",
    "ship_code": "59759",
    "ship_phone": "1231231234",
    "ship_country": "US",
    "to_name": "John Doe",
    "to_addr1": "940 Presidio Ave",
    "to_addr2": "#103",
    "to_state": "CA",
    "to_city": "San Francisco",
    "to_code": "94115",
    "to_country": "US",
    "image_type": "GIF",
    "from_company": "RocketShipIt",
    "from_name": "Mark Sanborn",
    "from_addr1": "940 Presidio Ave",
    "from_addr2": "#103",
    "from_city": "San Francisco",
    "from_state": "CA",
    "from_code": "94115",
    "test": true
  }
}

<?php
$rs = new RocketShipIt;
$response = $rs->request(
array (
  'carrier' => 'UPS',
  'action' => 'SubmitShipment',
  'params' => 
  array (
    'account_number' => 'YOUR_ACCOUNT_NUMBER',
    'key' => 'YOUR_UPS_KEY',
    'username' => 'YOUR_USERNAME',
    'password' => 'YOUR_PASSWORD',
    'return_code' => '8',
    'notify' => 
    array (
      0 => 
      array (
        'type' => 'RETURN',
        'email' => 'bob@email.com',
        'undeliverable_email' => 'foo@bar.com',
        'from_email' => 'blah@email.com',
        'from_name' => 'John Doe',
      ),
    ),
    'packages' => 
    array (
      0 => 
      array (
        'weight' => 4,
      ),
    ),
    'service' => '03',
    'shipper' => 'RocketShipIt',
    'ship_addr1' => '123 Main St',
    'ship_city' => 'Whitehall',
    'ship_state' => 'MT',
    'ship_code' => '59759',
    'ship_phone' => '1231231234',
    'ship_country' => 'US',
    'to_name' => 'John Doe',
    'to_addr1' => '940 Presidio Ave',
    'to_addr2' => '#103',
    'to_state' => 'CA',
    'to_city' => 'San Francisco',
    'to_code' => '94115',
    'to_country' => 'US',
    'image_type' => 'GIF',
    'from_company' => 'RocketShipIt',
    'from_name' => 'Mark Sanborn',
    'from_addr1' => '940 Presidio Ave',
    'from_addr2' => '#103',
    'from_city' => 'San Francisco',
    'from_state' => 'CA',
    'from_code' => '94115',
    'test' => true,
  ),
)
);


rs.request(
  {'action': 'SubmitShipment',
 'carrier': 'UPS',
 'params': {'account_number': 'YOUR_ACCOUNT_NUMBER',
            'from_addr1': '940 Presidio Ave',
            'from_addr2': '#103',
            'from_city': 'San Francisco',
            'from_code': '94115',
            'from_company': 'RocketShipIt',
            'from_name': 'Mark Sanborn',
            'from_state': 'CA',
            'image_type': 'GIF',
            'key': 'YOUR_UPS_KEY',
            'notify': [{'email': 'bob@email.com',
                        'from_email': 'blah@email.com',
                        'from_name': 'John Doe',
                        'type': 'RETURN',
                        'undeliverable_email': 'foo@bar.com'}],
            'packages': [{'weight': 4}],
            'password': 'YOUR_PASSWORD',
            'return_code': '8',
            'service': '03',
            'ship_addr1': '123 Main St',
            'ship_city': 'Whitehall',
            'ship_code': '59759',
            'ship_country': 'US',
            'ship_phone': '1231231234',
            'ship_state': 'MT',
            'shipper': 'RocketShipIt',
            'test': True,
            'to_addr1': '940 Presidio Ave',
            'to_addr2': '#103',
            'to_city': 'San Francisco',
            'to_code': '94115',
            'to_country': 'US',
            'to_name': 'John Doe',
            'to_state': 'CA',
            'username': 'YOUR_USERNAME'}}

)


rs.request(
  {"carrier"=>"UPS",
 "action"=>"SubmitShipment",
 "params"=>
  {"account_number"=>"YOUR_ACCOUNT_NUMBER",
   "key"=>"YOUR_UPS_KEY",
   "username"=>"YOUR_USERNAME",
   "password"=>"YOUR_PASSWORD",
   "return_code"=>"8",
   "notify"=>
    [{"type"=>"RETURN",
      "email"=>"bob@email.com",
      "undeliverable_email"=>"foo@bar.com",
      "from_email"=>"blah@email.com",
      "from_name"=>"John Doe"}],
   "packages"=>[{"weight"=>4}],
   "service"=>"03",
   "shipper"=>"RocketShipIt",
   "ship_addr1"=>"123 Main St",
   "ship_city"=>"Whitehall",
   "ship_state"=>"MT",
   "ship_code"=>"59759",
   "ship_phone"=>"1231231234",
   "ship_country"=>"US",
   "to_name"=>"John Doe",
   "to_addr1"=>"940 Presidio Ave",
   "to_addr2"=>"#103",
   "to_state"=>"CA",
   "to_city"=>"San Francisco",
   "to_code"=>"94115",
   "to_country"=>"US",
   "image_type"=>"GIF",
   "from_company"=>"RocketShipIt",
   "from_name"=>"Mark Sanborn",
   "from_addr1"=>"940 Presidio Ave",
   "from_addr2"=>"#103",
   "from_city"=>"San Francisco",
   "from_state"=>"CA",
   "from_code"=>"94115",
   "test"=>true}}

)


rocketshipit.request(
  {
  "carrier": "UPS",
  "action": "SubmitShipment",
  "params": {
    "account_number": "YOUR_ACCOUNT_NUMBER",
    "key": "YOUR_UPS_KEY",
    "username": "YOUR_USERNAME",
    "password": "YOUR_PASSWORD",
    "return_code": "8",
    "notify": [
      {
        "type": "RETURN",
        "email": "bob@email.com",
        "undeliverable_email": "foo@bar.com",
        "from_email": "blah@email.com",
        "from_name": "John Doe"
      }
    ],
    "packages": [
      {
        "weight": 4
      }
    ],
    "service": "03",
    "shipper": "RocketShipIt",
    "ship_addr1": "123 Main St",
    "ship_city": "Whitehall",
    "ship_state": "MT",
    "ship_code": "59759",
    "ship_phone": "1231231234",
    "ship_country": "US",
    "to_name": "John Doe",
    "to_addr1": "940 Presidio Ave",
    "to_addr2": "#103",
    "to_state": "CA",
    "to_city": "San Francisco",
    "to_code": "94115",
    "to_country": "US",
    "image_type": "GIF",
    "from_company": "RocketShipIt",
    "from_name": "Mark Sanborn",
    "from_addr1": "940 Presidio Ave",
    "from_addr2": "#103",
    "from_city": "San Francisco",
    "from_state": "CA",
    "from_code": "94115",
    "test": true
  }
}
)
← Back to All Examples

Other UPS Examples

Address Validation
Example implementation for UPS Address Validation
Download CSV
Example implementation for UPS Download CSV
Freight Rate
Example implementation for UPS Freight Rate
International w/ Com. Inv.
Example implementation for UPS International w/ Com. Inv.
International w/ Com. Inv. with EEI
Example implementation for UPS International w/ Com. Inv. with EEI
International w/ discount, freight charges
Example implementation for UPS International w/ discount, freight charges
Label
Example implementation for UPS Label
Label Additional Handling
Example implementation for UPS Label Additional Handling
Label COD
Example implementation for UPS Label COD
Label DDP/DDU
Example implementation for UPS Label DDP/DDU
Label Direct Signature
Example implementation for UPS Label Direct Signature
Label EU IOSS
Example implementation for UPS Label EU IOSS
Label Email Notifications
Example implementation for UPS Label Email Notifications
Label Ground Freight Pricing
Example implementation for UPS Label Ground Freight Pricing
Label Ground Freight Pricing Third Party Billing
Example implementation for UPS Label Ground Freight Pricing Third Party Billing
Label Insurance
Example implementation for UPS Label Insurance
Label International Bill Receiver
Example implementation for UPS Label International Bill Receiver
Label International Minimal no paperwork
Example implementation for UPS Label International Minimal no paperwork
Label Letter
Example implementation for UPS Label Letter
Label Mail Innovations
Example implementation for UPS Label Mail Innovations
Label Mail Innovations International
Example implementation for UPS Label Mail Innovations International
Label Medical Dry Ice
Example implementation for UPS Label Medical Dry Ice
Label Recovery
Example implementation for UPS Label Recovery
Label Reference Values
Example implementation for UPS Label Reference Values
Label Return
Example implementation for UPS Label Return
Label SurePost
Example implementation for UPS Label SurePost
Label Third Party Billing
Example implementation for UPS Label Third Party Billing
Label With Promo Discount
Example implementation for UPS Label With Promo Discount
Label w/ Access Point
Example implementation for UPS Label w/ Access Point
Letter International w/ Com. Inv.
Example implementation for UPS Letter International w/ Com. Inv.
Locator
Example implementation for UPS Locator
Pickup Cancel
Example implementation for UPS Pickup Cancel
Pickup Freight
Example implementation for UPS Pickup Freight
Pickup Rate
Example implementation for UPS Pickup Rate
Pickup Schedule
Example implementation for UPS Pickup Schedule
Pickup Schedule Various Services
Example implementation for UPS Pickup Schedule Various Services
Pickup Status
Example implementation for UPS Pickup Status
Rates Additional Handling
Example implementation for UPS Rates Additional Handling
Rates DDP/DDU
Example implementation for UPS Rates DDP/DDU
Rates Daily
Example implementation for UPS Rates Daily
Rates Ground Freight Pricing
Example implementation for UPS Rates Ground Freight Pricing
Rates Insurance
Example implementation for UPS Rates Insurance
Rates International
Example implementation for UPS Rates International
Rates Negotiated
Example implementation for UPS Rates Negotiated
Rates Retail
Example implementation for UPS Rates Retail
Rates Simple Rate
Example implementation for UPS Rates Simple Rate
Rates SurePost
Example implementation for UPS Rates SurePost
Rating w/ Access Point
Example implementation for UPS Rating w/ Access Point
Time in Transit
Example implementation for UPS Time in Transit
Time in Transit International
Example implementation for UPS Time in Transit International
Tracking
Example implementation for UPS Tracking
Tracking Mail Innovations
Example implementation for UPS Tracking Mail Innovations
Tracking by Reference
Example implementation for UPS Tracking by Reference
Upload Customs Document
Example implementation for UPS Upload Customs Document
Upload Link Customs Document
Example implementation for UPS Upload Link Customs Document
Void Package
Example implementation for UPS Void Package
Void Shipment
Example implementation for UPS Void Shipment