API Documentation
- Admin Api Keys
- Admin Campaigns
- Admin Claims
- Admin Collections
- Admin Currencies
- Admin Customer Groups
- Admin Customers
- Admin Draft Orders
- Admin Exchanges
- Admin Fulfillment Providers
- Admin Fulfillment Sets
- Admin Fulfillments
- Admin Gift Cards
- Admin Inventory Items
- Admin Invites
- Admin Notifications
- Admin Order Edits
- Admin Orders
- Admin Payment Collections
- Admin Payments
- Admin Plugins
- Admin Price Lists
- Admin Price Preferences
- Admin Product Categories
- Admin Product Tags
- Admin Product Types
- Admin Product Variants
- Admin Products
- Admin Promotions
- Admin Refund Reasons
- Admin Regions
- Admin Reservations
- Admin Return Reasons
- Admin Returns
- Admin Sales Channels
- Admin Shipping Options
- Admin Shipping Profiles
- Admin Stock Locations
- Admin Store Credit Accounts
- Admin Stores
- Admin Tax Providers
- Admin Tax Rates
- Admin Tax Regions
- Admin Transaction Groups
- Admin Uploads
- Admin Users
- Admin Workflows Executions
- Store Auth
- Admin Auth
- Store Carts
- Store Collections
- Store Currencies
- Store Customers
- Store Gift Cards
- Store Orders
- Store Payment Collections
- Store Payment Providers
- Store Product Categories
- Store Product Tags
- Store Product Types
- Store Products
- Store Regions
- Store Return Reasons
- Store
- Store Shipping Options
- Store Store Credit Accounts
- Admin Algolia
- Admin Attributes
- Admin Commission
- Admin Configuration
- Admin Order Sets
- Admin Requests
- Admin Return Request
- Admin Reviews
- Admin Sellers
- Auth
- Store Return Request
- Store Reviews
- Store Sellers
- Store Wishlist
- Vendor Attributes
- Vendor Campaigns
- Vendor Commission
- Vendor Configuration
- Vendor Customer Groups
- Vendor Customers
- Vendor Fulfillment Providers
- Vendor Fulfillment Sets
- Vendor Inventory Items
- Vendor Invites
- Vendor Current Member
- Vendor Members
- Vendor Notifications
- Vendor Orders
- Vendor Payout Account
- Vendor Payouts
- Vendor Price Lists
- Vendor Price Preferences
- Vendor Product Categories
- Vendor Product Collections
- Vendor Product Tags
- Vendor Product Types
- Vendor Products
- Vendor Promotions
- Vendor Regions
- Vendor Requests
- Vendor Reservations
- Vendor Return Requests
- Vendor Returns
- Vendor Sales Channels
- Vendor Sellers
- Vendor Onboarding
- Vendor Reviews
- Vendor Shipping Options
- Vendor Shipping Profiles
- Vendor Statistics
- Vendor Stock Locations
- Vendor Stores
Admin Fulfillments
Create Fulfillment
Create a fulfillment for an order, return, exchange, and more.
POST
/
admin
/
fulfillments
Copy
import Medusa from "@medusajs/js-sdk"
export const sdk = new Medusa({
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
debug: import.meta.env.DEV,
auth: {
type: "session",
},
})
sdk.admin.fulfillment.create({
location_id: "sloc_123",
provider_id: "my_fulfillment",
delivery_address: {
country_code: "us"
},
items: [
{
title: "Shirt",
sku: "SHIRT",
quantity: 1,
barcode: "123"
}
],
labels: [],
order: {},
order_id: "order_123"
})
.then(({ fulfillment }) => {
console.log(fulfillment)
})
Copy
{
"fulfillment": {
"id": "<string>",
"location_id": "<string>",
"provider_id": "<string>",
"shipping_option_id": "<string>",
"provider": {
"id": "<string>",
"is_enabled": true
},
"delivery_address": {
"id": "<string>",
"fulfillment_id": "<string>",
"company": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"city": "<string>",
"country_code": "<string>",
"province": "us-ca",
"postal_code": "<string>",
"phone": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"items": [
{
"id": "<string>",
"title": "<string>",
"quantity": 123,
"sku": "<string>",
"barcode": "<string>",
"line_item_id": "<string>",
"inventory_item_id": "<string>",
"fulfillment_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"labels": [
{
"id": "<string>",
"tracking_number": "<string>",
"tracking_url": "<string>",
"label_url": "<string>",
"fulfillment_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"packed_at": "<string>",
"shipped_at": "<string>",
"delivered_at": "<string>",
"canceled_at": "<string>",
"data": {},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Comma-separated fields that should be included in the returned data. if a field is prefixed with +
it will be added to the default fields, using -
will remove it from the default fields. without prefix it will replace the entire default fields.
Body
application/json
The filfillment's details.
Response
200
application/json
OK
A fulfillment's details.
Copy
import Medusa from "@medusajs/js-sdk"
export const sdk = new Medusa({
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
debug: import.meta.env.DEV,
auth: {
type: "session",
},
})
sdk.admin.fulfillment.create({
location_id: "sloc_123",
provider_id: "my_fulfillment",
delivery_address: {
country_code: "us"
},
items: [
{
title: "Shirt",
sku: "SHIRT",
quantity: 1,
barcode: "123"
}
],
labels: [],
order: {},
order_id: "order_123"
})
.then(({ fulfillment }) => {
console.log(fulfillment)
})
Copy
{
"fulfillment": {
"id": "<string>",
"location_id": "<string>",
"provider_id": "<string>",
"shipping_option_id": "<string>",
"provider": {
"id": "<string>",
"is_enabled": true
},
"delivery_address": {
"id": "<string>",
"fulfillment_id": "<string>",
"company": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"city": "<string>",
"country_code": "<string>",
"province": "us-ca",
"postal_code": "<string>",
"phone": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"items": [
{
"id": "<string>",
"title": "<string>",
"quantity": 123,
"sku": "<string>",
"barcode": "<string>",
"line_item_id": "<string>",
"inventory_item_id": "<string>",
"fulfillment_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"labels": [
{
"id": "<string>",
"tracking_number": "<string>",
"tracking_url": "<string>",
"label_url": "<string>",
"fulfillment_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"packed_at": "<string>",
"shipped_at": "<string>",
"delivered_at": "<string>",
"canceled_at": "<string>",
"data": {},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
}
Assistant
Responses are generated using AI and may contain mistakes.