listFulfillmentsForSingleOrder( )

Retrieves fulfillments associated with a specified order.

Description

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

Syntax

function listFulfillmentsForSingleOrder(orderId: string): Promise<ListFulfillmentsForSingleOrderResponse>

listFulfillmentsForSingleOrder Parameters

NAME

TYPE

DESCRIPTION

orderId

string

Order ID for which to retrieve fulfillments.

Returns

Return Type:

Promise<

ListFulfillmentsForSingleOrderResponse

NAME

TYPE

DESCRIPTION

orderWithFulfillments

OrderWithFulfillments

List of fulfillments associated with the order.

Was this helpful?

Retrieve an order's fulfillments

Copy Code

1import { orderFulfillments } from 'wix-ecom-backend';
2
3// Sample orderId value: '7001d34b-11a6-4a34-8746-dc8ababeca42';
4
5export async function myListFulfillmentsForSingleOrderFunction(orderId) {
6  try {
7    const retrievedOrderFulfillments = await orderFulfillments.listFulfillmentsForSingleOrder(orderId);
8
9    const fulfillmentsArray = retrievedOrderFulfillments.orderWithFulfillments.fulfillments;
10    console.log('Success! Retrieved order fulfillments:', retrievedOrderFulfillments);
11
12    return retrievedOrderFulfillments;
13  } catch (error) {
14    console.error(error);
15    // Handle the error
16  }
17  
18}
19
20/* Promise resolves to:
21 *
22 * {
23 *   "orderWithFulfillments": {
24 *     "orderId": "7001d34b-11a6-4a34-8746-dc8ababeca42",
25 *     "fulfillments": [
26 *       {
27 *         "_id": "00a7eba6-059e-430c-9f8e-9d3d31dd5e9d",
28 *         "_createdDate": "2023-03-07T11:51:48.233Z",
29 *         "lineItems": [
30 *           {
31 *             "_id": "00000000-0000-0000-0000-000000000003",
32 *             "quantity": 1
33 *           }
34 *         ],
35 *         "trackingInfo": {
36 *           "trackingNumber": "28674",
37 *           "shippingProvider": "dhl",
38 *           "trackingLink": "https://www.logistics.dhl/global-en/home/tracking.html?tracking-id=28674"
39 *         }
40 *       },
41 *       {
42 *         "_id": "47451ae1-7325-4ef6-a0d8-fb91ffa88e2e",
43 *         "_createdDate": "2023-03-07T10:24:56.406Z",
44 *         "lineItems": [
45 *           {
46 *             "_id": "00000000-0000-0000-0000-000000000001",
47 *             "quantity": 1
48 *           },
49 *           {
50 *             "_id": "00000000-0000-0000-0000-000000000002",
51 *             "quantity": 1
52 *           }
53 *         ],
54 *         "trackingInfo": {
55 *           "trackingNumber": "43255",
56 *           "shippingProvider": "fedex",
57 *           "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=43255"
58 *         }
59 *       }
60 *     ]
61 *   }
62 * }
63 *
64 */

Retrieve an order's fulfillments (export from backend code)

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { orderFulfillments } from 'wix-ecom-backend';
3
4export const myListFulfillmentsForSingleOrderFunction = webMethod(Permissions.Anyone, async (orderId) => {
5  try {
6    const retrievedOrderFulfillments = await orderFulfillments.listFulfillmentsForSingleOrder(orderId);
7
8    const fulfillmentsArray = retrievedOrderFulfillments.orderWithFulfillments.fulfillments;
9    console.log('Success! Retrieved order fulfillments:', retrievedOrderFulfillments);
10
11    return retrievedOrderFulfillments;
12  } catch (error) {
13    console.error(error);
14    // Handle the error
15  }
16});
17
18/* Promise resolves to:
19 *
20 * {
21 *   "orderWithFulfillments": {
22 *     "orderId": "7001d34b-11a6-4a34-8746-dc8ababeca42",
23 *     "fulfillments": [
24 *       {
25 *         "_id": "00a7eba6-059e-430c-9f8e-9d3d31dd5e9d",
26 *         "_createdDate": "2023-03-07T11:51:48.233Z",
27 *         "lineItems": [
28 *           {
29 *             "_id": "00000000-0000-0000-0000-000000000003",
30 *             "quantity": 1
31 *           }
32 *         ],
33 *         "trackingInfo": {
34 *           "trackingNumber": "28674",
35 *           "shippingProvider": "dhl",
36 *           "trackingLink": "https://www.logistics.dhl/global-en/home/tracking.html?tracking-id=28674"
37 *         }
38 *       },
39 *       {
40 *         "_id": "47451ae1-7325-4ef6-a0d8-fb91ffa88e2e",
41 *         "_createdDate": "2023-03-07T10:24:56.406Z",
42 *         "lineItems": [
43 *           {
44 *             "_id": "00000000-0000-0000-0000-000000000001",
45 *             "quantity": 1
46 *           },
47 *           {
48 *             "_id": "00000000-0000-0000-0000-000000000002",
49 *             "quantity": 1
50 *           }
51 *         ],
52 *         "trackingInfo": {
53 *           "trackingNumber": "43255",
54 *           "shippingProvider": "fedex",
55 *           "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=43255"
56 *         }
57 *       }
58 *     ]
59 *   }
60 * }
61 *
62 */
63