Webhooks are used to allow uploads or downloads of data between two platforms based on a trigger. A Generate Label Webhook is used to request a label from a carrier that ShipHero does not have a native integration with; in other words, the carrier connection is made via the API vs a direct connection.
Quoting for carrier methods created using the Generate label webhook methos is not supported, and will not be considered when using the carrier rate shopping tools in ShipHero.
IMPORTANT: Adding carriers using the Generate Label Webhook must be approved prior to use. Please reach out to support@shiphero.com to request approval prior to starting any development.
Required Information
To register the webhook on your account, please provide ShipHero Support with the following information:
- Name of the Method
- Endpoint URL (Ex. https://sumeurl.com/print-label)
-
Tracking URL (Ex. https://www.trackingurl.com/?MyTrakcingNumber= )
- Optional. If the tracking URL is set to https://www.trackingurl.com/?MyTrackingNumber= and the order tracking number is 123456789, then the tracking URL on the label will be: https://www.trackingurl.com/?MyTrackingNumber=123456789
NOTE: When using a 'Generate Label' webhook, set the Carrier to API and select the name of the method you have configured for the method. ShipHero uses the shipping method name as the unique identifier to ensure the carrier returns the correct label type.
Additional Notes for 3PLs
- When a Generate Label Webhook is enabled at the 3PL level you will be able to use it across all your 3PL Clients, including the ability to create an Automation Rule using the specified carrier method.
- If the Generate Label Webhook is enabled at the Child Account level you must navigate to the Child Account to be able to select it on the Order Details page. This setup is required if you have the client setting Use Customer Shipping Accounts enabled.
If you have questions regarding Webhooks, please refer to our Developer site HERE.