About Order Fulfillments

An order fulfillment refers to the process of preparing and delivering orders to customers. This process usually involves receiving orders, picking the products from inventory, packing them securely, providing tracking information, and shipping them to the customer's address.

A fulfillment object contains information about an order's shipping provider, tracking details, and the line items associated with the fulfillment.

With the Order Fulfillments API you can:

Was this helpful?
Yes
No

Order Fulfillments: Sample Use Cases & Flows

This article shares a possible use case your app could support, as well as a sample flow that could support the use case. This can be a helpful jumping off point as you plan your app's implementation.

Create a fulfillment for a new order

You can use webhooks to listen for when an order is placed, and then create a fulfillment for the new order.

  1. Use the Order Approved Webhook to listen for incoming approved orders.

  2. When a new order comes in, save the order ID. This can be found as the value of the entityId or actionEvent.body.order.id fields in the Order Approved Webhook's payload.

  3. Pass the new order ID and the new fulfillment info to the Create Fulfillment endpoint. The response holds information about the newly created fulfillment and the ID of its associated order.

Was this helpful?
Yes
No

Fulfillments Object

Create and manage eCommerce order fulfillments

Attributes
orderIdstringminLength 1maxLength 100
Order ID.

fulfillmentsArray <Fulfillment>
Fulfillments associated with the order.
Was this helpful?
Yes
No

GetList Fulfillments For Single Order

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves fulfillments associated with a specified order.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Read eCommerce - all read permissions
Read Orders
Read Stores - all read permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/ecom/v1/fulfillments/orders/{orderId}

Was this helpful?
Yes
No

PostList Fulfillments For Multiple Orders

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves fulfillments associated with multiple specified orders.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Read eCommerce - all read permissions
Read Orders
Read Stores - all read permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/ecom/v1/fulfillments/list-by-ids

Was this helpful?
Yes
No

PostCreate Fulfillment

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates an order fulfillment.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/ecom/v1/fulfillments/orders/{orderId}/create-fulfillment

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PatchUpdate Fulfillment

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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.

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.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
PATCH
https://www.wixapis.com/ecom/v1/fulfillments/{fulfillment.id}/orders/{orderId}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

DeleteDelete Fulfillment

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deletes an existing order fulfillment.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
DELETE
https://www.wixapis.com/ecom/v1/fulfillments/{fulfillmentId}/orders/{orderId}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostBulk Create Fulfillments

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates multiple fulfillments for one or more orders.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/ecom/v1/fulfillments/orders/bulk/create-fulfillments

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

Order With Fulfillments Updated

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Read eCommerce - all read permissions
Read Orders
Read Stores - all read permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.ecom.v1.fulfillments.

slugstring
Event name. Expected updated.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

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

originatedFromstring
If present, indicates the action that triggered the event.

updatedEventobject
Event information.
Was this helpful?
Yes
No