UPS-REST - International Return w/ Import Control

Carrier: UPS-REST
Action: International Return w/ Import Control
Description: Example implementation for UPS-REST International Return w/ Import Control

{
  "carrier": "UPS-REST",
  "action": "SubmitShipment",
  "params": {
    "test": true,
    "key": "your-key-from-authenticate-request",
    "account_number": "YOUR_ACCOUNT",
    "customs_forms": "01",
    "currency": "EUR",
    "invoice_date": "20260204",
    "reason_for_export": "RETURN",
    "invoice_line_total": 550,
    "trade_terms": "EXW",
    "declaration_statement": "",
    "import_control_code": "05",
    "special_instructions": "Return of rented goods. No sale. Return to owner.",
    "packages": [
      {
        "weight": 15,
        "length": 39,
        "width": 69,
        "height": 36
      }
    ],
    "customs": [
      {
        "invoice_line_number": "1",
        "invoice_line_part_number": "FB",
        "invoice_line_description": "Photo booth rental bundle",
        "invoice_line_value": "530",
        "invoice_line_origin_country_code": "DE",
        "commodity_code": "8525.80.30.00",
        "customs_quantity_units": "EA"
      }
    ],
    "sold_company": "My Company",
    "sold_name": "John Doe",
    "sold_tax_id": "123456789",
    "sold_phone": "1231231234",
    "sold_addr1": "456 Warehouse St",
    "sold_city": "Bad Friedrichshall",
    "sold_state": "",
    "sold_code": "74177",
    "sold_country": "DE",
    "service": "11",
    "shipper": "My Company",
    "ship_contact": "Shipping Department",
    "ship_addr1": "456 Warehouse St",
    "ship_city": "Heilbronn",
    "ship_state": "",
    "ship_code": "74078",
    "ship_country": "DE",
    "ship_phone": "1231231234",
    "to_attention_name": "My Company",
    "to_name": "My Company",
    "to_addr1": "456 Warehouse St",
    "to_city": "Heilbronn",
    "to_state": "",
    "to_code": "74078",
    "to_country": "DE",
    "to_phone": "1231231234",
    "from_company": "My Company c/o Partner AG",
    "from_name": "My Company c/o Partner AG",
    "from_addr1": "123 Swiss St",
    "from_city": "St.Gallen",
    "from_state": "SG",
    "from_code": "9004",
    "from_country": "CH",
    "image_type": "ZPL",
    "shipment_description": "Photo booth return",
    "packaging_type": "02",
    "weight_unit": "KGS",
    "length_unit": "CM"
  }
}


<?php
$rs = new RocketShipIt;
$response = $rs->request(
array (
  'carrier' => 'UPS-REST',
  'action' => 'SubmitShipment',
  'params' => 
  array (
    'test' => true,
    'key' => 'your-key-from-authenticate-request',
    'account_number' => 'YOUR_ACCOUNT',
    'customs_forms' => '01',
    'currency' => 'EUR',
    'invoice_date' => '20260204',
    'reason_for_export' => 'RETURN',
    'invoice_line_total' => 550,
    'trade_terms' => 'EXW',
    'declaration_statement' => '',
    'import_control_code' => '05',
    'special_instructions' => 'Return of rented goods. No sale. Return to owner.',
    'packages' => 
    array (
      0 => 
      array (
        'weight' => 15,
        'length' => 39,
        'width' => 69,
        'height' => 36,
      ),
    ),
    'customs' => 
    array (
      0 => 
      array (
        'invoice_line_number' => '1',
        'invoice_line_part_number' => 'FB',
        'invoice_line_description' => 'Photo booth rental bundle',
        'invoice_line_value' => '530',
        'invoice_line_origin_country_code' => 'DE',
        'commodity_code' => '8525.80.30.00',
        'customs_quantity_units' => 'EA',
      ),
    ),
    'sold_company' => 'My Company',
    'sold_name' => 'John Doe',
    'sold_tax_id' => '123456789',
    'sold_phone' => '1231231234',
    'sold_addr1' => '456 Warehouse St',
    'sold_city' => 'Bad Friedrichshall',
    'sold_state' => '',
    'sold_code' => '74177',
    'sold_country' => 'DE',
    'service' => '11',
    'shipper' => 'My Company',
    'ship_contact' => 'Shipping Department',
    'ship_addr1' => '456 Warehouse St',
    'ship_city' => 'Heilbronn',
    'ship_state' => '',
    'ship_code' => '74078',
    'ship_country' => 'DE',
    'ship_phone' => '1231231234',
    'to_attention_name' => 'My Company',
    'to_name' => 'My Company',
    'to_addr1' => '456 Warehouse St',
    'to_city' => 'Heilbronn',
    'to_state' => '',
    'to_code' => '74078',
    'to_country' => 'DE',
    'to_phone' => '1231231234',
    'from_company' => 'My Company c/o Partner AG',
    'from_name' => 'My Company c/o Partner AG',
    'from_addr1' => '123 Swiss St',
    'from_city' => 'St.Gallen',
    'from_state' => 'SG',
    'from_code' => '9004',
    'from_country' => 'CH',
    'image_type' => 'ZPL',
    'shipment_description' => 'Photo booth return',
    'packaging_type' => '02',
    'weight_unit' => 'KGS',
    'length_unit' => 'CM',
  ),
)
);


rs.request(
  {'action': 'SubmitShipment',
 'carrier': 'UPS-REST',
 'params': {'account_number': 'YOUR_ACCOUNT',
            'currency': 'EUR',
            'customs': [{'commodity_code': '8525.80.30.00',
                         'customs_quantity_units': 'EA',
                         'invoice_line_description': 'Photo booth rental '
                                                     'bundle',
                         'invoice_line_number': '1',
                         'invoice_line_origin_country_code': 'DE',
                         'invoice_line_part_number': 'FB',
                         'invoice_line_value': '530'}],
            'customs_forms': '01',
            'declaration_statement': '',
            'from_addr1': '123 Swiss St',
            'from_city': 'St.Gallen',
            'from_code': '9004',
            'from_company': 'My Company c/o Partner AG',
            'from_country': 'CH',
            'from_name': 'My Company c/o Partner AG',
            'from_state': 'SG',
            'image_type': 'ZPL',
            'import_control_code': '05',
            'invoice_date': '20260204',
            'invoice_line_total': 550,
            'key': 'your-key-from-authenticate-request',
            'length_unit': 'CM',
            'packages': [{'height': 36,
                          'length': 39,
                          'weight': 15,
                          'width': 69}],
            'packaging_type': '02',
            'reason_for_export': 'RETURN',
            'service': '11',
            'ship_addr1': '456 Warehouse St',
            'ship_city': 'Heilbronn',
            'ship_code': '74078',
            'ship_contact': 'Shipping Department',
            'ship_country': 'DE',
            'ship_phone': '1231231234',
            'ship_state': '',
            'shipment_description': 'Photo booth return',
            'shipper': 'My Company',
            'sold_addr1': '456 Warehouse St',
            'sold_city': 'Bad Friedrichshall',
            'sold_code': '74177',
            'sold_company': 'My Company',
            'sold_country': 'DE',
            'sold_name': 'John Doe',
            'sold_phone': '1231231234',
            'sold_state': '',
            'sold_tax_id': '123456789',
            'special_instructions': 'Return of rented goods. No sale. Return '
                                    'to owner.',
            'test': True,
            'to_addr1': '456 Warehouse St',
            'to_attention_name': 'My Company',
            'to_city': 'Heilbronn',
            'to_code': '74078',
            'to_country': 'DE',
            'to_name': 'My Company',
            'to_phone': '1231231234',
            'to_state': '',
            'trade_terms': 'EXW',
            'weight_unit': 'KGS'}}

)


rs.request(
  {"carrier"=>"UPS-REST",
 "action"=>"SubmitShipment",
 "params"=>
  {"test"=>true,
   "key"=>"your-key-from-authenticate-request",
   "account_number"=>"YOUR_ACCOUNT",
   "customs_forms"=>"01",
   "currency"=>"EUR",
   "invoice_date"=>"20260204",
   "reason_for_export"=>"RETURN",
   "invoice_line_total"=>550,
   "trade_terms"=>"EXW",
   "declaration_statement"=>"",
   "import_control_code"=>"05",
   "special_instructions"=>"Return of rented goods. No sale. Return to owner.",
   "packages"=>[{"weight"=>15, "length"=>39, "width"=>69, "height"=>36}],
   "customs"=>
    [{"invoice_line_number"=>"1",
      "invoice_line_part_number"=>"FB",
      "invoice_line_description"=>"Photo booth rental bundle",
      "invoice_line_value"=>"530",
      "invoice_line_origin_country_code"=>"DE",
      "commodity_code"=>"8525.80.30.00",
      "customs_quantity_units"=>"EA"}],
   "sold_company"=>"My Company",
   "sold_name"=>"John Doe",
   "sold_tax_id"=>"123456789",
   "sold_phone"=>"1231231234",
   "sold_addr1"=>"456 Warehouse St",
   "sold_city"=>"Bad Friedrichshall",
   "sold_state"=>"",
   "sold_code"=>"74177",
   "sold_country"=>"DE",
   "service"=>"11",
   "shipper"=>"My Company",
   "ship_contact"=>"Shipping Department",
   "ship_addr1"=>"456 Warehouse St",
   "ship_city"=>"Heilbronn",
   "ship_state"=>"",
   "ship_code"=>"74078",
   "ship_country"=>"DE",
   "ship_phone"=>"1231231234",
   "to_attention_name"=>"My Company",
   "to_name"=>"My Company",
   "to_addr1"=>"456 Warehouse St",
   "to_city"=>"Heilbronn",
   "to_state"=>"",
   "to_code"=>"74078",
   "to_country"=>"DE",
   "to_phone"=>"1231231234",
   "from_company"=>"My Company c/o Partner AG",
   "from_name"=>"My Company c/o Partner AG",
   "from_addr1"=>"123 Swiss St",
   "from_city"=>"St.Gallen",
   "from_state"=>"SG",
   "from_code"=>"9004",
   "from_country"=>"CH",
   "image_type"=>"ZPL",
   "shipment_description"=>"Photo booth return",
   "packaging_type"=>"02",
   "weight_unit"=>"KGS",
   "length_unit"=>"CM"}}

)


rocketshipit.request(
  {
  "carrier": "UPS-REST",
  "action": "SubmitShipment",
  "params": {
    "test": true,
    "key": "your-key-from-authenticate-request",
    "account_number": "YOUR_ACCOUNT",
    "customs_forms": "01",
    "currency": "EUR",
    "invoice_date": "20260204",
    "reason_for_export": "RETURN",
    "invoice_line_total": 550,
    "trade_terms": "EXW",
    "declaration_statement": "",
    "import_control_code": "05",
    "special_instructions": "Return of rented goods. No sale. Return to owner.",
    "packages": [
      {
        "weight": 15,
        "length": 39,
        "width": 69,
        "height": 36
      }
    ],
    "customs": [
      {
        "invoice_line_number": "1",
        "invoice_line_part_number": "FB",
        "invoice_line_description": "Photo booth rental bundle",
        "invoice_line_value": "530",
        "invoice_line_origin_country_code": "DE",
        "commodity_code": "8525.80.30.00",
        "customs_quantity_units": "EA"
      }
    ],
    "sold_company": "My Company",
    "sold_name": "John Doe",
    "sold_tax_id": "123456789",
    "sold_phone": "1231231234",
    "sold_addr1": "456 Warehouse St",
    "sold_city": "Bad Friedrichshall",
    "sold_state": "",
    "sold_code": "74177",
    "sold_country": "DE",
    "service": "11",
    "shipper": "My Company",
    "ship_contact": "Shipping Department",
    "ship_addr1": "456 Warehouse St",
    "ship_city": "Heilbronn",
    "ship_state": "",
    "ship_code": "74078",
    "ship_country": "DE",
    "ship_phone": "1231231234",
    "to_attention_name": "My Company",
    "to_name": "My Company",
    "to_addr1": "456 Warehouse St",
    "to_city": "Heilbronn",
    "to_state": "",
    "to_code": "74078",
    "to_country": "DE",
    "to_phone": "1231231234",
    "from_company": "My Company c/o Partner AG",
    "from_name": "My Company c/o Partner AG",
    "from_addr1": "123 Swiss St",
    "from_city": "St.Gallen",
    "from_state": "SG",
    "from_code": "9004",
    "from_country": "CH",
    "image_type": "ZPL",
    "shipment_description": "Photo booth return",
    "packaging_type": "02",
    "weight_unit": "KGS",
    "length_unit": "CM"
  }
}
)

← Back to UPS-REST Examples

Other UPS-REST Examples

Acceptance Audit Precheck

Example implementation for UPS-REST Acceptance Audit Precheck

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

Example implementation for UPS-REST Authenticate

Chemical Reference Lookup

Example implementation for UPS-REST Chemical Reference Lookup

Delivery Intercept Cancel

Example implementation for UPS-REST Delivery Intercept Cancel

Delivery Intercept Charges

Example implementation for UPS-REST Delivery Intercept Charges

Delivery Intercept Eligibility

Example implementation for UPS-REST Delivery Intercept Eligibility

Delivery Intercept Redirect

Example implementation for UPS-REST Delivery Intercept Redirect

Delivery Intercept Reschedule

Example implementation for UPS-REST Delivery Intercept Reschedule

Delivery Intercept Return to Sender

Example implementation for UPS-REST Delivery Intercept Return to Sender

Delivery Intercept Will Call

Example implementation for UPS-REST Delivery Intercept Will Call

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

International w/ Empty Declaration Statement

Example implementation for UPS-REST International w/ Empty Declaration Statement

Example implementation for UPS-REST Label

Label Additional Handling

Example implementation for UPS-REST Label Additional Handling

Label Alt Address

Example implementation for UPS-REST Label Alt Address

Example implementation for UPS-REST Label COD

Label Carbon Neutral

Example implementation for UPS-REST Label Carbon Neutral

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 Freight Collect

Example implementation for UPS-REST Label Freight Collect

Label Ground Freight Pricing

Example implementation for UPS-REST Label Ground Freight Pricing

Example implementation for UPS-REST Label Hazmat

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 Mail Innovations International CN22

Example implementation for UPS-REST Label Mail Innovations International CN22

Example implementation for UPS-REST Label NAFTA CO

Example implementation for UPS-REST Label Recovery

Label Reference Values

Example implementation for UPS-REST Label Reference Values

Example implementation for UPS-REST Label Return

Label Return w/ Email Delivery

Example implementation for UPS-REST Label Return w/ Email Delivery

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

Example implementation for UPS-REST Landed Cost

Landed Cost Multiple Items

Example implementation for UPS-REST Landed Cost Multiple Items

Letter International w/ Com. Inv.

Example implementation for UPS-REST Letter International w/ Com. Inv.

Example implementation for UPS-REST Locator

Example implementation for UPS-REST Pickup Cancel

Example implementation for UPS-REST Pickup Rate

Pickup Schedule

Example implementation for UPS-REST Pickup Schedule

Example implementation for UPS-REST Pickup Status

Pickup Status Oncall

Example implementation for UPS-REST Pickup Status Oncall

Example implementation for UPS-REST Rates

Rates Additional Handling

Example implementation for UPS-REST Rates Additional Handling

Example implementation for UPS-REST Rates COD

Example implementation for UPS-REST Rates Daily

Rates Ground Freight Pricing

Example implementation for UPS-REST Rates Ground Freight Pricing

Example implementation for UPS-REST Rates Hazmat

Rates International

Example implementation for UPS-REST Rates International

Rates Negotiated

Example implementation for UPS-REST Rates Negotiated

Example implementation for UPS-REST Rates Retail

Rates Simple Rate

Example implementation for UPS-REST Rates Simple Rate

Example implementation for UPS-REST Rates Single

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

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

Example implementation for UPS-REST Void Shipment