Sign in

v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
order

Order - Add Manual Shipment

Add a manual shipment with tracking information to an order.

post/order/add_manual_shipment

Request body

store_idstring required

Store ID

order_numberstring required

Order number

carrierstring

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

tracking_numberstring

Tracking number

servicestring

Shipping service type

order_itemsobject[]

Items included in the shipment

warehouse_idstring

Warehouse ID to ship from

dropshipboolean

Whether this is a dropship order

no_refreshboolean

Skip cache refresh after operation

notesstring

Shipment notes

force_deductionboolean

Force inventory deduction

costnumber

Shipping cost

Example request

{
  "store_id": "507f1f77bcf86cd799439011"
}

Response

Shipment added successfully

Example response

{
  "shipments": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "user_id": "507f1f77bcf86cd799439011",
      "time": "2025-01-15T12:00:00.000Z"
    }
  ]
}