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

Duplicate operations, incorrect HTTP verbs, and poor descriptions in Shipping API v2 #4693

Open
hakanensari opened this issue Mar 18, 2025 · 1 comment
Assignees

Comments

@hakanensari
Copy link

While working on our Ruby client, I encountered several issues in the spec:

Duplicate Operations

linkCarrierAccount appears twice with different HTTP verbs (PUT and POST). Should PUT be removed?

Inconsistent HTTP Verb Usage

Several “get” operations use PUT instead of GET, e.g.:

getCarrierAccounts -> PUT /shipping/v2/carrierAccounts
getCollectionFormHistory -> PUT /shipping/v2/collectionForms/history
getUnmanifestedShipments -> PUT /shipping/v2/unmanifestedShipments

Poor descriptions

Some descriptions are unclear, e.g.:

getCarrierAccounts -> "This API will return Get all carrier accounts for a merchant."

We worked around the duplicate method in our code generator but left other inconsistencies as is. Fixing these in the spec would improve usability for all.

@mafge mafge self-assigned this Mar 20, 2025
@mafge
Copy link
Contributor

mafge commented Mar 20, 2025

Hi @hakanensari,
thanks for reaching out!
I'll forward your feedback to the respective team. Thanks for letting us know!
Best,
Marc
Selling Partner Developer Services

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