- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
createReturnFulfillmentStep - Medusa Core Workflows Reference
This documentation provides a reference to the createReturnFulfillmentStep. It belongs to the @medusajs/medusa/core-flows package.
This step creates a fulfillment for a return.
Example#
1const data = createReturnFulfillmentStep({2 location_id: "sloc_123",3 provider_id: "provider_123",4 delivery_address: {5 first_name: "John",6 last_name: "Doe",7 address_1: "Test Street 1",8 city: "Test City",9 postal_code: "12345",10 country_code: "US",11 phone: "123456789",12 },13 items: [14 {15 title: "Shirt",16 sku: "shirt",17 quantity: 1,18 barcode: "123456789",19 }20 ]21})
Input#
CreateFulfillmentDTOCreateFulfillmentDTOThe fulfillment to be created.
CreateFulfillmentDTOCreateFulfillmentDTOlocation_idstringThe associated location's ID.
location_idstringprovider_idstringThe associated fulfillment provider's ID.
provider_idstringdelivery_addressOmit<CreateFulfillmentAddressDTO, "fulfillment_id">The address associated with the fulfillment. It's used for delivery.
delivery_addressOmit<CreateFulfillmentAddressDTO, "fulfillment_id">itemsOmit<CreateFulfillmentItemDTO, "fulfillment_id">[]The items associated with the fulfillment.
itemsOmit<CreateFulfillmentItemDTO, "fulfillment_id">[]The associated location's data.
packed_atnull | DateOptionalThe date the fulfillment was packed.
packed_atnull | DateOptionalshipped_atnull | DateOptionalThe date the fulfillment was shipped.
shipped_atnull | DateOptionalcreated_bynull | stringOptionalThe id of the user that created the fulfillment
created_bynull | stringOptionaldelivered_atnull | DateOptionalThe date the fulfillment was delivered.
delivered_atnull | DateOptionalcanceled_atnull | DateOptionalThe date the fulfillment was canceled.
canceled_atnull | DateOptionaldatanull | Record<string, unknown>OptionalThe data necessary for the associated fulfillment provider to process the fulfillment.
datanull | Record<string, unknown>Optionalshipping_option_idnull | stringOptionalThe associated shipping option's ID.
shipping_option_idnull | stringOptionalrequires_shippingbooleanOptionalFlag to indicate whether shipping is required
requires_shippingbooleanOptionalmetadatanull | Record<string, unknown>OptionalHolds custom data in key-value pairs.
metadatanull | Record<string, unknown>OptionalThe labels associated with the fulfillment.
The associated order to be sent to the provider.
Output#
FulfillmentDTOFulfillmentDTOThe fulfillment details.
FulfillmentDTOFulfillmentDTOidstringThe ID of the fulfillment.
idstringlocation_idstringThe associated location's ID.
location_idstringpacked_atnull | DateThe date the fulfillment was packed.
packed_atnull | Dateshipped_atnull | DateThe date the fulfillment was shipped.
shipped_atnull | Datedelivered_atnull | DateThe date the fulfillment was delivered.
delivered_atnull | Datecanceled_atnull | DateThe date the fulfillment was canceled.
canceled_atnull | Datedatanull | Record<string, unknown>The data necessary for the fulfillment provider to process
the fulfillment.
datanull | Record<string, unknown>provider_idstringThe associated fulfillment provider's ID.
provider_idstringshipping_option_idnull | stringThe associated shipping option's ID.
shipping_option_idnull | stringmetadatanull | Record<string, unknown>Holds custom data in key-value pairs.
metadatanull | Record<string, unknown>shipping_optionnull | ShippingOptionDTOThe associated shipping option.
shipping_optionnull | ShippingOptionDTOrequires_shippingbooleanFlag to indidcate whether shipping is required
requires_shippingbooleanproviderFulfillmentProviderDTOThe associated fulfillment provider.
providerFulfillmentProviderDTOdelivery_addressFulfillmentAddressDTOThe associated fulfillment address used for delivery.
delivery_addressFulfillmentAddressDTOitemsFulfillmentItemDTO[]The items of the fulfillment.
itemsFulfillmentItemDTO[]labelsFulfillmentLabelDTO[]The labels of the fulfillment.
labelsFulfillmentLabelDTO[]created_atDateThe creation date of the fulfillment.
created_atDateupdated_atDateThe update date of the fulfillment.
updated_atDatedeleted_atnull | DateThe deletion date of the fulfillment.
deleted_atnull | Datemarked_shipped_bynull | stringOptionalThe id of the user that marked fulfillment as shipped
marked_shipped_bynull | stringOptionalcreated_bynull | stringOptionalThe id of the user that created the fulfillment
created_bynull | stringOptionalWas this page helpful?