As an alternative to importing shipment notifications from Deposco API on a schedule, you may enable shipment import by webhook. If enabled, when an order ships, Deposco will post notification immediately to the webhook URL.
Importantly, these webhook shipment notification payloads are more robust than traditional shipment notifications received via Deposco API. They include additional information about the relationship between bundle/kit SKUs and their components.
Note: Shipment webhooks can only be configured for existing Deposco merchants. If you are creating a new Deposco merchant, save its other options first to create the merchant, then edit the merchant configuration and enable shipment webhooks.
Enable Shipment Webhooks
- In the PackageBee sidebar, click Merchants, then click the Merchant name.
- Check the box Use webhooks for shipments.
- Leave "Webhook Shared Secret" blank.
Note: Shared Secret encryption is pending development in collaboration with Deposco.
- Copy the Deposco URL. This is the webhook URL to be configured in Deposco.
- Click Save Changes.
- In Deposco, configure the webhook URL.
Adjust shipment schedule
Shipment Webhooks replaces the default scheduled API shipment imports, so the connection's shipment sync schedule in PackageBee should be reduced or disabled.
We recommend setting the shipment sync to occur once a day, during off hours. This will function as a backup/fallback sync, to ensure completeness of the webhook imports.
- In the sidebar, click Connections, then click the merchant's Connection name.
- Click the Shipments tab.
- If shipment sync is not yet enabled, in the Control Panel, click Actions > Enable order status import.
- In the Control Panel, click Actions > Edit Schedule.
- Click Delete next to any existing schedules.
- Click Add Schedule > Every day.
- Choose an off-hours time such as 12:00 am.
- Click Save Changes.
Back to: Integration Overview
Comments
Please sign in to leave a comment.