order

Order - Add Manual Shipment

Changed on

Add a manual shipment with tracking information to an order.

post/order/add_manual_shipment

Request

  • Base URL
    https://api.skulabs.com
  • URL
    https://api.skulabs.com/order/add_manual_shipment
  • Auth
    HTTP bearer

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

notify_customerboolean

Send a shipped notification email to the customer. When true, sends using the store shipped email template via Postmark.

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

  • 3bf9d805a276Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

  • fa53dd949b8eRevision changes
    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property type changed from string to object

    • breaking

      the request property type changed from string to boolean

    • breaking

      the request property type changed from string to boolean

    • breaking

      the request property type changed from string to array

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      api operation id post_order_add_manual_shipment was added

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status