All API Examples

UPS-REST - Label Alt Address

Carrier: UPS-REST
Action: Label Alt Address
Description: Example implementation for UPS-REST Label Alt Address 
{
  "action": "SubmitShipment",
  "carrier": "UPS-REST",
  "params": {
    "account_number": "your-account-number",
    "key": "your-key-from-authenticate-request",
    "to_email": "noreply123@someemail.com",
    "alt_addr1": "14370 Myford Rd Suite #150",
    "alt_attention_name": "RMA# 9771",
    "alt_city": "Irvine",
    "alt_code": "92606",
    "alt_country": "US",
    "alt_name": "AmScope",
    "alt_phone": "2158801280",
    "alt_state": "CA",
    "currency": "USD",
    "image_type": "GIF",
    "label_stock_type": "PAPER_8.5X11_BOTTOM_HALF_LABEL",
    "length_unit": "IN",
    "packages": [
      {
        "height": 1,
        "length": 1,
        "reference_code": "00",
        "reference_value": "ref 1",
        "weight": 18,
        "width": 1
      }
    ],
    "packaging_type": "02",
    "residential": true,
    "service": "03",
    "ship_addr1": "542 W 112th St",
    "ship_city": "New York",
    "ship_code": "10025",
    "ship_contact": "US Test - NY",
    "ship_country": "US",
    "ship_name": "US Test - NY",
    "ship_phone": "2681549230",
    "ship_state": "NY",
    "shipper": "US Test - NY",
    "test": true,
    "to_addr1": "5685 Alcoa Ave",
    "to_attention_name": "US Test - CA 1",
    "to_city": "LOS ANGELES",
    "to_code": "90058-3728",
    "to_company": "US Test - CA 1",
    "to_country": "US",
    "to_name": "US Test - CA 1",
    "to_phone": "5268194758",
    "to_state": "CA",
    "weight_unit": "LBS"
  }
}

<?php
$rs = new RocketShipIt;
$response = $rs->request(
array (
  'action' => 'SubmitShipment',
  'carrier' => 'UPS-REST',
  'params' => 
  array (
    'account_number' => 'your-account-number',
    'key' => 'your-key-from-authenticate-request',
    'to_email' => 'noreply123@someemail.com',
    'alt_addr1' => '14370 Myford Rd Suite #150',
    'alt_attention_name' => 'RMA# 9771',
    'alt_city' => 'Irvine',
    'alt_code' => '92606',
    'alt_country' => 'US',
    'alt_name' => 'AmScope',
    'alt_phone' => '2158801280',
    'alt_state' => 'CA',
    'currency' => 'USD',
    'image_type' => 'GIF',
    'label_stock_type' => 'PAPER_8.5X11_BOTTOM_HALF_LABEL',
    'length_unit' => 'IN',
    'packages' => 
    array (
      0 => 
      array (
        'height' => 1,
        'length' => 1,
        'reference_code' => '00',
        'reference_value' => 'ref 1',
        'weight' => 18,
        'width' => 1,
      ),
    ),
    'packaging_type' => '02',
    'residential' => true,
    'service' => '03',
    'ship_addr1' => '542 W 112th St',
    'ship_city' => 'New York',
    'ship_code' => '10025',
    'ship_contact' => 'US Test - NY',
    'ship_country' => 'US',
    'ship_name' => 'US Test - NY',
    'ship_phone' => '2681549230',
    'ship_state' => 'NY',
    'shipper' => 'US Test - NY',
    'test' => true,
    'to_addr1' => '5685 Alcoa Ave',
    'to_attention_name' => 'US Test - CA 1',
    'to_city' => 'LOS ANGELES',
    'to_code' => '90058-3728',
    'to_company' => 'US Test - CA 1',
    'to_country' => 'US',
    'to_name' => 'US Test - CA 1',
    'to_phone' => '5268194758',
    'to_state' => 'CA',
    'weight_unit' => 'LBS',
  ),
)
);


rs.request(
  {'action': 'SubmitShipment',
 'carrier': 'UPS-REST',
 'params': {'account_number': 'your-account-number',
            'alt_addr1': '14370 Myford Rd Suite #150',
            'alt_attention_name': 'RMA# 9771',
            'alt_city': 'Irvine',
            'alt_code': '92606',
            'alt_country': 'US',
            'alt_name': 'AmScope',
            'alt_phone': '2158801280',
            'alt_state': 'CA',
            'currency': 'USD',
            'image_type': 'GIF',
            'key': 'your-key-from-authenticate-request',
            'label_stock_type': 'PAPER_8.5X11_BOTTOM_HALF_LABEL',
            'length_unit': 'IN',
            'packages': [{'height': 1,
                          'length': 1,
                          'reference_code': '00',
                          'reference_value': 'ref 1',
                          'weight': 18,
                          'width': 1}],
            'packaging_type': '02',
            'residential': True,
            'service': '03',
            'ship_addr1': '542 W 112th St',
            'ship_city': 'New York',
            'ship_code': '10025',
            'ship_contact': 'US Test - NY',
            'ship_country': 'US',
            'ship_name': 'US Test - NY',
            'ship_phone': '2681549230',
            'ship_state': 'NY',
            'shipper': 'US Test - NY',
            'test': True,
            'to_addr1': '5685 Alcoa Ave',
            'to_attention_name': 'US Test - CA 1',
            'to_city': 'LOS ANGELES',
            'to_code': '90058-3728',
            'to_company': 'US Test - CA 1',
            'to_country': 'US',
            'to_email': 'noreply123@someemail.com',
            'to_name': 'US Test - CA 1',
            'to_phone': '5268194758',
            'to_state': 'CA',
            'weight_unit': 'LBS'}}

)


rs.request(
  {"action"=>"SubmitShipment",
 "carrier"=>"UPS-REST",
 "params"=>
  {"account_number"=>"your-account-number",
   "key"=>"your-key-from-authenticate-request",
   "to_email"=>"noreply123@someemail.com",
   "alt_addr1"=>"14370 Myford Rd Suite #150",
   "alt_attention_name"=>"RMA# 9771",
   "alt_city"=>"Irvine",
   "alt_code"=>"92606",
   "alt_country"=>"US",
   "alt_name"=>"AmScope",
   "alt_phone"=>"2158801280",
   "alt_state"=>"CA",
   "currency"=>"USD",
   "image_type"=>"GIF",
   "label_stock_type"=>"PAPER_8.5X11_BOTTOM_HALF_LABEL",
   "length_unit"=>"IN",
   "packages"=>
    [{"height"=>1,
      "length"=>1,
      "reference_code"=>"00",
      "reference_value"=>"ref 1",
      "weight"=>18,
      "width"=>1}],
   "packaging_type"=>"02",
   "residential"=>true,
   "service"=>"03",
   "ship_addr1"=>"542 W 112th St",
   "ship_city"=>"New York",
   "ship_code"=>"10025",
   "ship_contact"=>"US Test - NY",
   "ship_country"=>"US",
   "ship_name"=>"US Test - NY",
   "ship_phone"=>"2681549230",
   "ship_state"=>"NY",
   "shipper"=>"US Test - NY",
   "test"=>true,
   "to_addr1"=>"5685 Alcoa Ave",
   "to_attention_name"=>"US Test - CA 1",
   "to_city"=>"LOS ANGELES",
   "to_code"=>"90058-3728",
   "to_company"=>"US Test - CA 1",
   "to_country"=>"US",
   "to_name"=>"US Test - CA 1",
   "to_phone"=>"5268194758",
   "to_state"=>"CA",
   "weight_unit"=>"LBS"}}

)


rocketshipit.request(
  {
  "action": "SubmitShipment",
  "carrier": "UPS-REST",
  "params": {
    "account_number": "your-account-number",
    "key": "your-key-from-authenticate-request",
    "to_email": "noreply123@someemail.com",
    "alt_addr1": "14370 Myford Rd Suite #150",
    "alt_attention_name": "RMA# 9771",
    "alt_city": "Irvine",
    "alt_code": "92606",
    "alt_country": "US",
    "alt_name": "AmScope",
    "alt_phone": "2158801280",
    "alt_state": "CA",
    "currency": "USD",
    "image_type": "GIF",
    "label_stock_type": "PAPER_8.5X11_BOTTOM_HALF_LABEL",
    "length_unit": "IN",
    "packages": [
      {
        "height": 1,
        "length": 1,
        "reference_code": "00",
        "reference_value": "ref 1",
        "weight": 18,
        "width": 1
      }
    ],
    "packaging_type": "02",
    "residential": true,
    "service": "03",
    "ship_addr1": "542 W 112th St",
    "ship_city": "New York",
    "ship_code": "10025",
    "ship_contact": "US Test - NY",
    "ship_country": "US",
    "ship_name": "US Test - NY",
    "ship_phone": "2681549230",
    "ship_state": "NY",
    "shipper": "US Test - NY",
    "test": true,
    "to_addr1": "5685 Alcoa Ave",
    "to_attention_name": "US Test - CA 1",
    "to_city": "LOS ANGELES",
    "to_code": "90058-3728",
    "to_company": "US Test - CA 1",
    "to_country": "US",
    "to_name": "US Test - CA 1",
    "to_phone": "5268194758",
    "to_state": "CA",
    "weight_unit": "LBS"
  }
}
)
← Back to All Examples

Other UPS-REST Examples

Address Validation
Example implementation for UPS-REST Address Validation
Address Validation City/State from Zip
Example implementation for UPS-REST Address Validation City/State from Zip
Authenticate
Example implementation for UPS-REST Authenticate
Download CSV
Example implementation for UPS-REST Download CSV
International w/ Com. Inv.
Example implementation for UPS-REST International w/ Com. Inv.
International w/ Com. Inv. with EEI
Example implementation for UPS-REST International w/ Com. Inv. with EEI
Label
Example implementation for UPS-REST Label
Label Additional Handling
Example implementation for UPS-REST Label Additional Handling
Label COD
Example implementation for UPS-REST Label COD
Label Carbon Neutral
Example implementation for UPS-REST Label Carbon Neutral
Label DDP/DDU
Example implementation for UPS-REST Label DDP/DDU
Label Direct Adult Signature
Example implementation for UPS-REST Label Direct Adult Signature
Label Direct Delivery Only
Example implementation for UPS-REST Label Direct Delivery Only
Label Direct Signature
Example implementation for UPS-REST Label Direct Signature
Label Email Notifications
Example implementation for UPS-REST Label Email Notifications
Label Ground Freight Pricing
Example implementation for UPS-REST Label Ground Freight Pricing
Label Insurance
Example implementation for UPS-REST Label Insurance
Label Lithium Battery
Example implementation for UPS-REST Label Lithium Battery
Label Mail Innovations
Example implementation for UPS-REST Label Mail Innovations
Label NAFTA CO
Example implementation for UPS-REST Label NAFTA CO
Label Recovery
Example implementation for UPS-REST Label Recovery
Label Reference Values
Example implementation for UPS-REST Label Reference Values
Label Return
Example implementation for UPS-REST Label Return
Label Return w/ Email Delivery
Example implementation for UPS-REST Label Return w/ Email Delivery
Label SurePost
Example implementation for UPS-REST Label SurePost
Label Third Party Billing
Example implementation for UPS-REST Label Third Party Billing
Label With Promo Discount
Example implementation for UPS-REST Label With Promo Discount
Label w/ Access Point
Example implementation for UPS-REST Label w/ Access Point
Letter International w/ Com. Inv.
Example implementation for UPS-REST Letter International w/ Com. Inv.
Locator
Example implementation for UPS-REST Locator
Pickup Cancel
Example implementation for UPS-REST Pickup Cancel
Pickup Rate
Example implementation for UPS-REST Pickup Rate
Pickup Schedule
Example implementation for UPS-REST Pickup Schedule
Pickup Status
Example implementation for UPS-REST Pickup Status
Pickup Status Oncall
Example implementation for UPS-REST Pickup Status Oncall
Rates
Example implementation for UPS-REST Rates
Rates Additional Handling
Example implementation for UPS-REST Rates Additional Handling
Rates COD
Example implementation for UPS-REST Rates COD
Rates Daily
Example implementation for UPS-REST Rates Daily
Rates Ground Freight Pricing
Example implementation for UPS-REST Rates Ground Freight Pricing
Rates International
Example implementation for UPS-REST Rates International
Rates Negotiated
Example implementation for UPS-REST Rates Negotiated
Rates Retail
Example implementation for UPS-REST Rates Retail
Rates Simple Rate
Example implementation for UPS-REST Rates Simple Rate
Rates Single
Example implementation for UPS-REST Rates Single
Rates SurePost
Example implementation for UPS-REST Rates SurePost
Rates with Return Service
Example implementation for UPS-REST Rates with Return Service
Rating w/ Access Point
Example implementation for UPS-REST Rating w/ Access Point
Time in Transit
Example implementation for UPS-REST Time in Transit
Time in Transit International
Example implementation for UPS-REST Time in Transit International
Track Alert (webhook)
Example implementation for UPS-REST Track Alert (webhook)
Track Alert Multiple (webhook)
Example implementation for UPS-REST Track Alert Multiple (webhook)
Track by Reference Number
Example implementation for UPS-REST Track by Reference Number
Tracking
Example implementation for UPS-REST Tracking
Tracking Mail Innovations
Example implementation for UPS-REST Tracking Mail Innovations
Upload Customs Document
Example implementation for UPS-REST Upload Customs Document
Upload Link Customs Document
Example implementation for UPS-REST Upload Link Customs Document
Void Shipment
Example implementation for UPS-REST Void Shipment