Deprecated.
This function will continue to work until September 4, 2024, but a newer version is available at
wix-ecom-backend.OrderFulfillments.createFulfillment()
.
We recommend you migrate to the new Wix eCommerce APIs as soon as possible.
If this function is already in your code, it will continue to work.
To stay compatible with future changes, migrate to
wix-ecom-backend.OrderFulfillments.createFulfillment()
.
To migrate to the new function:
Add the new import statement:
import { orderFulfillments } from "wix-ecom-backend";
Look for any code that uses wixStoresBackend.createFulfillment()
,
and replace it with orderFulfillments.createFulfillment()
.
Update your code to work with the new createFulfillment()
response properties.
Test your changes to make sure your code behaves as expected.
Creates a new fulfillment in an order.
The createFulfillment()
function returns a Promise that is resolved
to an object with the fulfillmentId
and the updated Order
when the fulfillment is created.
function createFulfillment(
orderId: string,
fulfillment: FulfillmentInfo,
): Promise<NewFulfillmentAndOrder>;
ID of the order to create the fulfillment in.
Fulfillment information.
import wixStoresBackend from "wix-stores-backend";
const fulfillment = {
lineItems: [{ index: 1, quantity: 1 }],
trackingInfo: {
shippingProvider: "fedex",
trackingLink:
"https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=12345",
trackingNumber: "12345",
},
};
export function createFulfillment(orderId) {
return wixStoresBackend
.createFulfillment(orderId, fulfillment)
.then((updatedOrder) => {
// Fulfillment created
const fulfillmentId = updatedOrder.id;
const orderId = updatedOrder.order._id;
const fulfillmentStatus = updatedOrder.order.fulfillmentStatus;
})
.catch((error) => {
// Fulfillment not created
console.error(error);
});
}
/* Returns a promise that resolves to:
*
* {
* "id": "75159953-1234-4490-9b4a-9301f9264427",
* "order": {
* "_id": "d5d43d01-d9a4-4cc2-b257-61184b881447",
* "_updatedDate": "2020-05-27T12:20:37.994Z",
* "buyerLanguage": "en",
* "channelInfo": {
* "type": "WEB"
* },
* "enteredBy": {
* "id": "f6c2c0f9-4e9f-a58d-a02d-9af2497294d9",
* "identityType": "MEMBER"
* },
* "billingInfo": {
* "address": {
* "formatted": "My company name\n235 W 23rd St\nNew York, New York 10011\nUnited States\n+15555555555",
* "city": "New York",
* "country": "USA",
* "addressLine": "235 W 23rd St",
* "postalCode": "10011",
* "subdivision": "NY"
* },
* "firstName": "John",
* "lastName": "Doe",
* "email": "john.doe@somedomain.com",
* "phone": "+15555555555",
* "company": "My company name",
* "externalTransactionId": "7c03ca74-eaf5-4541-8678-9b857634fdcb",
* "paidDate": "2020-05-27T12:20:37.994Z",
* "paymentMethod": "VISA",
* "paymentGatewayTransactionId": "29A06193U6234935D",
* "paymentProviderTransactionId": "7c03ca74-eaf5-4541-8678-9b857634fdcb"
* },
* "buyerInfo": {
* "id": "f6c2c0f9-4e9f-a58d-a02d-9af2497294d9",
* "identityType": "MEMBER",
* "firstName": "John",
* "lastName": "Doe",
* "phone": "+15555555555",
* "email": "john.doe@somedomain.com"
* },
* "_dateCreated": "2020-05-27T12:20:37.966Z",
* "currency": "ILS",
* "fulfillmentStatus": "FULFILLED",
* "archived": false,
* "activities": [
* {
* "type": "ORDER_PLACED",
* "timestamp": "2020-05-27T12:20:37.966Z"
* },
* {
* "type": "ORDER_PAID",
* "timestamp": "2020-05-27T12:20:37.994Z"
* }
* ],
* "number": 10019,
* "paymentStatus": "PAID",
* "shippingInfo": {
* "deliveryOption": "Free Shipping",
* "estimatedDeliveryTime": "4:30pm",
* "shippingRegion": "Domestic",
* "shipmentDetails": {
* "address": {
* "formatted": "company name\n235 W 23rd St\nNew York, New York 10011\nUnited States\n5555555555",
* "city": "New York",
* "country": "USA",
* "addressLine": "235 W 23rd St",
* "postalCode": "10011",
* "subdivision": "NY"
* },
* "firstName": "John",
* "lastName": "Doe",
* "email": "john.doe@somedomain.com",
* "phone": "5555555555",
* "company": "company name",
* "tax": 0,
* "discount": 0,
* "priceData": null
* },
* "pickupDetails": null
* },
* "lineItems": [
* {
* "index": 1,
* "quantity": 1,
* "price": 5,
* "name": "my product's name",
* "translatedName": "Nombre traducido",
* "productId": "3fb6a3c8-988b-8755-04bd-5c59ae0b18ea",
* "totalPrice": 5,
* "lineItemType": "PHYSICAL",
* "options": [
* {
* "option": "Size",
* "selection": "Medium"
* }
* ],
* "customTextFields": [
* {
* "title": "Notes for delivery",
* "value": "Please leave at front door"
* }
* ],
* "weight": 1.42,
* "sku": "36523641234523",
* "discount": 0,
* "tax": 5,
* "taxIncludedInPrice": true,
* "priceData": {
* "price": "5",
* "totalPrice": 5,
* "taxIncludedInPrice": true
* },
* "mediaItem": null
* }
* ],
* "totals": {
* "discount": 0,
* "quantity": 1,
* "shipping": 0,
* "subtotal": 5,
* "tax": 0,
* "total": 5,
* "weight": 1.42
* },
* "weightUnit": "KG",
* "customField": {
* "value": "Please call when outside",
* "title": "Notes for delivery",
* "translatedTitle": "Notas de entrega"
* },
* "fulfillments": [
* {
* "id": "cfbc5122-8766-4209-8bf4-611a10f9c546",
* "dateCreated": "2020-06-10T15:38:10.938Z",
* "lineItems": [
* {
* "index": 1,
* "quantity": 1
* }
* ],
* "trackingInfo": {
* "trackingNumber": "12345",
* "shippingProvider": "fedex",
* "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=12345"
* },
* }
* ],
* "discount": null
* }
* }
*
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.