Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

/shipments endpoint documentation has some incorrect information #6

Open
justinmcdaniel opened this issue Apr 18, 2023 · 1 comment

Comments

@justinmcdaniel
Copy link

justinmcdaniel commented Apr 18, 2023

Through my own testing, I learned that the /shipments endpoint incorrectly states that "tracking_number" is required. This had me concerned at first as we ship packages without tracking. After testing, I was able to successfully POST to the endpoint without a tracking number when using USPS as the carrier.

If the tracking number field is conditionally required, it would be quite helpful if additional documentation could be added.

Additionally, the docs state that a successful POST returns code 200, but it actually returns code 201.

@justinmcdaniel justinmcdaniel changed the title /shipments endpoint has some incorrect information /shipments endpoint documentation has some incorrect information Apr 18, 2023
@rengler-godaddy
Copy link

Hey Justin,

Thanks for passing this feedback over. I've sent the information over to our product team so that they can review it and make the necessary updates to our documentation. We appreciate you bringing this to our attention.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants