Order - Add Manual Shipment

Add a manual shipment with tracking information to an order.

POST /order/add_manual_shipment

Order - Add Manual Shipment

cURL

curl --request POST \
  --url https://api.skulabs.com/order/add_manual_shipment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "store_id": "507f1f77bcf86cd799439011",
  "order_number": "<string>",
  "address": {
    "name": "<string>",
    "company": "<string>",
    "address": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country_code": "<string>",
    "phone": "<string>",
    "email": "<string>"
  },
  "carrier": "<string>",
  "tracking_number": "<string>",
  "service": "<string>",
  "order_items": [
    {}
  ],
  "warehouse_id": "<string>",
  "dropship": true,
  "no_refresh": true,
  "notes": "<string>",
  "force_deduction": true,
  "cost": 123
}
'

200

{
  "shipments": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "user_id": "507f1f77bcf86cd799439011",
      "time": "2025-01-15T12:00:00.000Z",
      "voided": true,
      "return_label": true,
      "deducted": true,
      "response": {
        "provider": "<string>",
        "service": "<string>",
        "label_url": "<string>",
        "tracking_number": "<string>",
        "tracking_url": "<string>",
        "amount": 123,
        "currency": "<string>",
        "shipment_id": "<string>",
        "signature": true
      },
      "request": {
        "order_items": [
          {
            "item_id": "<string>",
            "variant_id": "<string>",
            "quantity": 123,
            "sku": "<string>"
          }
        ],
        "parcel": {
          "length": 123,
          "width": 123,
          "height": 123,
          "weight": 123,
          "weight_unit": "<string>",
          "dimensions_unit": "<string>"
        },
        "address": {},
        "carrier_account_ids": [
          "<string>"
        ],
        "provider": "<string>",
        "service": "<unknown>"
      }
    }
  ],
  "skulabs_warning": {
    "message": "<string>",
    "type": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

store_id · string · required

Store ID

Example:

"507f1f77bcf86cd799439011"

order_number · string · required

Order number

address · object

Shipping address

Show child attributes

carrier · string

Carrier name (e.g. USPS, UPS, FedEx)

tracking_number · string

Tracking number

service · string

Shipping service type

order_items · object[]

Items included in the shipment

warehouse_id · string

Warehouse ID to ship from

dropship · boolean

Whether this is a dropship order

no_refresh · boolean

Skip cache refresh after operation

notes · string

Shipment notes

force_deduction · boolean

Force inventory deduction

cost · number

Shipping cost

Response

200

application/json

Shipment added successfully

shipments · object[] · required

Created shipment(s)

Show child attributes

skulabs_warning · object

Non-fatal warning (e.g. channel notification failure)

Show child attributes