search

postnl / postnl-magento2

This is the official Magento 2 extension for the logistics company PostNL. Add shipping options and parcelshops to your checkout. Create labels with track and trace functionality from the backend.
58 stars 61 forks source link

[QUESTION] Swagger documentation incomplete #327

Closed memen45 closed 7 months ago

memen45 commented 2 years ago

The shop.domain.com/swagger endpoint shows all documentation for the REST API. Adding an admin token as api_key in the top right will show the full list of available endpoints for the admin. Trying PUT /V1/postnl/shipments, there are no parameters required, nor any body. However, on try out, I receive the following response:

{
  "message": "Een ID is nodig. Stel het ID in en probeer het opnieuw."
}

I have searched this whole repository, but I cannot find this text or follow where the ShipmentRepository::create fails. Is the documentation incomplete?

screen

tig-jeffreybranderhorst commented 2 years ago

Hi @memen45 ,

It seems like this is not totally working as intended, I will place this on our backlog to fix. We will release this as soon as possible. If needed we can give you a patch when we have created a fix for this issue.

Have a great day, Jeffrey

memen45 commented 2 years ago

Thanks for your reply! Looking forward to the fix, waiting is not a problem. It would be great though if you could point me to some documentation with regards to the postnl webapi in the meantime. Is there any or does it rely on 'code as documentation' :p

tig-jeffreybranderhorst commented 2 years ago

Hi @memen45 ,

At this moment, we don't have documentation for the API of the extension. If you mean API documentation of PostNL itself this does excist https://developer.postnl.nl/browse-apis/send-and-track/shipping-webservice/documentation/

Have a great day, Jeffrey