In the webhook documentation, I see that the “name” field in the response echoes back the same value of the same-named field in the request. During testing, we noticed that if we don’t echo back this field, the ShipHero user receives the following error: Package name response does not match the expected format: ‘ ’
I don’t see documentation specific to this field, or behaviours, and I want to know the following:
- Is echoing back the exact value (e.g., Package 1) the expected and required behavior for successful package matching?
- Should we always expect the “Package #” convention?
- Is there any additional significance to this field we should be aware of?
Hoping for clarity on this one. Thanks.
Hi Iramos,
Thank you for your inquiry. The Package name convention should remain consistent across webhook bodies and echoing the value back is what’s required for successful package matching. It is helpful to have internally consistent values for package identification other than tracking number on these webhook operation since tracking is not always available.
Thanks,
Hi Nathan,
Thanks for the response.
To clarify, we’re providing carrier services for a ShipHero user.
Since it’s the user’s responsibility to assign the package name, how is “internally consistent” identification ensured on the ShipHero side? And how is this value used within the ShipHero platform? Is there anything further we need to be aware of regarding this field to ensure proper operation?
Thanks!
The package name is automatically assigned via the process of packing in the ShipHero UI, in this case it is used in order to assign the correct tracking and label information to the correct package within the shipment.
Thanks Nathan, it makes sense now.
One last question: are these values unique for a given time period, or for all time?
They are only unique within the context of a shipment. So for each new shipment the identifier goes back to Package #1 for the first package.