fulfillmentSet - JS SDK Admin Reference

This documentation provides a reference to the sdk.admin.fulfillmentSet set of methods used to send requests to Medusa's Admin API routes.

delete#

This method deletes a fulfillment set. It sends a request to the Delete Fulfillment Set API route.

Example#

Code
1sdk.admin.fulfillmentSet.delete("fset_123")2.then(({ deleted }) => {3  console.log(deleted)4})

Parameters#

Returns#

createServiceZone#

This method adds a service zone to a fulfillment set. It uses the Add Service Zone API route.

Example#

Code
1sdk.admin.fulfillmentSet.createServiceZone("fset_123", {2  name: "Europe Service Zone",3  geo_zones: [{4    type: "country",5    country_code: "us"6  }]7})8.then(({ fulfillment_set }) => {9  console.log(fulfillment_set)10})

Parameters#

Returns#

retrieveServiceZone#

This method retrieves a fulfillment set's service zone's details. It sends a request to the Get Service Zone API route.

Example#

To retrieve a fulfillment set's service zone by its ID:

Code
1sdk.admin.fulfillmentSet.retrieveServiceZone(2  "fset_123",3  "serzo_123"4)5.then(({ service_zone }) => {6  console.log(service_zone)7})

To specify the fields and relations to retrieve:

Code
1sdk.admin.fulfillmentSet.retrieveServiceZone(2  "fset_123",3  "serzo_123",4  {5    fields: "id,*geo_zones"6  }7)8.then(({ service_zone }) => {9  console.log(service_zone)10})

Learn more about the fields property in the API reference.

Parameters#

Returns#

updateServiceZone#

This method updates a service zone in a fulfillment set. It sends a request to the Update Service Zone API route.

Example#

Code
1sdk.admin.fulfillmentSet.updateServiceZone(2  "fset_123", 3  "serzo_123",4  {5    name: "Europe Service Zone",6  }7)8.then(({ fulfillment_set }) => {9  console.log(fulfillment_set)10})

Parameters#

Returns#

deleteServiceZone#

This method deletes a service zone in a fulfillment set. It sends a request to the Remove Service Zone API route.

Example#

Code
1sdk.admin.fulfillmentSet.deleteServiceZone(2  "fset_123", 3  "serzo_123",4)5.then(({ deleted, parent: fulfillmentSet }) => {6  console.log(deleted, fulfillmentSet)7})

Parameters#

Returns#