RateShopping / Book a Shipment
Create a shipping label using a previously retrieved rate quote. You can include optional services by passing the key from shipping_service_options with a selected value.
Query
Comma-separated response fields to include.
Body
Label format (optional, determines the format of label_url in response)
Remote shipment ID from rates response
Required rate/quote ID from the rates response. Use the ‘name’ field from the quote object.
Optional custom messages to print on the shipping label
Optional request token from rates response for validation
Override the default label format for this specific shipment
Required array of shipments to book. Must be an array even when booking a single shipment.
Additional optional services can be included using keys from the shipping_service_options array in the rates response. Value-added services use the pattern value_added_service__* (e.g., value_added_service__VAS_GROUP_ID_CONFIRMATION) Additional inputs use the pattern additional_input__* (e.g., additional_input__SHIPMENT_DESCRIPTION) Common examples: value_added_service__VAS_GROUP_ID_CONFIRMATION: “SIGNATURE” or “DELIVERY_CONFIRMATION” liability_amount: 100.00 (insurance amount) additional_input__SHIPMENT_DESCRIPTION: “Fragile electronics” The available options and their valid values are returned in the shipping_service_options array from the rates endpoint.