Order - Bulk Add Manual Shipments

Add manual shipments with tracking information to multiple orders in a single request.

POST /order/bulk_add_manual_shipments

Order - Bulk Add Manual Shipments

cURL

curl --request POST \
  --url https://api.skulabs.com/order/bulk_add_manual_shipments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rows": [
    {}
  ],
  "options": {}
}
'

200

{
  "success": true,
  "results": [
    {
      "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>"
      },
      "error": true,
      "message": "<string>",
      "shipment": {}
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Body

application/json

rows · object[] · required

Array of shipment row objects

options · object

Additional options

Response

200

application/json

Bulk shipment results

success · boolean · required

True if no errors occurred in any row

results · object[] · required

Per-row results

Show child attributes