listFulfillmentsForMultipleOrders( )

Retrieves fulfillments associated with multiple specified orders.

Description

The listFulfillmentsForMultipleOrders() function returns a Promise that resolves when the fulfillments are retrieved.

Syntax

function listFulfillmentsForMultipleOrders(orderIds: Array<string>): Promise<ListFulfillmentsForMultipleOrdersResponse>

listFulfillmentsForMultipleOrders Parameters

NAME

TYPE

DESCRIPTION

orderIds

Array<

string

List of order IDs for which to retrieve fulfillments.

Returns

Return Type:

Promise<

ListFulfillmentsForMultipleOrdersResponse

NAME

TYPE

DESCRIPTION

ordersWithFulfillments

Array<

OrderWithFulfillments

List of order IDs and their associated fulfillments.

Was this helpful?

Retrieve fulfillments for 2 orders

Copy Code

1import { orderFulfillments } from 'wix-ecom-backend';
2
3/* Sample orderIds value:
4 * [
5 *   'ed4595fc-4e3d-4ba6-8583-e9e92b97ec8a', '7001d34b-11a6-4a34-8746-dc8ababeca42'
6 * ];
7 */
8
9export async function myListFulfillmentsForMultipleOrdersFunction(orderIds) {
10  try {
11    const retrievedOrdersFulfillments = await orderFulfillments.listFulfillmentsForMultipleOrders(orderIds);
12
13    const firstOrderFulfillments = retrievedOrdersFulfillments[0].fulfillments;
14    const secondOrderFulfillments = retrievedOrdersFulfillments[1].fulfillments;
15    console.log("Success! Retrieved orders' fulfillments:", retrievedOrdersFulfillments);
16
17    return retrievedOrdersFulfillments;
18  } catch (error) {
19    console.error(error);
20    // Handle the error
21  }
22  
23}
24
25
26/* Promise resolves to:
27 *
28 * {
29 *   "ordersWithFulfillments": [
30 *     {
31 *       "orderId": "ed4595fc-4e3d-4ba6-8583-e9e92b97ec8a",
32 *       "fulfillments": [
33 *         {
34 *           "_id": "3247615d-dbbe-4cc8-a410-6ca809f1283f",
35 *           "_createdDate": "2023-02-27T12:02:57.364Z",
36 *           "lineItems": [
37 *             {
38 *               "_id": "00000000-0000-0000-0000-000000000001",
39 *               "quantity": 1
40 *             }
41 *           ],
42 *           "trackingInfo": {
43 *             "trackingNumber": "87236",
44 *             "shippingProvider": "fedex",
45 *             "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=87236"
46 *           }
47 *         }
48 *       ]
49 *     },
50 *     {
51 *       "orderId": "7001d34b-11a6-4a34-8746-dc8ababeca42",
52 *       "fulfillments": [
53 *         {
54 *           "_id": "00a7eba6-059e-430c-9f8e-9d3d31dd5e9d",
55 *           "_createdDate": "2023-03-07T11:51:48.233Z",
56 *           "lineItems": [
57 *             {
58 *               "_id": "00000000-0000-0000-0000-000000000003",
59 *               "quantity": 1
60 *             }
61 *           ],
62 *           "trackingInfo": {
63 *             "trackingNumber": "28674",
64 *             "shippingProvider": "dhl",
65 *             "trackingLink": "https://www.logistics.dhl/global-en/home/tracking.html?tracking-id=28674"
66 *           }
67 *         },
68 *         {
69 *           "_id": "47451ae1-7325-4ef6-a0d8-fb91ffa88e2e",
70 *           "_createdDate": "2023-03-07T10:24:56.406Z",
71 *           "lineItems": [
72 *             {
73 *               "_id": "00000000-0000-0000-0000-000000000001",
74 *               "quantity": 1
75 *             },
76 *             {
77 *               "_id": "00000000-0000-0000-0000-000000000002",
78 *               "quantity": 1
79 *             }
80 *           ],
81 *           "trackingInfo": {
82 *             "trackingNumber": "43255",
83 *             "shippingProvider": "fedex",
84 *             "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=43255"
85 *           }
86 *         }
87 *       ]
88 *     }
89 *   ]
90 * }
91 *
92 */

Retrieve fulfillments for 2 orders (export from backend code)

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { orderFulfillments } from 'wix-ecom-backend';
3
4/* Sample orderIds value:
5 * [
6 *   'ed4595fc-4e3d-4ba6-8583-e9e92b97ec8a', '7001d34b-11a6-4a34-8746-dc8ababeca42'
7 * ];
8 */
9
10export const myListFulfillmentsForMultipleOrdersFunction = webMethod(Permissions.Anyone, async (orderIds) => {
11  try {
12    const retrievedOrdersFulfillments = await orderFulfillments.listFulfillmentsForMultipleOrders(orderIds);
13
14    const firstOrderFulfillments = retrievedOrdersFulfillments[0].fulfillments;
15    const secondOrderFulfillments = retrievedOrdersFulfillments[1].fulfillments;
16    console.log("Success! Retrieved orders' fulfillments:", retrievedOrdersFulfillments);
17
18    return retrievedOrdersFulfillments;
19  } catch (error) {
20    console.error(error);
21    // Handle the error
22  }
23  
24});
25
26
27/* Promise resolves to:
28 *
29 * {
30 *   "ordersWithFulfillments": [
31 *     {
32 *       "orderId": "ed4595fc-4e3d-4ba6-8583-e9e92b97ec8a",
33 *       "fulfillments": [
34 *         {
35 *           "_id": "3247615d-dbbe-4cc8-a410-6ca809f1283f",
36 *           "_createdDate": "2023-02-27T12:02:57.364Z",
37 *           "lineItems": [
38 *             {
39 *               "_id": "00000000-0000-0000-0000-000000000001",
40 *               "quantity": 1
41 *             }
42 *           ],
43 *           "trackingInfo": {
44 *             "trackingNumber": "87236",
45 *             "shippingProvider": "fedex",
46 *             "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=87236"
47 *           }
48 *         }
49 *       ]
50 *     },
51 *     {
52 *       "orderId": "7001d34b-11a6-4a34-8746-dc8ababeca42",
53 *       "fulfillments": [
54 *         {
55 *           "_id": "00a7eba6-059e-430c-9f8e-9d3d31dd5e9d",
56 *           "_createdDate": "2023-03-07T11:51:48.233Z",
57 *           "lineItems": [
58 *             {
59 *               "_id": "00000000-0000-0000-0000-000000000003",
60 *               "quantity": 1
61 *             }
62 *           ],
63 *           "trackingInfo": {
64 *             "trackingNumber": "28674",
65 *             "shippingProvider": "dhl",
66 *             "trackingLink": "https://www.logistics.dhl/global-en/home/tracking.html?tracking-id=28674"
67 *           }
68 *         },
69 *         {
70 *           "_id": "47451ae1-7325-4ef6-a0d8-fb91ffa88e2e",
71 *           "_createdDate": "2023-03-07T10:24:56.406Z",
72 *           "lineItems": [
73 *             {
74 *               "_id": "00000000-0000-0000-0000-000000000001",
75 *               "quantity": 1
76 *             },
77 *             {
78 *               "_id": "00000000-0000-0000-0000-000000000002",
79 *               "quantity": 1
80 *             }
81 *           ],
82 *           "trackingInfo": {
83 *             "trackingNumber": "43255",
84 *             "shippingProvider": "fedex",
85 *             "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=43255"
86 *           }
87 *         }
88 *       ]
89 *     }
90 *   ]
91 * }
92 *
93 */
94