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"
    }
  ]
}

Changes

Changed in 4 of the 13 revisions of this API.92846

Mar 2, 2026fa53dd949b8e6817See the full diff
- ▲
  the request property order_number became required
  request-property-became-required
- ▲
  the request property store_id became required
  request-property-became-required
- ▲
  the address request property type/format changed from string/ to object/
  request-property-type-changed
- ▲
  the dropship request property type/format changed from string/ to boolean/
  request-property-type-changed
- ▲
  the force_deduction request property type/format changed from string/ to boolean/
  request-property-type-changed
- ▲
  the order_items request property type/format changed from string/ to array/
  request-property-type-changed
- ●
  removed the request property bol_pro_number
  request-property-removed
- ●
  removed the request property booking
  request-property-removed
- ●
  removed the request property options
  request-property-removed
- ●
  removed the request property origin_address
  request-property-removed
- ●
  removed the request property parcel
  request-property-removed
- ●
  removed the request property seal
  request-property-removed
- ●
  removed the request property total_bundles
  request-property-removed
- ●
  removed the request property tracking_url
  request-property-removed
- ○
  api operation id post_order_add_manual_shipment was added
  api-operation-id-added
- ○
  added the new optional request property address/address
  new-optional-request-property
- ○
  added the new optional request property address/address2
  new-optional-request-property
- ○
  added the new optional request property address/city
  new-optional-request-property
- ○
  added the new optional request property address/company
  new-optional-request-property
- ○
  added the new optional request property address/country_code
  new-optional-request-property
- ○
  added the new optional request property address/email
  new-optional-request-property
- ○
  added the new optional request property address/name
  new-optional-request-property
- ○
  added the new optional request property address/phone
  new-optional-request-property
- ○
  added the new optional request property address/postal_code
  new-optional-request-property
- ○
  added the new optional request property address/state
  new-optional-request-property
- ○
  added the media type application/json for the response with the status 200
  response-media-type-added
- ○
  added the media type application/json for the response with the status 400
  response-media-type-added
- ○
  added the media type application/json for the response with the status 401
  response-media-type-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
May 28, 20245be88c3f42d31See the full diff
- ○
  added the new optional request property parcel
  new-optional-request-property
Apr 22, 202408cd9cfa14dd1202See the full diff
- ▲
  added required request body
  request-body-added-required
- ●
  deleted the query request parameter address
  request-parameter-removed
- ●
  deleted the query request parameter bol_pro_number
  request-parameter-removed
- ●
  deleted the query request parameter booking
  request-parameter-removed
- ●
  deleted the query request parameter carrier
  request-parameter-removed
- ●
  deleted the query request parameter cost
  request-parameter-removed
- ●
  deleted the query request parameter dropship
  request-parameter-removed
- ●
  deleted the query request parameter force_deduction
  request-parameter-removed
- ●
  deleted the query request parameter no_refresh
  request-parameter-removed
- ●
  deleted the query request parameter notes
  request-parameter-removed
- ●
  deleted the query request parameter options
  request-parameter-removed
- ●
  deleted the query request parameter order_items
  request-parameter-removed
- ●
  deleted the query request parameter order_number
  request-parameter-removed
- ●
  deleted the query request parameter origin_address
  request-parameter-removed
- ●
  deleted the query request parameter seal
  request-parameter-removed
- ●
  deleted the query request parameter service
  request-parameter-removed
- ●
  deleted the query request parameter store_id
  request-parameter-removed
- ●
  deleted the query request parameter total_bundles
  request-parameter-removed
- ●
  deleted the query request parameter tracking_number
  request-parameter-removed
- ●
  deleted the query request parameter tracking_url
  request-parameter-removed
- ●
  deleted the query request parameter warehouse_id
  request-parameter-removed
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
Apr 19, 202446ceda528000226See the full diff
- ▲
  removed the request body
  request-body-removed
- ▲
  removed the media type application/json for the response with the status 200
  response-media-type-removed
- ○
  api operation id post_order_add_manual_shipment removed and replaced with
  api-operation-id-removed
- ○
  added the new optional query request parameter address
  new-optional-request-parameter
- ○
  added the new optional query request parameter bol_pro_number
  new-optional-request-parameter
- ○
  added the new optional query request parameter booking
  new-optional-request-parameter
- ○
  added the new optional query request parameter carrier
  new-optional-request-parameter
- ○
  added the new optional query request parameter cost
  new-optional-request-parameter
- ○
  added the new optional query request parameter dropship
  new-optional-request-parameter
- ○
  added the new optional query request parameter force_deduction
  new-optional-request-parameter
- ○
  added the new optional query request parameter no_refresh
  new-optional-request-parameter
- ○
  added the new optional query request parameter notes
  new-optional-request-parameter
- ○
  added the new optional query request parameter options
  new-optional-request-parameter
- ○
  added the new optional query request parameter order_items
  new-optional-request-parameter
- ○
  added the new optional query request parameter order_number
  new-optional-request-parameter
- ○
  added the new optional query request parameter origin_address
  new-optional-request-parameter
- ○
  added the new optional query request parameter seal
  new-optional-request-parameter
- ○
  added the new optional query request parameter service
  new-optional-request-parameter
- ○
  added the new optional query request parameter store_id
  new-optional-request-parameter
- ○
  added the new optional query request parameter total_bundles
  new-optional-request-parameter
- ○
  added the new optional query request parameter tracking_number
  new-optional-request-parameter
- ○
  added the new optional query request parameter tracking_url
  new-optional-request-parameter
- ○
  added the new optional query request parameter warehouse_id
  new-optional-request-parameter
- ○
  removed the non-success response with the status 400
  response-non-success-status-removed
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
- ○
  removed the non-success response with the status 429
  response-non-success-status-removed
- ○
  removed the non-success response with the status 500
  response-non-success-status-removed
This revision also has 85 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history