> 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

# Package: orders

# Namespace: orderFulfillments

# Webhook link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-fulfillments/order-with-fulfillments-updated.md

## Introduction

Triggered when one or more of an order's fulfillments are created, updated, or deleted.

The response contains the order's ID and details about all of its fulfillments following the change.

---

## REST API

### Schema

```
Webhook: Order With Fulfillments Updated
Description: Triggered when one or more of an order's fulfillments are created, updated, or deleted.  The response contains the order's GUID and details about all of its fulfillments following the change.
Event body:
 - name: id | type: string | description: Unique event ID. Allows clients to ignore duplicate events.
 - name: entityFqdn | type: string | description: Fully qualified domain name of the entity associated with the event.
 - name: slug | type: string | description: Event name.
 - name: entityId | type: string | description: ID of the entity associated with the event.
 - name: eventTime | type: string (date-time) | description: Event timestamp.
 - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application such as GDPR.
 - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
 - name: updatedEvent | type: object | description: Updated event details.
    - name: currentEntity | type: OrderWithFulfillments | description: The entity after the update.
        - name: orderId | type: string | description: Order GUID.
        - name: fulfillments | type: array<Fulfillment> | 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<FulfillmentLineItem> | 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.
    - name: modifiedFields | type: Map<string,Value> | description: Fields that were updated and their values before the update.

```

### Examples


```curl
{
  "entityId": "1241d17c-82e1-4a6d-9fae-bd6d2a8073e5",
  "slug": "updated",
  "id": "6e03a96a-3870-4ad7-b814-1f8119310bf4",
  "entityFqdn": "wix.ecom.v1.fulfillments",
  "updatedEvent": {
    "currentEntity": {
      "orderId": "1241d17c-82e1-4a6d-9fae-bd6d2a8073e5",
      "fulfillments": [
        {
          "id": "e110b73a-6896-4327-b5dd-87b4a2e7eaf3",
          "createdDate": "2023-01-25T13:45:20.753Z",
          "lineItems": [
            {
              "id": "00000000-0000-0000-0000-000000000001",
              "quantity": 1
            }
          ],
          "trackingInfo": {
            "trackingNumber": "12345",
            "shippingProvider": "ups",
            "trackingLink": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=12345"
          }
        }
      ]
    }
  },
  "eventTime": "2023-01-25T13:45:21.129908Z",
  "triggeredByAnonymizeRequest": false
}

```

---

## JavaScript SDK

### Schema

```
Webhook: onFulfillmentsUpdated
Description: Triggered when one or more of an order's fulfillments are created, updated, or deleted.  The response contains the order's GUID and details about all of its fulfillments following the change.
Payload: FulfillmentsUpdatedEnvelope
  - name: entity | type: OrderWithFulfillments | description: none
     - name: orderId | type: string | description: Order GUID.
     - name: fulfillments | type: array<Fulfillment> | 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<FulfillmentLineItem> | 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.
  - name: modifiedFields | type: Map<string,Value> | description: Fields that were updated and their values before the update.
     - ONE-OF:
        - name: nullValue | type:  | description: 
        - name: numberValue | type: number | description: 
        - name: stringValue | type: string | description: 
        - name: boolValue | type: boolean | description: 
        - name: structValue | type: object | description: 
        - name: listValue | type: ListValue | description: 
           - name: values | type: array<Value> | description: 
  - name: metadata | type: EventMetadata | description: none
     - name: instanceId | type: string | description: App instance GUID.
     - name: eventType | type: string | description: Event type.
     - name: identity | type: IdentificationData | description: The identification type and identity data.
        - ONE-OF:
           - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site.
           - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site.
           - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.).
           - name: appId | type: string | description: GUID of an app.
        - name: identityType | type: WebhookIdentityType | description: 
             - enum: UNKNOWN, ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
     - name: accountInfo | type: AccountInfo | description: Details related to the account
        - name: accountId | type: string | description: GUID of the Wix account associated with the event.
        - name: parentAccountId | type: string | description: GUID of the parent Wix account. Only included when accountId belongs to a child account.
        - name: siteId | type: string | description: GUID of the Wix site associated with the event. Only included when the event is tied to a specific site.
     - name: _id | type: string | description: Event GUID. With this GUID you can easily spot duplicated events and ignore them.
     - name: entityFqdn | type: string | description: Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
     - name: slug | type: string | description: Event action name, placed at the top level to make it easier for users to dispatch messages. For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
     - name: entityId | type: string | description: GUID of the entity associated with the event.
     - name: eventTime | type: Date | description: Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`.
     - name: triggeredByAnonymizeRequest | type: boolean | description: Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
     - name: originatedFrom | type: string | description: If present, indicates the action that triggered the event.
     - name: entityEventSequence | type: string | description: A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.

```

### Examples


```javascript
import { orderFulfillments } from '@wix/ecom';

orderFulfillments.onFulfillmentsUpdated((event) => {
    // handle your event here
});
```


```javascript
import { createClient, AppStrategy } from '@wix/sdk';
import { orderFulfillments } from '@wix/ecom';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
  }),
  modules: {
      orderFulfillments,
    },
});

wixClient.orderFulfillments.onFulfillmentsUpdated((event) => {
    // handle your event here
});
```

---