responsemessage.md

ResponseMessage

Message returned with supporting information from a request. In some cases this can be an error message, for example a timeout from a carrier. If available, the origin of the message is displayed in source.

Example Usage

import { ResponseMessage } from "shippo/models/components";

let value: ResponseMessage = {
  source: "UPS",
  code: "carrier_timeout",
  text: "UPS API did not respond. Please try again in a few minutes.",
};

Fields

Field	Type	Required	Description	Example
source	string	➖	Origin of message	UPS
code	string	➖	Classification of message	carrier_timeout
text	string	➖	Message content	UPS API did not respond. Please try again in a few minutes.