ShippoAbout this query
Triggers, queries, and actions are the building blocks of Applets. Triggers tell an Applet to start, queries ask a question, and actions are its end result.
Developer info
- Description
- This query returns a shipping label.
- API endpoint slug
- shippo.find_shipping_label
- Runtime method
- performQuery("shippo.find_shipping_label")
Query fields
Shipping label ID Text input > Other
- Label
- What is the Shipping Label's Object ID?
- Helper text
- Tip: use the 'LabelObjectID' ingredient from a Shippo trigger.
- Slug
- shipping_label_id
- Required
- true
- Can have default value
- true
Ingredients
Label URLThe URL to the shipping label for this shipment.
- Slug
- label_url
- Filter code
- Shippo.findShippingLabel.LabelUrl
- Type
- String
- Example
- https://example.com/label.pdf
Label file typeThe file type of the shipping label.
- Slug
- label_file_type
- Filter code
- Shippo.findShippingLabel.LabelFileType
- Type
- String
- Example
- PDF_4x6
Label object IDThe object ID for the Shipping Label.
- Slug
- object_id
- Filter code
- Shippo.findShippingLabel.LabelObjectId
- Type
- String
- Example
- 915d94940ea54c3a80cbfa328722f5a1
StatusThe status of this object.
- Slug
- status
- Filter code
- Shippo.findShippingLabel.Status
- Type
- String
- Example
- SUCCESS
RateThe unique identifier for the rate used to purchase this shipment.
- Slug
- rate
- Filter code
- Shippo.findShippingLabel.Rate
- Type
- String
- Example
- ec9f0d3adc9441449c85d315f0997fd5
EtaThe estimated delivery date for this shipment.
- Slug
- eta
- Filter code
- Shippo.findShippingLabel.Eta
- Type
- Date with time (ISO8601)
- Example
- 2020-07-08T04:17:06.000+05:00
Tracking numberThe tracking number for this shipment.
- Slug
- tracking_number
- Filter code
- Shippo.findShippingLabel.TrackingNumber
- Type
- String
- Example
- 9499907123456123456781
Tracking statusThe status of the tracking for this shipment.
- Slug
- tracking_status
- Filter code
- Shippo.findShippingLabel.TrackingStatus
- Type
- String
- Example
- UNKOWN
Tracking URL providerThe URL to the tracking page for this shipment.
- Slug
- tracking_url_provider
- Filter code
- Shippo.findShippingLabel.TrackingUrlProvider
- Type
- String
- Example
- https://example.com/tracking
Commercial invoice URLThe URL to the commercial invoice for this shipment.
- Slug
- commercial_invoice_url
- Filter code
- Shippo.findShippingLabel.CommercialInvoiceUrl
- Type
- String
- Example
- https://example.com/invoice.pdf
Qr code URLThe URL to the QR code for this shipment.
- Slug
- qr_code_url
- Filter code
- Shippo.findShippingLabel.QrCodeUrl
- Type
- String
- Example
- https://example.com/qr_code.pdf
Object stateThe state of this object.
- Slug
- object_state
- Filter code
- Shippo.findShippingLabel.ObjectState
- Type
- String
- Example
- VALID
Object ownerThe email address of the owner of this object.
- Slug
- object_owner
- Filter code
- Shippo.findShippingLabel.ObjectOwner
- Type
- String
- Example
- example@email.com
Object createdThe date and time this object was created.
- Slug
- object_created
- Filter code
- Shippo.findShippingLabel.ObjectCreated
- Type
- Date with time (ISO8601)
- Example
- 2020-07-08T04:17:06.000+05:00