Order - Add Manual Shipment

Add a manual shipment with tracking information to an order.

POST /order/add_manual_shipment

Order - Add Manual Shipment

cURL

curl --request POST \
  --url https://api.skulabs.com/order/add_manual_shipment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "store_id": "507f1f77bcf86cd799439011",
  "order_number": "<string>",
  "address": {
    "name": "<string>",
    "company": "<string>",
    "address": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country_code": "<string>",
    "phone": "<string>",
    "email": "<string>"
  },
  "carrier": "<string>",
  "tracking_number": "<string>",
  "service": "<string>",
  "order_items": [
    {}
  ],
  "warehouse_id": "<string>",
  "dropship": true,
  "no_refresh": true,
  "notes": "<string>",
  "force_deduction": true,
  "cost": 123
}
'

import requests

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

payload = {
    "store_id": "507f1f77bcf86cd799439011",
    "order_number": "<string>",
    "address": {
        "name": "<string>",
        "company": "<string>",
        "address": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country_code": "<string>",
        "phone": "<string>",
        "email": "<string>"
    },
    "carrier": "<string>",
    "tracking_number": "<string>",
    "service": "<string>",
    "order_items": [{}],
    "warehouse_id": "<string>",
    "dropship": True,
    "no_refresh": True,
    "notes": "<string>",
    "force_deduction": True,
    "cost": 123
}
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({
    store_id: '507f1f77bcf86cd799439011',
    order_number: '<string>',
    address: {
      name: '<string>',
      company: '<string>',
      address: '<string>',
      address2: '<string>',
      city: '<string>',
      state: '<string>',
      postal_code: '<string>',
      country_code: '<string>',
      phone: '<string>',
      email: '<string>'
    },
    carrier: '<string>',
    tracking_number: '<string>',
    service: '<string>',
    order_items: [{}],
    warehouse_id: '<string>',
    dropship: true,
    no_refresh: true,
    notes: '<string>',
    force_deduction: true,
    cost: 123
  })
};

fetch('https://api.skulabs.com/order/add_manual_shipment', 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/add_manual_shipment",
  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([
    'store_id' => '507f1f77bcf86cd799439011',
    'order_number' => '<string>',
    'address' => [
        'name' => '<string>',
        'company' => '<string>',
        'address' => '<string>',
        'address2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'postal_code' => '<string>',
        'country_code' => '<string>',
        'phone' => '<string>',
        'email' => '<string>'
    ],
    'carrier' => '<string>',
    'tracking_number' => '<string>',
    'service' => '<string>',
    'order_items' => [
        [
                
        ]
    ],
    'warehouse_id' => '<string>',
    'dropship' => true,
    'no_refresh' => true,
    'notes' => '<string>',
    'force_deduction' => true,
    'cost' => 123
  ]),
  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/add_manual_shipment"

	payload := strings.NewReader("{\n  \"store_id\": \"507f1f77bcf86cd799439011\",\n  \"order_number\": \"<string>\",\n  \"address\": {\n    \"name\": \"<string>\",\n    \"company\": \"<string>\",\n    \"address\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"email\": \"<string>\"\n  },\n  \"carrier\": \"<string>\",\n  \"tracking_number\": \"<string>\",\n  \"service\": \"<string>\",\n  \"order_items\": [\n    {}\n  ],\n  \"warehouse_id\": \"<string>\",\n  \"dropship\": true,\n  \"no_refresh\": true,\n  \"notes\": \"<string>\",\n  \"force_deduction\": true,\n  \"cost\": 123\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/add_manual_shipment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"store_id\": \"507f1f77bcf86cd799439011\",\n  \"order_number\": \"<string>\",\n  \"address\": {\n    \"name\": \"<string>\",\n    \"company\": \"<string>\",\n    \"address\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"email\": \"<string>\"\n  },\n  \"carrier\": \"<string>\",\n  \"tracking_number\": \"<string>\",\n  \"service\": \"<string>\",\n  \"order_items\": [\n    {}\n  ],\n  \"warehouse_id\": \"<string>\",\n  \"dropship\": true,\n  \"no_refresh\": true,\n  \"notes\": \"<string>\",\n  \"force_deduction\": true,\n  \"cost\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"store_id\": \"507f1f77bcf86cd799439011\",\n  \"order_number\": \"<string>\",\n  \"address\": {\n    \"name\": \"<string>\",\n    \"company\": \"<string>\",\n    \"address\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"email\": \"<string>\"\n  },\n  \"carrier\": \"<string>\",\n  \"tracking_number\": \"<string>\",\n  \"service\": \"<string>\",\n  \"order_items\": [\n    {}\n  ],\n  \"warehouse_id\": \"<string>\",\n  \"dropship\": true,\n  \"no_refresh\": true,\n  \"notes\": \"<string>\",\n  \"force_deduction\": true,\n  \"cost\": 123\n}"

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

200

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

store_id · string · required

Store ID

Example:

"507f1f77bcf86cd799439011"

order_number · string · required

Order number

address · object

Shipping address

Show child attributes

carrier · string

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

tracking_number · string

Tracking number

service · string

Shipping service type

order_items · object[]

Items included in the shipment

warehouse_id · string

Warehouse ID to ship from

dropship · boolean

Whether this is a dropship order

no_refresh · boolean

Skip cache refresh after operation

notes · string

Shipment notes

force_deduction · boolean

Force inventory deduction

cost · number

Shipping cost

Response

200

application/json

Shipment added successfully

shipments · object[] · required

Created shipment(s)

Show child attributes

skulabs_warning · object

Non-fatal warning (e.g. channel notification failure)

Show child attributes