Skip to content

Latest commit

 

History

History
27 lines (24 loc) · 37.1 KB

transaction.md

File metadata and controls

27 lines (24 loc) · 37.1 KB

Transaction

Fields

Field Type Required Description Example
commercial_invoice_url Optional[str] ➖ A URL pointing to the commercial invoice as a 8.5x11 inch PDF file.
A value will only be returned if the Transactions has been processed successfully and if the shipment is international.
created_by Optional[components.CreatedBy] ➖ N/A
eta Optional[str] ➖ The estimated time of arrival according to the carrier.
label_file_type Optional[components.LabelFileTypeEnum] ➖ Print format of the label. If empty, will use the default format set from
the Shippo dashboard.		 PDF_4x6
label_url Optional[str] ➖ A URL pointing directly to the label in the format you've set in your settings.
A value will only be returned if the Transactions has been processed successfully.		 https://shippo-delivery.s3.amazonaws.com/70ae8117ee1749e393f249d5b77c45e0.pdf?Signature=vDw1ltcyGveVR1OQoUDdzC43BY8%3D&Expires=1437093830&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA
messages List[components.ResponseMessage] ➖ N/A
metadata Optional[str] ➖ A string of up to 100 characters that can be filled with any additional information you want to
attach to the object.
object_created date ➖ Date and time of Transaction creation.
object_id Optional[str] ➖ Unique identifier of the given Transaction object. 915d94940ea54c3a80cbfa328722f5a1
object_owner Optional[str] ➖ Username of the user who created the Transaction object. [email protected]
object_state Optional[components.ObjectStateEnum] ➖ Indicates the validity of the enclosing object
object_updated date ➖ Date and time of last Transaction update.
parcel Optional[str] ➖ Object ID of the Parcel object that is being shipped. e94c7fdfdc7b495dbb390a28d929d90a
qr_code_url Optional[str] ➖ A URL pointing directly to the QR code in PNG format.
A value will only be returned if requested using qr_code_requested flag and the carrier provides such an option.		 https://shippo-delivery.s3.amazonaws.com/96_qr_code.pdf?Signature=PEdWrp0mFWAGwJp7FW3b%2FeA2eyY%3D&Expires=1385930652&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA
rate Optional[components.TransactionRate] ➖ ID of the Rate object for which a Label has to be obtained.
If you purchase a label by calling the transaction endpoint without a rate (instalabel),
this field will be a simplified Rate object in the Transaction model returned from the POST request.

Note, only rates less than 7 days old can be purchased to ensure up-to-date pricing.
status Optional[components.TransactionStatusEnum] ➖ Indicates the status of the Transaction. SUCCESS
test Optional[bool] ➖ Indicates whether the object has been created in test mode.
tracking_number Optional[str] ➖ The carrier-specific tracking number that can be used to track the Shipment.
A value will only be returned if the Rate is for a trackable Shipment and if the Transactions has been processed successfully.		 9499907123456123456781
tracking_status Optional[components.TrackingStatusEnum] ➖ Indicates the high level status of the shipment. DELIVERED
tracking_url_provider Optional[str] ➖ A link to track this item on the carrier-provided tracking website.
A value will only be returned if tracking is available and the carrier provides such a service.		 https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9499907123456123456781