Validate an MPP shipping-label request and return live rates

Creates an unpurchased EasyPost shipment to obtain live rates. The selected public total includes the live carrier rate, PostalForm service fee, and estimated payment-fee reserve.

post/api/machine/mpp/shipping-labels/validate

Request

  • Base URL: https://postalform.com
  • URL: https://postalform.com/api/machine/mpp/shipping-labels/validate
  • Auth: none required

Request body

request_idstring uuid required

Client-generated idempotency key. Reuse the same value and exact body after a 402 challenge.

buyer_namestring required
buyer_emailstring email required
carrierstring

Optional EasyPost carrier name, for example USPS, UPS, or FedEx.

servicestring

Optional EasyPost carrier service name, for example GroundAdvantage.

Example request

{
  "request_id": "6df12d40-ae2a-4a06-a169-b7aa392ca7bd",
  "buyer_name": "Agent Owner",
  "buyer_email": "owner@example.com",
  "from": {
    "name": "Agent Owner",
    "street1": "417 Montgomery St",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94104",
    "country": "US",
    "phone": "4155550100",
    "email": "owner@example.com"
  },
  "to": {
    "name": "Recipient Example",
    "street1": "179 N Harbor Dr",
    "city": "Redondo Beach",
    "state": "CA",
    "zip": "90277",
    "country": "US",
    "phone": "3105550199"
  },
  "parcel": {
    "weight_oz": 16,
    "length_in": 12,
    "width_in": 9,
    "height_in": 4
  },
  "carrier": "USPS",
  "service": "GroundAdvantage"
}

Response

Validation and live rating succeeded

request_idstring uuid required
request_hashstring required
order_idstring uuid nullable required
status'validated_existing_order' | 'validated_new_order' required
protocol'mpp' required
methodsstring[] required
product_type'shipping_label' required

Changes

No recorded changes to this operation across all 1 revision of this API.