Options
Optional settings that affect label, delivery, taxes, and more. NOTE: create_and_buy and create_and_buy_cheapest are mutually exclusive
- additionalType: boolean | null
_handling Whether the package requires additional handling
- carbonType: boolean | null
_neutral Request carbon neutral delivery
- carrierType: number | null
_insurance _amount Declared insurance value for the carrier
- commercialType: string | null
_invoice _letterhead Header text for the commercial invoice
- commercialType: string | null
_invoice _signature Signature for the commercial invoice
- createType: boolean | null
_and _buy Immediately buy a label. Mutually exclusive with
create_and_buy_cheapest - createType: boolean | null
_and _buy _cheapest Automatically buy the cheapest rate. Mutually exclusive with
create_and_buy - deliveryType: string | nullenum
_confirmation Delivery confirmation type
values- N
O _ S I G N A T U R E - S
I G N A T U R E - S
I G N A T U R E _ R E S T R I C T E D - A
D U L T _ S I G N A T U R E - A
D U L T _ S I G N A T U R E _ R E S T R I C T E D
- N
- dropoffType: string | nullFormat: date_time
_max _datetime Latest acceptable drop-off time
- dropoffType: string | null
_type Dropoff type (e.g., REGULAR_PICKUP, SCHEDULED_PICKUP)
- dutyType: object | null
_payment Properties: 4Duties/taxes billing information
- dutyType: string | null
_payment _account Account ID to use for duty/tax payment
- endorsementType: string | null
Return instruction (e.g., RETURN_SERVICE_REQUESTED)
- fetchType: boolean | null
_express _delivery _date Request express delivery date from carrier
- hazmatType: string | nullenum
Indicates hazardous material
values- P
R I M A R Y _ C O N T A I N E D - P
R I M A R Y _ P A C K E D - P
R I M A R Y - S
E C O N D A R Y _ C O N T A I N E D - S
E C O N D A R Y _ P A C K E D - S
E C O N D A R Y - O
R M D - L
I M I T E D _ Q U A N T I T Y
- P
- incotermType: string | null
Incoterm for the shipment (e.g., DDP, DAP)
- isType: boolean | null
_return Indicates whether the shipment is a return
- labelType: boolean | null
_broker Request a USPS Label Broker QR code for PDF labels. The QR is returned as a label_qr_code form in the response's forms array
- labelType: string | nullFormat: date
_date Date to appear on the shipping label
- labelType: string | null
_format Label file format (e.g., PDF, ZPL)
- labelType: string | null
_request _source Source of the label request (e.g., api)
- labelType: "4x6" or "8.5x11" or "LETTER"enum
_size Label size (e.g., 4x6)
- machinableType: boolean | null
Whether the parcel is machinable (USPS)
- parcelsType: boolean | null
_response Whether to include parcels in the response
- paymentType: object | nullProperties: 4
Postage billing information
- pickupType: string | nullFormat: date_time
_min _datetime Earliest acceptable pickup time
- pickupType: string | nullFormat: date_time
_max _datetime Latest acceptable pickup time
- postageType: boolean | null
_label _inline Whether to return the label inline in the response
- printType: array of object | null
_custom Properties: 3Custom reference text/barcodes to print on the label. Each entry is an object. Used for carrier reference fields (e.g. UPS reference numbers, the FedEx custom print lines) and on Vesyl-rendered labels. Note that some carriers only use the first entries (e.g. FedEx uses the first two; the Vesyl-rendered label uses the first three).
- printType: string | null
_custom _1 Custom print field 1
- printType: string | null
_custom _2 Custom print field 2
- printType: string | null
_custom _3 Custom print field 3
- saturdayType: boolean | null
_delivery Request Saturday delivery
- specialType: string | null
_rates _eligibility Special rate plan (e.g., usps.connect)
- suppressType: boolean | null
_etd Whether to suppress estimated delivery time