Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

CreateFulfillmentDTO

The fulfillment to be created.

location_idstring
The associated location's ID.
provider_idstring
The associated fulfillment provider's ID.
delivery_addressOmit<CreateFulfillmentAddressDTO, "fulfillment_id">
The address associated with the fulfillment. It's used for delivery.
itemsOmit<CreateFulfillmentItemDTO, "fulfillment_id">[]
The items associated with the fulfillment.
locationStockLocationDTOOptional
The associated location's data.
packed_atnull | DateOptional
The date the fulfillment was packed.
shipped_atnull | DateOptional
The date the fulfillment was shipped.
created_bynull | stringOptional
The id of the user that created the fulfillment
delivered_atnull | DateOptional
The date the fulfillment was delivered.
canceled_atnull | DateOptional
The date the fulfillment was canceled.
datanull | Record<string, unknown>Optional
The data necessary for the associated fulfillment provider to process the fulfillment.
shipping_option_idnull | stringOptional
The associated shipping option's ID.
requires_shippingbooleanOptional
Flag to indicate whether shipping is required
metadatanull | Record<string, unknown>Optional
Holds custom data in key-value pairs.
labelsOmit<CreateFulfillmentLabelDTO, "fulfillment_id">[]Optional
The labels associated with the fulfillment.
orderPartial<OrderDTO>Optional
The associated order to be sent to the provider.
Was this page helpful?
Edit this page
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵