11.1.3

CHANGELOG.md

@@ -5,6 +5,9 @@ All notable changes to the ordercloud-javascript-sdk will be documented in this
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# [11.1.3] - 2025-11-10
+- Bring SDK up to date with API v1.0.426
+
 # [11.1.2] - 2025-08-20
 - Bring SDK up to date with API v1.0.412
 

docs/variables/Me.html

@@ -17,7 +17,7 @@
 <h1>Variable Me</h1></div>
 <div class="tsd-signature">Me<span class="tsd-signature-symbol">:</span> <a href="../classes/Resources.Me.html" class="tsd-signature-type" data-tsd-kind="Class">Me</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/Me.ts#L2011">api/Me.ts:2011</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/Me.ts#L2012">api/Me.ts:2012</a></li></ul></aside></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/variables/Shipments.html

@@ -17,7 +17,7 @@
 <h1>Variable Shipments</h1></div>
 <div class="tsd-signature">Shipments<span class="tsd-signature-symbol">:</span> <a href="../classes/Resources.Shipments.html" class="tsd-signature-type" data-tsd-kind="Class">Shipments</a></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/Shipments.ts#L319">api/Shipments.ts:319</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/Shipments.ts#L320">api/Shipments.ts:320</a></li></ul></aside></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

package.json

@@ -2,7 +2,7 @@
   "name": "ordercloud-javascript-sdk",
   "description": "The offical Javascript SDK for the Ordercloud ecommerce API",
   "author": "Four51 OrderCloud",
-  "version": "11.1.2",
+  "version": "11.1.3",
   "main": "dist/index.js",
   "umd:main": "dist/index.umd.js",
   "module": "dist/index.esm.js",

src/api/Me.ts

@@ -1565,14 +1565,15 @@ class Me {
     * 
     * @param shipmentID ID of the shipment.
     * @param listOptions.orderID ID of the order.
+    * @param listOptions.sortBy Comma-delimited list of fields to sort by.
     * @param listOptions.page Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
     * @param listOptions.pageSize Number of results to return per page.
     * @param listOptions.filters An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
     * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
     * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
     * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
     */
-    public async ListShipmentItems<TShipmentItem extends ShipmentItem>(shipmentID: string, listOptions: { orderID?: string, page?: number, pageSize?: number, filters?: Filters } = {}, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<ListPage<TShipmentItem>>>{
+    public async ListShipmentItems<TShipmentItem extends ShipmentItem>(shipmentID: string, listOptions: { orderID?: string, sortBy?: Sortable<'Me.ListShipmentItems'>, page?: number, pageSize?: number, filters?: Filters } = {}, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<ListPage<TShipmentItem>>>{
         const impersonating = this.impersonating;
         this.impersonating = false;
         return await http.get(`/me/shipments/${shipmentID}/items`, { ...requestOptions, impersonating, params: listOptions  } )

src/api/Shipments.ts

@@ -172,14 +172,15 @@ class Shipments {
     * Check out the {@link https://ordercloud.io/api-reference/orders-and-fulfillment/shipments/list-items|api docs} for more info 
     * 
     * @param shipmentID ID of the shipment.
+    * @param listOptions.sortBy Comma-delimited list of fields to sort by.
     * @param listOptions.page Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
     * @param listOptions.pageSize Number of results to return per page.
     * @param listOptions.filters An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
     * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
     * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
     * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
     */
-    public async ListItems<TShipmentItem extends ShipmentItem>(shipmentID: string, listOptions: { page?: number, pageSize?: number, filters?: Filters } = {}, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<ListPage<TShipmentItem>>>{
+    public async ListItems<TShipmentItem extends ShipmentItem>(shipmentID: string, listOptions: { sortBy?: Sortable<'Shipments.ListItems'>, page?: number, pageSize?: number, filters?: Filters } = {}, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<ListPage<TShipmentItem>>>{
         const impersonating = this.impersonating;
         this.impersonating = false;
         return await http.get(`/shipments/${shipmentID}/items`, { ...requestOptions, impersonating, params: listOptions  } )

src/models/Sortable.ts

@@ -52,6 +52,7 @@ interface SortableMap {
 'Me.ListPromotions': ('Name' | 'ID' | 'Code' | 'StartDate' | 'ExpirationDate' | 'EligibleExpression' | 'ValueExpression' | 'CanCombine' | 'AutoApply' | 'Active' | 'Priority' | '!Name' | '!ID' | '!Code' | '!StartDate' | '!ExpirationDate' | '!EligibleExpression' | '!ValueExpression' | '!CanCombine' | '!AutoApply' | '!Active' | '!Priority')[]
 'Me.ListBuyerSellers': ('Name' | 'ID' | '!Name' | '!ID')[]
 'Me.ListShipments': ('DateShipped' | 'OwnerID' | 'ID' | 'BuyerID' | 'Shipper' | 'DateDelivered' | 'Cost' | '!DateShipped' | '!OwnerID' | '!ID' | '!BuyerID' | '!Shipper' | '!DateDelivered' | '!Cost')[]
+'Me.ListShipmentItems': ('OrderID' | 'LineItemID' | '!OrderID' | '!LineItemID')[]
 'Me.ListSpendingAccounts': ('Name' | 'ID' | '!Name' | '!ID')[]
 'Me.ListSubscriptions': ('NextOrderDate' | 'LastOrderDate' | 'DateCreated' | 'ID' | 'Interval' | 'EndDate' | 'FromCompanyID' | 'FromUserID' | 'ToCompanyID' | '!NextOrderDate' | '!LastOrderDate' | '!DateCreated' | '!ID' | '!Interval' | '!EndDate' | '!FromCompanyID' | '!FromUserID' | '!ToCompanyID')[]
 'Me.ListSubscriptionItems': ('DateAdded' | 'ID' | 'ProductID' | '!DateAdded' | '!ID' | '!ProductID')[]
@@ -81,6 +82,7 @@ interface SortableMap {
 'Promotions.List': ('Name' | 'ID' | 'Code' | 'StartDate' | 'ExpirationDate' | 'EligibleExpression' | 'ValueExpression' | 'CanCombine' | 'AutoApply' | 'Active' | 'Priority' | '!Name' | '!ID' | '!Code' | '!StartDate' | '!ExpirationDate' | '!EligibleExpression' | '!ValueExpression' | '!CanCombine' | '!AutoApply' | '!Active' | '!Priority')[]
 'SecurityProfiles.List': ('ID' | 'Name' | '!ID' | '!Name')[]
 'Shipments.List': ('DateShipped' | 'OwnerID' | 'ID' | 'BuyerID' | 'Shipper' | 'DateDelivered' | 'Cost' | '!DateShipped' | '!OwnerID' | '!ID' | '!BuyerID' | '!Shipper' | '!DateDelivered' | '!Cost')[]
+'Shipments.ListItems': ('OrderID' | 'LineItemID' | '!OrderID' | '!LineItemID')[]
 'Specs.List': ('ListOrder' | 'Name' | 'ID' | '!ListOrder' | '!Name' | '!ID')[]
 'Specs.ListOptions': ('ListOrder' | 'ID' | '!ListOrder' | '!ID')[]
 'Specs.ListProductAssignments': ('SpecID' | 'ProductID' | 'DefaultOptionID' | 'DefaultValue' | '!SpecID' | '!ProductID' | '!DefaultOptionID' | '!DefaultValue')[]
@@ -147,6 +149,7 @@ type SortableEndpoint = 'AdminAddresses.List' |
 'Me.ListPromotions' | 
 'Me.ListBuyerSellers' | 
 'Me.ListShipments' | 
+'Me.ListShipmentItems' | 
 'Me.ListSpendingAccounts' | 
 'Me.ListSubscriptions' | 
 'Me.ListSubscriptionItems' | 
@@ -176,6 +179,7 @@ type SortableEndpoint = 'AdminAddresses.List' |
 'Promotions.List' | 
 'SecurityProfiles.List' | 
 'Shipments.List' | 
+'Shipments.ListItems' | 
 'Specs.List' | 
 'Specs.ListOptions' | 
 'Specs.ListProductAssignments' |