Document proposed shipping methods v3 API #503
Conversation
bc-luke
force-pushed
the
shipping-methods
branch
from
b5db8cb
to
b94686e
Compare
| type: string | ||
| example: "Courier delivery" | ||
| shipping_zone: | ||
| description: Zone information. This is available only when "include=shipping_zone" is present in the querystring. |
There was a problem hiding this comment.
Seems like a sensible optional include 👌
reference/shipping.v3.yml
Outdated
| @@ -355,6 +440,41 @@ components: | |||
| - commodity_description | |||
| - international_shipping | |||
| - hs_codes | |||
| shippingMethods: | |||
| title: shippingMethods | |||
| description: Data about the customs information object. | |||
reference/shipping.v3.yml
Outdated
| title: shippingMethods | ||
| description: Data about the customs information object. | ||
| type: object | ||
| x-internal: false |
There was a problem hiding this comment.
I understand this represents that the shippingMethods V3 API is not intended to be a public API. Do we see a reason to hold this back?
There was a problem hiding this comment.
Let's make it public, I have seen at least a few requests from agencies to have an API to query all methods without having to iterate over all the zones.
There was a problem hiding this comment.
FYI, just noticed this also: #490 (comment)
There was a problem hiding this comment.
For a public release, we would probably want to add more properties so we have parity with V2 GET. What we have here are just the minimum to drive the promotions UI. Perhaps we can implement that first and then add the rest and follow that with a public release. Considering the driver for public release relates to querying perhaps we can also keep the hold operations for a future iteration.
reference/shipping.v3.yml
Outdated
| type: string | ||
| example: "Thailand" | ||
| channel_ids: | ||
| description: Channel information. This is available only when "include=shipping_zone" is present in the querystring. |
There was a problem hiding this comment.
Would we not want to always include the Channel IDs? Well, perhaps only when the store has multiple channels?
There was a problem hiding this comment.
Yes probably a reasonable expecation. Updated!
reference/shipping.v3.yml
Outdated
| description: |- | ||
| * `shipping_zone` - shipping zone information | ||
| * `shipping_methods.channel_ids` - IDs of the associated channels |
There was a problem hiding this comment.
| description: |- | |
| * `shipping_zone` - shipping zone information | |
| * `shipping_methods.channel_ids` - IDs of the associated channels | |
| description: |- | |
| * `shipping_zone` - Include shipping zone information with each shipping method. | |
| * `shipping_methods.channel_ids` - Include the IDs of the associated channels for each shipping method. | |
Draft shipping methods API to support new shipping promotions. This doesn't need to be public but perhaps we will choose to release it publicly. To be discussed.
What changed?
Document the parts of a shipping methods API that would be necessary to support the new shipping promotions UI including:
Release notes draft
Anything else?
ping {names}