UPS PreNotification Virtual Sandbox

Inform UPS operations of Dangerous Goods shipments prior to manifest upload.

The UPS PreNotification API allows customer applications to inform UPS operations of Dangerous Goods shipments as they are processed and before manifest information is uploaded at the end of the day. This service helps streamline the handling of hazardous materials within the UPS transportation network.

Use this hosted sandbox to simulate UPS PreNotification APIs without authentication, API keys, or extra dependencies. Point your code or SDK to the Beeceptor base URL, preferably through an environment variable or feature flag, and switch back to the production API when ready. This keeps your integration code consistent across local development, QA, demos, and production.

Use cases:

Use this sandbox to validate Dangerous Goods shipment payloads, test pre-manifest notification workflows, verify business rule compliance, and simulate error responses for hazardous material declarations before integrating with UPS production systems.

UPS PreNotification virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate UPS PreNotification responses instantly.

`https://ups-prenotification.mock.beeceptor.com`

Pre-Notification(2 operations)

POST

/dangerousgoods/{version}/prenotification

The Pre-Notification API allows customer applications to inform UPS operations of Dangerous Goods shipments as they are processed and will enter the UPS transportation network prior to an upload of manifest information at the end of the day.

Header Name	Example
`transId`	`"commodo"`
`transactionSrc`	`"elit"`

Request Payload

{
  "PreNotificationRequest": {
    "Request": {
      "RequestOption": "RequestOption",
      "SubVersion": "3",
      "TransactionReference": {
        "CustomerContext": ""
      }
    },
    "Shipment": {
      "ShipperNumber": "",
      "ShipmentIdentificationNumber": "1Z2398YY81288",
      "ShipFromAddress": {
        "AddressLine": "MY STREET 12",
        "City": "BOGOTA",
        "StateProvinceCode": "NJ",
        "PostalCode": "K1A0B1",
        "CountryCode": "CA"
      },
      "ShipToAddress": {
        "AddressLine": "MY STREET 12",
        "City": "BOGOTA",
        "StateProvinceCode": "NJ",
        "PostalCode": "K1A0B1",
        "CountryCode": "CA"
      },
      "PickupDate": "20171101",
      "Service": {
        "Code": "GND",
        "Description": "Ground"
      },
      "RegulationSet": "TDG",
      "Package": {
        "TrackingNumber": "1Z33445567001",
        "PackageWeight": {
          "UnitOfMeasurement": {
            "Code": "KGS",
            "Description": "Kilo"
          },
          "Weight": "12"
        },
        "TransportationMode": "GND",
        "VoidIndicator": "",
        "PackagePoints": "12",
        "ChemicalRecord": {
          "ReportableQuantity": "1",
          "ClassDivisionNumber": "I",
          "SubRiskClass": "1234",
          "IDNumber": "UN2761",
          "PackagingGroupType": "0",
          "Quantity": "1",
          "UOM": "LBS",
          "PackagingInstructionCode": "TEST",
          "EmergencyPhone": "",
          "EmergencyContact": "",
          "ProperShippingName": "TEST SHIPPING",
          "TechnicalName": "",
          "AdditionalDescription": "",
          "PackagingType": "",
          "HazardLabelRequired": "LABEL",
          "PackagingTypeQuantity": "1",
          "CommodityRegulatedLevelCode": "LR",
          "TransportCategory": "0",
          "TunnelRestrictionCode": "1",
          "QValue": "0.1",
          "OverPackedIndicator": "",
          "AllPackedInOneIndicator": ""
        }
      }
    }
  }
}

Response Payload

{
  "PreNotificationResponse": {
    "Response": {
      "Alert": [
        {
          "Code": "3479",
          "Description": "port"
        },
        {
          "Code": "7679",
          "Description": "pixel"
        },
        {
          "Code": "3155",
          "Description": "pixel"
        },
        {
          "Code": "6508",
          "Description": "card"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "OtCoaYR1sk"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "6863",
        "message": "array"
      },
      {
        "code": "0626",
        "message": "alarm"
      },
      {
        "code": "0202",
        "message": "array"
      },
      {
        "code": "8030",
        "message": "application"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "5885",
        "message": "driver"
      },
      {
        "code": "9069",
        "message": "protocol"
      },
      {
        "code": "8890",
        "message": "pixel"
      },
      {
        "code": "6580",
        "message": "sensor"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "1673",
        "message": "panel"
      },
      {
        "code": "0643",
        "message": "firewall"
      },
      {
        "code": "9370",
        "message": "driver"
      },
      {
        "code": "2292",
        "message": "monitor"
      },
      {
        "code": "0853",
        "message": "protocol"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "6751",
        "message": "sensor"
      },
      {
        "code": "3310",
        "message": "firewall"
      },
      {
        "code": "2646",
        "message": "panel"
      },
      {
        "code": "8272",
        "message": "array"
      }
    ]
  }
}

POST

/dangerousgoods/{deprecatedVersion}/prenotification

Header Name	Example
`transId`	`"nisi"`
`transactionSrc`	`"culpa amet dolor minim"`

Request Payload

{
  "PreNotificationRequest": {
    "Request": {
      "RequestOption": "RequestOption",
      "SubVersion": "3",
      "TransactionReference": {
        "CustomerContext": ""
      }
    },
    "Shipment": {
      "ShipperNumber": "",
      "ShipmentIdentificationNumber": "1Z2398YY81288",
      "ShipFromAddress": {
        "AddressLine": "MY STREET 12",
        "City": "BOGOTA",
        "StateProvinceCode": "NJ",
        "PostalCode": "K1A0B1",
        "CountryCode": "CA"
      },
      "ShipToAddress": {
        "AddressLine": "MY STREET 12",
        "City": "BOGOTA",
        "StateProvinceCode": "NJ",
        "PostalCode": "K1A0B1",
        "CountryCode": "CA"
      },
      "PickupDate": "20171101",
      "Service": {
        "Code": "GND",
        "Description": "Ground"
      },
      "RegulationSet": "TDG",
      "Package": {
        "TrackingNumber": "1Z33445567001",
        "PackageWeight": {
          "UnitOfMeasurement": {
            "Code": "KGS",
            "Description": "Kilo"
          },
          "Weight": "12"
        },
        "TransportationMode": "GND",
        "VoidIndicator": "",
        "PackagePoints": "12",
        "ChemicalRecord": {
          "ReportableQuantity": "1",
          "ClassDivisionNumber": "I",
          "SubRiskClass": "1234",
          "IDNumber": "UN2761",
          "PackagingGroupType": "0",
          "Quantity": "1",
          "UOM": "LBS",
          "PackagingInstructionCode": "TEST",
          "EmergencyPhone": "",
          "EmergencyContact": "",
          "ProperShippingName": "TEST SHIPPING",
          "TechnicalName": "",
          "AdditionalDescription": "",
          "PackagingType": "",
          "HazardLabelRequired": "LABEL",
          "PackagingTypeQuantity": "1",
          "CommodityRegulatedLevelCode": "LR",
          "TransportCategory": "0",
          "TunnelRestrictionCode": "1",
          "QValue": "0.1",
          "OverPackedIndicator": "",
          "AllPackedInOneIndicator": ""
        }
      }
    }
  }
}

Response Payload

{
  "PreNotificationResponse": {
    "Response": {
      "Alert": [
        {
          "Code": "6439",
          "Description": "microchip"
        }
      ],
      "ResponseStatus": {
        "Code": "1",
        "Description": "Success"
      },
      "TransactionReference": {
        "CustomerContext": "eVIT9HJpaU"
      }
    }
  }
}

{
  "response": {
    "errors": [
      {
        "code": "2117",
        "message": "alarm"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "6745",
        "message": "transmitter"
      },
      {
        "code": "2277",
        "message": "port"
      },
      {
        "code": "9679",
        "message": "array"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "9199",
        "message": "bus"
      },
      {
        "code": "2782",
        "message": "sensor"
      },
      {
        "code": "0758",
        "message": "array"
      },
      {
        "code": "3410",
        "message": "bandwidth"
      },
      {
        "code": "7543",
        "message": "application"
      }
    ]
  }
}

{
  "response": {
    "errors": [
      {
        "code": "4259",
        "message": "driver"
      },
      {
        "code": "0882",
        "message": "firewall"
      }
    ]
  }
}

Service Homepage: github.com/UPS-API/api-documentation/blob/main/PreNotification-Ready.yaml

upslogisticsshippingdangerous-goodstransportation