Skip to content

Commit

Permalink
[GH-ISSUE] - [ #173] Order Product API does not return `order_product…
Browse files Browse the repository at this point in the history
…_id` (#193)

<!-- Ticket number or summary of work -->
# [DEVDOCS-5847]


## What changed?
<!-- Provide a bulleted list in the present tense -->
* Add note indicating that the response `id` is required when creating
order shipments

## Release notes draft
<!-- Provide an entry for the release notes using simple, conversational
language. Don't be too technical. Explain how the change will benefit
the merchant and link to the feature.

Examples:
* The newly-released [X feature] is now available to use. Now, you’ll be
able to [perform Y action].
* We're happy to announce [X feature], which can help you [perform Y
action].
* [X feature] helps you to create [Y response] using the [Z query
parameter]. Now, you can deliver [ex, localized shopping experiences for
your customers].
* Fixed a bug in the [X endpoint]. Now the [Y field] will appear when
you click [Z option]. -->
* Added a note to /v2/orders/{order_id}/shipments letting merchants know
that the 'id' response is needed when creating order shipments.

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->

ping {names}


[DEVDOCS-5847]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-5847?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

---------

Co-authored-by: Traci Porter <traci.porter@bigcommerce.com>
Co-authored-by: Sarah Riehl <sarah.riehl@bigcommerce.com>
  • Loading branch information
3 people committed May 9, 2024
1 parent 66bbf56 commit 1097e27
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion reference/orders.v2.oas2.yml
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,10 @@ paths:
- $ref: '#/components/parameters/Accept'
- $ref: '#/components/parameters/order_id_path'
get:
description: Lists 50 order products on an order using `order_id`. By default, items sort from lowest to highest according to a newly created ID, separate from the `order_id` and the `product_id`.
description: |-
Lists 50 order products on an order using `order_id`. By default, items are sorted from lowest to highest according to a newly created ID, separate from the `order_id` and the `product_id`.
**Note**: The response `id` is required when you [create order shipments](/docs/store-operations/orders#creating-order-shipments).
summary: List Order Products
parameters:
- $ref: '#/components/parameters/ContentType'
Expand Down

0 comments on commit 1097e27

Please sign in to comment.