Get MPP shipping-label payment, fulfillment, and download status

get/api/machine/mpp/shipping-labels/{id}

Request

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

Path parameters

idstring uuid required

Canonical order_id or any aliased request_id returned by the create or validate call.

Response

Current order status, including a fresh signed PDF link whenever the label is ready

order_idstring uuid required
statusstring required
payment_statusstring required
fulfillment_statusstring required
is_paidboolean required
current_stepstring nullable required
payment_intent_idstring nullable required
payment_channelstring nullable required
currencystring nullable required
product_type'shipping_label' required
carrierstring required
servicestring required
tracking_codestring nullable required
status_urlstring uri required
order_complete_urlstring uri nullable required
label_download_urlstring uri nullable required
label_download_expires_atstring date-time nullable required
errorstring nullable required

Changes

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