www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createFulfillment/page.mdx
import { TypeList } from "docs-ui"
This documentation provides a reference to the createFulfillment method. This belongs to the Fulfillment Module.
You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.
</Note>This method creates a fulfillment and call the provider to create a fulfillment.
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: {},
})
<TypeList types={[{"name":"data","type":"CreateFulfillmentDTO","description":"The fulfillment to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"string","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"string","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"Omit<CreateFulfillmentAddressDTO, "fulfillment_id">","description":"The address associated with the fulfillment. It's used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"company","type":"null \| string","description":"The company of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"null \| string","description":"The first name of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"null \| string","description":"The last name of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"null \| string","description":"The first line of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"null \| string","description":"The second line of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"null \| string","description":"The city of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"null \| string","description":"The ISO 2 character country code of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"null \| string","description":"The lower-case ISO 3166-2 province of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"null \| string","description":"The postal code of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"null \| string","description":"The phone of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"Omit<CreateFulfillmentItemDTO, "fulfillment_id">[]","description":"The items associated with the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"string","description":"The title of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"string","description":"The SKU of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"number","description":"The quantity of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"string","description":"The barcode of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"null \| string","description":"The associated line item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"null \| string","description":"The associated inventory item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"location","type":"StockLocationDTO","description":"The associated location's data.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"Record<string, unknown> \| null","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"string","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"FulfillmentSetDTO[]","description":"Fulfillment sets for the location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"The creation date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"The update date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"string \| Date \| null","description":"The deletion date of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"StockLocationAddressDTO","description":"The address of the stock location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"packed_at","type":"null \| Date","description":"The date the fulfillment was packed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"null \| Date","description":"The date the fulfillment was shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"null \| string","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"null \| Date","description":"The date the fulfillment was delivered.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"null \| Date","description":"The date the fulfillment was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"null \| Record<string, unknown>","description":"The data necessary for the associated fulfillment provider to process the fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"null \| string","description":"The associated shipping option's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"boolean","description":"Flag to indicate whether shipping is required","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"Omit<CreateFulfillmentLabelDTO, "fulfillment_id">[]","description":"The labels associated with the fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tracking_number","type":"string","description":"The tracking number of the fulfillment label.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_url","type":"string","description":"The tracking URL of the fulfillment label.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label_url","type":"string","description":"The URL of the label.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"Partial<OrderDTO>","description":"The associated order to be sent to the provider.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"number","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"number","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"OrderStatus","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"string","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"BigNumberValue","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"BigNumberValue","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"BigNumberValue","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"BigNumberValue","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"BigNumberValue","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"BigNumberValue","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_discount_total","type":"BigNumberValue","description":"The item discount total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"BigNumberValue","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"BigNumberValue","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"BigNumberValue","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"BigNumberValue","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"BigNumberValue","description":"The subtotal of the order. (Excluding taxes)","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"BigNumberValue","description":"The tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_subtotal","type":"BigNumberValue","description":"The discount subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"BigNumberValue","description":"The discount total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_tax_total","type":"BigNumberValue","description":"The discount tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"credit_line_total","type":"BigNumberValue","description":"The credit line total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"BigNumberValue","description":"The gift card total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"BigNumberValue","description":"The gift card tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"BigNumberValue","description":"The shipping total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_subtotal","type":"BigNumberValue","description":"The shipping subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_tax_total","type":"BigNumberValue","description":"The shipping tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_discount_total","type":"BigNumberValue","description":"The shipping discount total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_shipping_total","type":"BigNumberValue","description":"The original shipping total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_shipping_subtotal","type":"BigNumberValue","description":"The original shipping subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_shipping_tax_total","type":"BigNumberValue","description":"The original shipping tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"custom_display_id","type":"string","description":"The order's custom display ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"OrderChangeDTO","description":"The active order change, if any.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"string","description":"The ID of the region the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"string","description":"The ID of the customer on the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"string","description":"The ID of the sales channel the order belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"string","description":"The email of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"OrderAddressDTO","description":"The associated shipping address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address","type":"OrderAddressDTO","description":"The associated billing address.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"items","type":"OrderLineItemDTO[]","description":"The associated order details / line items.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"OrderShippingMethodDTO[]","description":"The associated shipping methods","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"transactions","type":"OrderTransactionDTO[]","description":"The tramsactions associated with the order","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"credit_lines","type":"OrderCreditLineDTO[]","description":"The credit lines for an order","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"summary","type":"OrderSummaryDTO","description":"The summary of the order totals.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"is_draft_order","type":"boolean","description":"Whether the order is a draft order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"locale","type":"string","description":"The locale of the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"string \| Date","description":"When the order was canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"string \| Date","description":"When the order was deleted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"sharedContext","type":"Context","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type TManager, which is a typed parameter passed to the context to specify the type of the transactionManager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type TManager, which is a typed parameter passed to the context to specify the type of the manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"string","description":"A string indicating the isolation level of the context. Possible values are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, or SERIALIZABLE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"boolean","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"string","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"string","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"string","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"IMessageAggregator","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"string","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"boolean","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"boolean","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"boolean","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createFulfillment"/>
<TypeList types={[{"name":"Promise","type":"Promise<FulfillmentDTO>","optional":false,"defaultValue":"","description":"The created fulfillment.","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"string","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"null \| Date","description":"The date the fulfillment was packed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"null \| Date","description":"The date the fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"null \| Date","description":"The date the fulfillment was delivered.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"null \| Date","description":"The date the fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"null \| Record<string, unknown>","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"string","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"null \| string","description":"The associated shipping option's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"null \| ShippingOptionDTO","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string","description":"The name of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"ShippingOptionPriceType","description":"The type of the shipping option's price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone_id","type":"string","description":"The associated service zone's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"string","description":"The associated shipping profile's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"string","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type_id","type":"null \| string","description":"The associated shipping option type's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"null \| Record<string, unknown>","description":"The data necessary for the associated fulfillment provider to process the shipping option\nand, later, its associated fulfillments.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"ServiceZoneDTO","description":"The associated service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile","type":"ShippingProfileDTO","description":"The associated shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_provider","type":"FulfillmentProviderDTO","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"ShippingOptionTypeDTO","description":"The associated shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ShippingOptionRuleDTO[]","description":"The rules associated with the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillments","type":"FulfillmentDTO[]","description":"The fulfillments associated with the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"Date","description":"The creation date of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"The update date of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"The deletion date of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"requires_shipping","type":"boolean","description":"Flag to indidcate whether shipping is required","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"FulfillmentProviderDTO","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string","description":"The name of the fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"ShippingOptionDTO[]","description":"The shipping options associated with the fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"Date","description":"The creation date of the fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"The update date of the fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"The deletion date of the fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"delivery_address","type":"FulfillmentAddressDTO","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_id","type":"null \| string","description":"The associated fulfillment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"null \| string","description":"The company of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"null \| string","description":"The first name of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"null \| string","description":"The last name of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"null \| string","description":"The first line of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"null \| string","description":"The second line of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"null \| string","description":"The city of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"null \| string","description":"The ISO 2 character country code of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"null \| string","description":"The lower-case ISO 3166-2 province of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"null \| string","description":"The postal code of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"null \| string","description":"The phone of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"Date","description":"The creation date of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"The update date of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"The deletion date of the address.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"FulfillmentItemDTO[]","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"string","description":"The title of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"number","description":"The quantity of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"string","description":"The sku of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"string","description":"The barcode of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"null \| string","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"null \| string","description":"The associated inventory item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_id","type":"string","description":"The associated fulfillment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"FulfillmentDTO","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"Date","description":"The creation date of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"The update date of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"The deletion date of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"labels","type":"FulfillmentLabelDTO[]","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the fulfillment label.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_number","type":"string","description":"The tracking number of the fulfillment label.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_url","type":"string","description":"The tracking URL of the fulfillment label.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label_url","type":"string","description":"The label's URL.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_id","type":"string","description":"The associated fulfillment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"FulfillmentDTO","description":"The associated fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"Date","description":"The creation date of the fulfillment label.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"The update date of the fulfillment label.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"The deletion date of the fulfillment label.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"Date","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"marked_shipped_by","type":"null \| string","description":"The id of the user that marked fulfillment as shipped","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"null \| string","description":"The id of the user that created the fulfillment","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createFulfillment"/>