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": {}
}
'

import requests

url = "https://api.skulabs.com/order/bulk_add_manual_shipments"

payload = {
    "rows": [{}],
    "options": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({rows: [{}], options: {}})
};

fetch('https://api.skulabs.com/order/bulk_add_manual_shipments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.skulabs.com/order/bulk_add_manual_shipments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'rows' => [
        [
                
        ]
    ],
    'options' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.skulabs.com/order/bulk_add_manual_shipments"

	payload := strings.NewReader("{\n  \"rows\": [\n    {}\n  ],\n  \"options\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.skulabs.com/order/bulk_add_manual_shipments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rows\": [\n    {}\n  ],\n  \"options\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.skulabs.com/order/bulk_add_manual_shipments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rows\": [\n    {}\n  ],\n  \"options\": {}\n}"

response = http.request(request)
puts response.read_body

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

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

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