Skip to main content
POST
/
admin
/
fulfillments
/
{id}
/
shipment
JS SDK
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.createShipment("ful_123", {
  labels: [
    {
      tracking_number: "123",
      tracking_url: "example.com",
      label_url: "example.com"
    }
  ]
})
.then(({ fulfillment }) => {
  console.log(fulfillment)
})
{
  "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

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The fulfillment's ID.

Query Parameters

​
fields
string

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 shipment's details.

​
labels
object[]
required

The shipment's labels.

Response

OK

A fulfillment's details.

​
fulfillment
object
required

The fulfillment's details.