Skip to content

Commit 58fc365

Browse files
bc-keelanbc-Vince
andauthored
docs(B2B): B2B-3961 document default 1-year filter on B2B orders API (#1188)
# [B2B-3961] ## What changed? * Update the B2B orders API documentation to define the behaviour of the "Get All Orders" endpoint when `minCreated` and `minUpdated` query parameters are not provided. ## Release notes draft * This update discloses the default filtering behaviour of the B2B "Get All Orders" API, which returns only the last year of orders if no filter parameters are provided. ping @bigcommerce/team-b2b [B2B-3961]: https://bigcommercecloud.atlassian.net/browse/B2B-3961?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: bc-Vince <[email protected]>
1 parent efa3d35 commit 58fc365

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/b2b-edition/specs/api-v3/order/order.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ paths:
5757
- Orders
5858
operationId: get-orders
5959
description: |-
60-
Retrieves limited information for all orders, including B2B-specific information like Company IDs and order extra fields. The response includes orders placed by B2C customers and guest shoppers. Use [Get Order Products](#get-order-products) to retrieve an order's product details, or use the BigCommerce [Orders V2 API](/docs/rest-management/orders) to retrieve all order details except those specific to B2B Edition, like Company ID and extra fields.
60+
Retrieves limited information for all orders, including B2B-specific information like Company IDs and order extra fields. By default, this endpoint limits its response to orders created or updated in the last year. The response includes orders placed by B2C customers and guest shoppers. Use [Get Order Products](#get-order-products) to retrieve an order's product details, or use the BigCommerce [Orders V2 API](/docs/rest-management/orders) to retrieve all order details except those specific to B2B Edition, like Company ID and extra fields.
6161
6262
Use the parameters to filter the returned orders by attributes like associated Company ID, date created, or storefront channel. You can also set the `showExtra` parameter to `true` in order to return extra field values associated with the order.
6363
parameters:

0 commit comments

Comments
 (0)