> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # ListFulfillmentsForSingleOrder # Package: orders # Namespace: Fulfillments # Method link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-fulfillments/list-fulfillments-for-single-order.md ## Permission Scopes: Read Orders: SCOPE.DC-STORES.READ-ORDERS ## Introduction Retrieves fulfillments associated with a specified order. --- ## REST API ### Schema ``` Method: listFulfillmentsForSingleOrder Description: Retrieves fulfillments associated with a specified order. URL: https://www.wixapis.com/ecom/v1/fulfillments/orders/{orderId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: orderId Method parameters: param name: orderId | type: none | required: true Return type: ListFulfillmentsForSingleOrderResponse - name: orderWithFulfillments | type: OrderWithFulfillments | description: List of fulfillments associated with the order. - name: orderId | type: string | description: Order GUID. - name: fulfillments | type: array | description: Fulfillments associated with the order. - ONE-OF: - name: trackingInfo | type: FulfillmentTrackingInfo | description: Tracking info. - name: trackingNumber | type: string | description: Shipping/delivery tracking number. - name: shippingProvider | type: string | description: Shipping provider name. Can be either a predefined provider for automatic tracking link generation, or a custom provider name for manual tracking link management. Predefined providers that support automatic tracking link generation: `"fedex"` - FedEx shipping services `"ups"` - UPS shipping services `"usps"` - United States Postal Service `"dhl"` - DHL shipping services `"canadaPost"` - Canada Post shipping services For predefined providers: - The `trackingLink` field will be automatically populated based on the `trackingNumber` - Standard tracking URL formats are used for each carrier - No additional configuration is needed For custom shipping providers: - Use any string value to identify your provider - You must manually provide the `trackingLink` - Useful for local carriers or specialized shipping services - name: trackingLink | type: string | description: URL where customers can track their shipment status. For predefined shipping providers: - Automatically generated based on the `trackingNumber` - Uses the carrier's official tracking URL format - No manual input required For custom shipping providers: - Must be provided when creating the fulfillment - Should be a valid URL to the carrier's tracking page - Can include the tracking number as a parameter if needed - name: customInfo | type: CustomFulfillmentInfo | description: Custom fulfillment info. - name: fieldsData | type: object | description: Custom fulfillment info in key:value form. - name: id | type: string | description: Fulfillment GUID. - name: createdDate | type: string | description: Fulfillment creation date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. - name: lineItems | type: array | description: Line items being fulfilled. - name: id | type: string | description: Line item GUID (mirrors the GUID of the order line item). - name: quantity | type: integer | description: Line item quantity. * If this property isn't passed on creation, it defaults to the number of items not already linked to a fulfillment. * If the order does not have the requested quantity of line items available to add to this fulfillment, the fulfillment will not be created and an error is returned. - name: status | type: string | description: The current status of the fulfillment process. Supported values: + `"Pending"` - Initial state when fulfillment is created but processing hasn't started. + `"Accepted"` - Order has been received and validated for fulfillment. + `"Ready"` - Items have been picked and packed, ready for shipping. + `"In_Delivery"` - Items have been handed over to the shipping carrier. + `"Fulfilled"` - Delivery has been completed successfully. The status typically progresses from Pending → Accepted → Ready → In_Delivery → Fulfilled. Status can be updated manually or automatically depending on your fulfillment workflow. - name: completed | type: boolean | description: Fulfillment handling complete. ``` ### Examples ### List Fulfillments For Single Order ```curl curl -X GET \ 'https://www.wixapis.com/ecom/v1/fulfillments/orders/265c7d98-a7c3-48c4-89cd-bbdc00921eab' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.orders.Fulfillments.listFulfillmentsForSingleOrder(orderId) Description: Retrieves fulfillments associated with a specified order. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: orderId Method parameters: param name: orderId | type: string | description: Order GUID for which to retrieve fulfillments. | required: true Return type: PROMISE - name: orderWithFulfillments | type: OrderWithFulfillments | description: List of fulfillments associated with the order. - name: orderId | type: string | description: Order GUID. - name: fulfillments | type: array | description: Fulfillments associated with the order. - ONE-OF: - name: trackingInfo | type: FulfillmentTrackingInfo | description: Tracking info. - name: trackingNumber | type: string | description: Shipping/delivery tracking number. - name: shippingProvider | type: string | description: Shipping provider name. Can be either a predefined provider for automatic tracking link generation, or a custom provider name for manual tracking link management. Predefined providers that support automatic tracking link generation: `"fedex"` - FedEx shipping services `"ups"` - UPS shipping services `"usps"` - United States Postal Service `"dhl"` - DHL shipping services `"canadaPost"` - Canada Post shipping services For predefined providers: - The `trackingLink` field will be automatically populated based on the `trackingNumber` - Standard tracking URL formats are used for each carrier - No additional configuration is needed For custom shipping providers: - Use any string value to identify your provider - You must manually provide the `trackingLink` - Useful for local carriers or specialized shipping services - name: trackingLink | type: string | description: URL where customers can track their shipment status. For predefined shipping providers: - Automatically generated based on the `trackingNumber` - Uses the carrier's official tracking URL format - No manual input required For custom shipping providers: - Must be provided when creating the fulfillment - Should be a valid URL to the carrier's tracking page - Can include the tracking number as a parameter if needed - name: customInfo | type: CustomFulfillmentInfo | description: Custom fulfillment info. - name: fieldsData | type: object | description: Custom fulfillment info in key:value form. - name: _id | type: string | description: Fulfillment GUID. - name: _createdDate | type: Date | description: Fulfillment creation date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. - name: lineItems | type: array | description: Line items being fulfilled. - name: _id | type: string | description: Line item GUID (mirrors the GUID of the order line item). - name: quantity | type: integer | description: Line item quantity. * If this property isn't passed on creation, it defaults to the number of items not already linked to a fulfillment. * If the order does not have the requested quantity of line items available to add to this fulfillment, the fulfillment will not be created and an error is returned. - name: status | type: string | description: The current status of the fulfillment process. Supported values: + `"Pending"` - Initial state when fulfillment is created but processing hasn't started. + `"Accepted"` - Order has been received and validated for fulfillment. + `"Ready"` - Items have been picked and packed, ready for shipping. + `"In_Delivery"` - Items have been handed over to the shipping carrier. + `"Fulfilled"` - Delivery has been completed successfully. The status typically progresses from Pending → Accepted → Ready → In_Delivery → Fulfilled. Status can be updated manually or automatically depending on your fulfillment workflow. - name: completed | type: boolean | description: Fulfillment handling complete. ``` ### Examples ### Retrieve an order's fulfillments ```javascript import { orderFulfillments } from '@wix/ecom'; export async function myListFulfillmentsForSingleOrderFunction(orderId) { try { const retrievedOrderFulfillments = await orderFulfillments.listFulfillmentsForSingleOrder(orderId); const fulfillmentsArray = retrievedOrderFulfillments.orderWithFulfillments.fulfillments; console.log('Success! Retrieved order fulfillments:', retrievedOrderFulfillments); return retrievedOrderFulfillments; } catch (error) { console.error(error); // Handle the error } } /* Promise resolves to: * * { * "orderWithFulfillments": { * "orderId": "7001d34b-11a6-4a34-8746-dc8ababeca42", * "fulfillments": [ * { * "_id": "00a7eba6-059e-430c-9f8e-9d3d31dd5e9d", * "_createdDate": "2023-03-07T11:51:48.233Z", * "lineItems": [ * { * "_id": "00000000-0000-0000-0000-000000000003", * "quantity": 1 * } * ], * "trackingInfo": { * "trackingNumber": "28674", * "shippingProvider": "dhl", * "trackingLink": "https://www.logistics.dhl/global-en/home/tracking.html?tracking-id=28674" * } * }, * { * "_id": "47451ae1-7325-4ef6-a0d8-fb91ffa88e2e", * "_createdDate": "2023-03-07T10:24:56.406Z", * "lineItems": [ * { * "_id": "00000000-0000-0000-0000-000000000001", * "quantity": 1 * }, * { * "_id": "00000000-0000-0000-0000-000000000002", * "quantity": 1 * } * ], * "trackingInfo": { * "trackingNumber": "43255", * "shippingProvider": "fedex", * "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=43255" * } * } * ] * } * } * */ ``` ### listFulfillmentsForSingleOrder (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { orderFulfillments } from '@wix/ecom'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { orderFulfillments }, // Include the auth strategy and host as relevant }); async function listFulfillmentsForSingleOrder(orderId) { const response = await myWixClient.orderFulfillments.listFulfillmentsForSingleOrder(orderId); }; ``` ---