createFulfillment - Fulfillment Module Reference

This documentation provides a reference to the createFulfillment method. This belongs to the Fulfillment Module.

This method creates a fulfillment.

Example

const fulfillment =
  await fulfillmentModuleService.createFulfillment({
    location_id: "loc_123",
    provider_id: "webshipper",
    delivery_address: {
      address_1: "4120 Auto Park Cir",
      country_code: "us",
    },
    items: [
      {
        title: "Shirt",
        sku: "SHIRT",
        quantity: 1,
        barcode: "ABCED",
      },
    ],
    labels: [
      {
        tracking_number: "1234567",
        tracking_url: "https://example.com/tracking",
        label_url: "https://example.com/label",
      },
    ],
    order: {},
  })

Parameters

dataCreateFulfillmentDTORequired

The fulfillment to be created.

sharedContextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<FulfillmentDTO>Required

The created fulfillment.