Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

List of order IDs and their associated fulfillments' info.

ordersWithFulfillments

Creates multiple fulfillments for one or more orders.


The `bulkCreateFulfillments()` function returns a Promise that resolves when the fulfillments are created.

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

async function bulkCreateFulfillments(ordersWithFulfillments) {
  const response = await orderFulfillments.bulkCreateFulfillments(ordersWithFulfillments);
};

bulkCreateFulfillments: Wix-hosted

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 bulkCreateFulfillments(ordersWithFulfillments) {
  const response = await myWixClient.orderFulfillments.bulkCreateFulfillments(ordersWithFulfillments);
};

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).

bulkCreateFulfillments: Self-hosted

bulkCreateFulfillments

Manage eCommerce - all permissions

Manage Stores - all permissions

Manage Orders

Manage Restaurants - all permissions

BulkCreateFulfillmentResponse

orderId

string

fulfillment

Fulfillment

Creates an order fulfillment.


The `createFulfillment()` function returns a Promise that resolves when the fulfillment is created.

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

async function createFulfillment(orderId, fulfillment) {
  const response = await orderFulfillments.createFulfillment(orderId, fulfillment);
};

createFulfillment: Wix-hosted

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 createFulfillment(orderId, fulfillment) {
  const response = await myWixClient.orderFulfillments.createFulfillment(orderId, fulfillment);
};

createFulfillment: Self-hosted

createFulfillment

CreateFulfillmentResponse

identifiers

DeleteFulfillmentIdentifiers

Deletes an existing order fulfillment.


The `deleteFulfillment()` function returns a Promise that resolves when the fulfillment is deleted.

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

async function deleteFulfillment(identifiers) {
  const response = await orderFulfillments.deleteFulfillment(identifiers);
};

deleteFulfillment: Wix-hosted

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 deleteFulfillment(identifiers) {
  const response = await myWixClient.orderFulfillments.deleteFulfillment(identifiers);
};

deleteFulfillment: Self-hosted

deleteFulfillment

DeleteFulfillmentResponse

List of order IDs for which to retrieve fulfillments.

orderIds

Retrieves fulfillments associated with multiple specified orders.


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

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

async function listFulfillmentsForMultipleOrders(orderIds) {
  const response = await orderFulfillments.listFulfillmentsForMultipleOrders(orderIds);
};

listFulfillmentsForMultipleOrders: Wix-hosted

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 listFulfillmentsForMultipleOrders(orderIds) {
  const response = await myWixClient.orderFulfillments.listFulfillmentsForMultipleOrders(orderIds);
};

listFulfillmentsForMultipleOrders: Self-hosted

listFulfillmentsForMultipleOrders

Read eCommerce - all read permissions

Read Stores - all read permissions

Read Orders

ListFulfillmentsForMultipleOrdersResponse

Order ID for which to retrieve fulfillments.

Retrieves fulfillments associated with a specified order.


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

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

async function listFulfillmentsForSingleOrder(orderId) {
  const response = await orderFulfillments.listFulfillmentsForSingleOrder(orderId);
};

listFulfillmentsForSingleOrder: Wix-hosted

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);
};

listFulfillmentsForSingleOrder: Self-hosted

listFulfillmentsForSingleOrder

ListFulfillmentsForSingleOrderResponse

UpdateFulfillmentIdentifiers

Available options to use when updating a fulfillment.

options

UpdateFulfillmentOptions

Updates a fulfillment's properties.
To update a field's value, include the new value in the `fulfillment` field in the body params.
To remove a field's value, pass `null`.


The `updateFulfillment()` function returns a Promise that resolves when the fulfillment is updated.

> **Note:** Updating line item IDs or fulfilled quantities is not allowed. To update line item IDs or quantities, delete the fulfillment and create it again.

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

async function updateFulfillment(identifiers, options) {
  const response = await orderFulfillments.updateFulfillment(identifiers, options);
};

updateFulfillment: Wix-hosted

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 updateFulfillment(identifiers, options) {
  const response = await myWixClient.orderFulfillments.updateFulfillment(identifiers, options);
};

updateFulfillment: Self-hosted

updateFulfillment

OrderWithFulfillments

Order ID and the orders' associated fulfillments after update.

To use the OrderFulfillments API, install the `@wix/ecom` package using npm or Yarn:
  ```console
npm install @wix/ecom
```

or

```console
yarn add @wix/ecom
```

Then import `{ orderFulfillments }` from `@wix/ecom`:

```js
import { orderFulfillments } from '@wix/ecom'
```
  

ecom_order-fulfillments

ApplicationError

code

data

description

BulkActionMetadata

Number of items that couldn't be processed.

totalFailures

number

Number of items that were successfully processed.

totalSuccesses

Number of failures without details because detailed failure threshold was exceeded.

undetailedFailures

bulkActionMetadata

results

BulkCreateOrderWithFulfillments

fulfillments

BulkOrderFulfillmentsResult

itemMetadata

ItemMetadata

List of order IDs and their associated fulfillments.

fulfillmentId

orderWithFulfillments

CustomFulfillmentInfo

Custom fulfillment info in key:value form.

fieldsData

Order ID and the order's associated fulfillments after deletion.

EventMetadata

Unique event ID.
Allows clients to ignore duplicate webhooks.

A sequence number defining the order of updates to the underlying entity.
For example, given that some entity was updated at 16:00 and than again at 16:01,
it is guaranteed that the sequence number of the second update is strictly higher than the first.
As the consumer, you can use this value to ensure that you handle messages in the correct order.
To do so, you will need to persist this number on your end, and compare the sequence number from the
message against the one you have stored. Given that the stored number is higher, you should ignore the message.

entityEventSequence

Assumes actions are also always typed to an entity_type
Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction

entityFqdn

ID of the entity associated with the event.

entityId

Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z

eventTime

eventType

The identification type and identity data.

identity

IdentificationData

instanceId

If present, indicates the action that triggered the event.

originatedFrom

This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
This is although the created/updated/deleted notion is duplication of the oneof types
Example: created/updated/deleted/started/completed/email_opened

slug

Whether the event was triggered as a result of a privacy regulation application
(for example, GDPR).

triggeredByAnonymizeRequest

boolean

customInfo

trackingInfo

Fulfillment creation date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.

_createdDate

completed

lineItems

Fulfillment status.

Supported values:
+ `"Pending"`
+ `"Accepted"`
+ `"Ready"`
+ `"In_Delivery"`
+ `"Fulfilled"`

status

FulfillmentLineItem

Line item ID (mirrors the ID of the order line item).

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.

Min: `1`
Max: `100000`

quantity

FulfillmentTrackingInfo

Shipping provider. Using one of the following shipping providers will allow for auto-filling the tracking link:
* `'fedex'`
* `'ups'`
* `'usps'`
* `'dhl'`
* `'canadaPost'`

shippingProvider

Tracking link. Auto-filled if a predefined shipping provider is used, otherwise provided on creation.

trackingLink

trackingNumber

FulfillmentsUpdatedEnvelope

entity

metadata

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

appId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

identityType

WebhookIdentityType

Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).

Details about the error in case of failure.

error

Index of the item within the request array. Allows for correlation between request and response items.

originalIndex

Whether the requested action was successful for this item. When `false`, the `error` field is populated.

success

List of fulfillments associated with the order.

OnFulfillmentsUpdatedHandler

event

void

UpdateFulfillmentFulfillment

handler

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.

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

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

onFulfillmentsUpdated: Wix-hosted

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
});

deleteFulfillment( )