Create Shipment

curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{id}/shipments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ship_date": "2023-12-25",
  "tracking_number": "<string>",
  "carrier_code": "fedex",
  "ship_to": {
    "name": "<string>",
    "street1": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "residential": true,
    "company": "<string>",
    "street2": "<string>",
    "street3": "<string>",
    "phone": "<string>"
  },
  "items": [
    {
      "product_id": 123,
      "order_item_id": 123,
      "quantity": 2,
      "unit_price": 1
    }
  ],
  "bol_number": "BOL-123456789",
  "pro_number": "PRO-987654321",
  "partner_reference_number": "PARTNER-REF-001",
  "is_return": true,
  "service_code": "ups_ground",
  "shipment_cost": 123,
  "insurance_cost": 123,
  "package_code": "flat_rate_envelope",
  "warehouse_id": 123
}
'

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{id}/shipments"

payload = {
    "ship_date": "2023-12-25",
    "tracking_number": "<string>",
    "carrier_code": "fedex",
    "ship_to": {
        "name": "<string>",
        "street1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>",
        "residential": True,
        "company": "<string>",
        "street2": "<string>",
        "street3": "<string>",
        "phone": "<string>"
    },
    "items": [
        {
            "product_id": 123,
            "order_item_id": 123,
            "quantity": 2,
            "unit_price": 1
        }
    ],
    "bol_number": "BOL-123456789",
    "pro_number": "PRO-987654321",
    "partner_reference_number": "PARTNER-REF-001",
    "is_return": True,
    "service_code": "ups_ground",
    "shipment_cost": 123,
    "insurance_cost": 123,
    "package_code": "flat_rate_envelope",
    "warehouse_id": 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({
    ship_date: '2023-12-25',
    tracking_number: '<string>',
    carrier_code: 'fedex',
    ship_to: {
      name: '<string>',
      street1: '<string>',
      city: '<string>',
      state: '<string>',
      postalCode: '<string>',
      country: '<string>',
      residential: true,
      company: '<string>',
      street2: '<string>',
      street3: '<string>',
      phone: '<string>'
    },
    items: [{product_id: 123, order_item_id: 123, quantity: 2, unit_price: 1}],
    bol_number: 'BOL-123456789',
    pro_number: 'PRO-987654321',
    partner_reference_number: 'PARTNER-REF-001',
    is_return: true,
    service_code: 'ups_ground',
    shipment_cost: 123,
    insurance_cost: 123,
    package_code: 'flat_rate_envelope',
    warehouse_id: 123
  })
};

fetch('https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{id}/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://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{id}/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([
    'ship_date' => '2023-12-25',
    'tracking_number' => '<string>',
    'carrier_code' => 'fedex',
    'ship_to' => [
        'name' => '<string>',
        'street1' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'postalCode' => '<string>',
        'country' => '<string>',
        'residential' => true,
        'company' => '<string>',
        'street2' => '<string>',
        'street3' => '<string>',
        'phone' => '<string>'
    ],
    'items' => [
        [
                'product_id' => 123,
                'order_item_id' => 123,
                'quantity' => 2,
                'unit_price' => 1
        ]
    ],
    'bol_number' => 'BOL-123456789',
    'pro_number' => 'PRO-987654321',
    'partner_reference_number' => 'PARTNER-REF-001',
    'is_return' => true,
    'service_code' => 'ups_ground',
    'shipment_cost' => 123,
    'insurance_cost' => 123,
    'package_code' => 'flat_rate_envelope',
    'warehouse_id' => 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://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{id}/shipments"

	payload := strings.NewReader("{\n  \"ship_date\": \"2023-12-25\",\n  \"tracking_number\": \"<string>\",\n  \"carrier_code\": \"fedex\",\n  \"ship_to\": {\n    \"name\": \"<string>\",\n    \"street1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"country\": \"<string>\",\n    \"residential\": true,\n    \"company\": \"<string>\",\n    \"street2\": \"<string>\",\n    \"street3\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"product_id\": 123,\n      \"order_item_id\": 123,\n      \"quantity\": 2,\n      \"unit_price\": 1\n    }\n  ],\n  \"bol_number\": \"BOL-123456789\",\n  \"pro_number\": \"PRO-987654321\",\n  \"partner_reference_number\": \"PARTNER-REF-001\",\n  \"is_return\": true,\n  \"service_code\": \"ups_ground\",\n  \"shipment_cost\": 123,\n  \"insurance_cost\": 123,\n  \"package_code\": \"flat_rate_envelope\",\n  \"warehouse_id\": 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://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{id}/shipments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ship_date\": \"2023-12-25\",\n  \"tracking_number\": \"<string>\",\n  \"carrier_code\": \"fedex\",\n  \"ship_to\": {\n    \"name\": \"<string>\",\n    \"street1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"country\": \"<string>\",\n    \"residential\": true,\n    \"company\": \"<string>\",\n    \"street2\": \"<string>\",\n    \"street3\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"product_id\": 123,\n      \"order_item_id\": 123,\n      \"quantity\": 2,\n      \"unit_price\": 1\n    }\n  ],\n  \"bol_number\": \"BOL-123456789\",\n  \"pro_number\": \"PRO-987654321\",\n  \"partner_reference_number\": \"PARTNER-REF-001\",\n  \"is_return\": true,\n  \"service_code\": \"ups_ground\",\n  \"shipment_cost\": 123,\n  \"insurance_cost\": 123,\n  \"package_code\": \"flat_rate_envelope\",\n  \"warehouse_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{id}/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  \"ship_date\": \"2023-12-25\",\n  \"tracking_number\": \"<string>\",\n  \"carrier_code\": \"fedex\",\n  \"ship_to\": {\n    \"name\": \"<string>\",\n    \"street1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"country\": \"<string>\",\n    \"residential\": true,\n    \"company\": \"<string>\",\n    \"street2\": \"<string>\",\n    \"street3\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"product_id\": 123,\n      \"order_item_id\": 123,\n      \"quantity\": 2,\n      \"unit_price\": 1\n    }\n  ],\n  \"bol_number\": \"BOL-123456789\",\n  \"pro_number\": \"PRO-987654321\",\n  \"partner_reference_number\": \"PARTNER-REF-001\",\n  \"is_return\": true,\n  \"service_code\": \"ups_ground\",\n  \"shipment_cost\": 123,\n  \"insurance_cost\": 123,\n  \"package_code\": \"flat_rate_envelope\",\n  \"warehouse_id\": 123\n}"

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

{
  "id": 123,
  "sales_order_id": 123,
  "ship_date": "2023-12-25",
  "tracking_number": "<string>",
  "bol_number": "BOL-123456789",
  "pro_number": "PRO-987654321",
  "partner_reference_number": "PARTNER-REF-001",
  "is_return": true,
  "carrier_code": "<string>",
  "scac": "<string>",
  "service_code": "<string>",
  "package_code": "<string>",
  "shipment_cost": 123,
  "insurance_cost": 123,
  "warehouse_group_id": 123,
  "status": 123,
  "ship_to": {
    "name": "<string>",
    "company": "<string>",
    "street1": "<string>",
    "street2": "<string>",
    "street3": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "phone": "<string>",
    "residential": true
  },
  "weight": {
    "value": 123
  },
  "dimensions": {
    "length": 123,
    "width": 123,
    "height": 123
  },
  "items": [
    {
      "id": 123,
      "shipment_id": 123,
      "product_id": 123,
      "sales_order_item_id": 123,
      "quantity": 123,
      "weight": {
        "value": 123
      },
      "unit_price": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Fulfillment Orders

Create Shipment

Create a carrier shipment bound to a specific fulfillment order. The fulfillment order’s parent sales order is resolved from the path, so callers do not need to look up the sales order first.

The shipment is linked to the fulfillment order (populating the fulfillment-order/shipment pivot and the legacy sales_order_shipment_id FK). Reposts with the same tracking_number + carrier_code are idempotent and will attach any missing pivot rows.

Once the shipment is added, the parent sales order status will automatically be updated to either shipped or partially_shipped, and any shipment costs will be added to the sales order total.

NOTE: At this time, inventory adjustments will not be made automatically.

POST

fulfillment-orders

{id}

shipments

Create Shipment

curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{id}/shipments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ship_date": "2023-12-25",
  "tracking_number": "<string>",
  "carrier_code": "fedex",
  "ship_to": {
    "name": "<string>",
    "street1": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "residential": true,
    "company": "<string>",
    "street2": "<string>",
    "street3": "<string>",
    "phone": "<string>"
  },
  "items": [
    {
      "product_id": 123,
      "order_item_id": 123,
      "quantity": 2,
      "unit_price": 1
    }
  ],
  "bol_number": "BOL-123456789",
  "pro_number": "PRO-987654321",
  "partner_reference_number": "PARTNER-REF-001",
  "is_return": true,
  "service_code": "ups_ground",
  "shipment_cost": 123,
  "insurance_cost": 123,
  "package_code": "flat_rate_envelope",
  "warehouse_id": 123
}
'

import requests

url = "https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{id}/shipments"

payload = {
    "ship_date": "2023-12-25",
    "tracking_number": "<string>",
    "carrier_code": "fedex",
    "ship_to": {
        "name": "<string>",
        "street1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>",
        "residential": True,
        "company": "<string>",
        "street2": "<string>",
        "street3": "<string>",
        "phone": "<string>"
    },
    "items": [
        {
            "product_id": 123,
            "order_item_id": 123,
            "quantity": 2,
            "unit_price": 1
        }
    ],
    "bol_number": "BOL-123456789",
    "pro_number": "PRO-987654321",
    "partner_reference_number": "PARTNER-REF-001",
    "is_return": True,
    "service_code": "ups_ground",
    "shipment_cost": 123,
    "insurance_cost": 123,
    "package_code": "flat_rate_envelope",
    "warehouse_id": 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({
    ship_date: '2023-12-25',
    tracking_number: '<string>',
    carrier_code: 'fedex',
    ship_to: {
      name: '<string>',
      street1: '<string>',
      city: '<string>',
      state: '<string>',
      postalCode: '<string>',
      country: '<string>',
      residential: true,
      company: '<string>',
      street2: '<string>',
      street3: '<string>',
      phone: '<string>'
    },
    items: [{product_id: 123, order_item_id: 123, quantity: 2, unit_price: 1}],
    bol_number: 'BOL-123456789',
    pro_number: 'PRO-987654321',
    partner_reference_number: 'PARTNER-REF-001',
    is_return: true,
    service_code: 'ups_ground',
    shipment_cost: 123,
    insurance_cost: 123,
    package_code: 'flat_rate_envelope',
    warehouse_id: 123
  })
};

fetch('https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{id}/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://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{id}/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([
    'ship_date' => '2023-12-25',
    'tracking_number' => '<string>',
    'carrier_code' => 'fedex',
    'ship_to' => [
        'name' => '<string>',
        'street1' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'postalCode' => '<string>',
        'country' => '<string>',
        'residential' => true,
        'company' => '<string>',
        'street2' => '<string>',
        'street3' => '<string>',
        'phone' => '<string>'
    ],
    'items' => [
        [
                'product_id' => 123,
                'order_item_id' => 123,
                'quantity' => 2,
                'unit_price' => 1
        ]
    ],
    'bol_number' => 'BOL-123456789',
    'pro_number' => 'PRO-987654321',
    'partner_reference_number' => 'PARTNER-REF-001',
    'is_return' => true,
    'service_code' => 'ups_ground',
    'shipment_cost' => 123,
    'insurance_cost' => 123,
    'package_code' => 'flat_rate_envelope',
    'warehouse_id' => 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://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{id}/shipments"

	payload := strings.NewReader("{\n  \"ship_date\": \"2023-12-25\",\n  \"tracking_number\": \"<string>\",\n  \"carrier_code\": \"fedex\",\n  \"ship_to\": {\n    \"name\": \"<string>\",\n    \"street1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"country\": \"<string>\",\n    \"residential\": true,\n    \"company\": \"<string>\",\n    \"street2\": \"<string>\",\n    \"street3\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"product_id\": 123,\n      \"order_item_id\": 123,\n      \"quantity\": 2,\n      \"unit_price\": 1\n    }\n  ],\n  \"bol_number\": \"BOL-123456789\",\n  \"pro_number\": \"PRO-987654321\",\n  \"partner_reference_number\": \"PARTNER-REF-001\",\n  \"is_return\": true,\n  \"service_code\": \"ups_ground\",\n  \"shipment_cost\": 123,\n  \"insurance_cost\": 123,\n  \"package_code\": \"flat_rate_envelope\",\n  \"warehouse_id\": 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://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{id}/shipments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ship_date\": \"2023-12-25\",\n  \"tracking_number\": \"<string>\",\n  \"carrier_code\": \"fedex\",\n  \"ship_to\": {\n    \"name\": \"<string>\",\n    \"street1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"country\": \"<string>\",\n    \"residential\": true,\n    \"company\": \"<string>\",\n    \"street2\": \"<string>\",\n    \"street3\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"product_id\": 123,\n      \"order_item_id\": 123,\n      \"quantity\": 2,\n      \"unit_price\": 1\n    }\n  ],\n  \"bol_number\": \"BOL-123456789\",\n  \"pro_number\": \"PRO-987654321\",\n  \"partner_reference_number\": \"PARTNER-REF-001\",\n  \"is_return\": true,\n  \"service_code\": \"ups_ground\",\n  \"shipment_cost\": 123,\n  \"insurance_cost\": 123,\n  \"package_code\": \"flat_rate_envelope\",\n  \"warehouse_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/fulfillment-orders/{id}/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  \"ship_date\": \"2023-12-25\",\n  \"tracking_number\": \"<string>\",\n  \"carrier_code\": \"fedex\",\n  \"ship_to\": {\n    \"name\": \"<string>\",\n    \"street1\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"country\": \"<string>\",\n    \"residential\": true,\n    \"company\": \"<string>\",\n    \"street2\": \"<string>\",\n    \"street3\": \"<string>\",\n    \"phone\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"product_id\": 123,\n      \"order_item_id\": 123,\n      \"quantity\": 2,\n      \"unit_price\": 1\n    }\n  ],\n  \"bol_number\": \"BOL-123456789\",\n  \"pro_number\": \"PRO-987654321\",\n  \"partner_reference_number\": \"PARTNER-REF-001\",\n  \"is_return\": true,\n  \"service_code\": \"ups_ground\",\n  \"shipment_cost\": 123,\n  \"insurance_cost\": 123,\n  \"package_code\": \"flat_rate_envelope\",\n  \"warehouse_id\": 123\n}"

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

{
  "id": 123,
  "sales_order_id": 123,
  "ship_date": "2023-12-25",
  "tracking_number": "<string>",
  "bol_number": "BOL-123456789",
  "pro_number": "PRO-987654321",
  "partner_reference_number": "PARTNER-REF-001",
  "is_return": true,
  "carrier_code": "<string>",
  "scac": "<string>",
  "service_code": "<string>",
  "package_code": "<string>",
  "shipment_cost": 123,
  "insurance_cost": 123,
  "warehouse_group_id": 123,
  "status": 123,
  "ship_to": {
    "name": "<string>",
    "company": "<string>",
    "street1": "<string>",
    "street2": "<string>",
    "street3": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "phone": "<string>",
    "residential": true
  },
  "weight": {
    "value": 123
  },
  "dimensions": {
    "length": 123,
    "width": 123,
    "height": 123
  },
  "items": [
    {
      "id": 123,
      "shipment_id": 123,
      "product_id": 123,
      "sales_order_item_id": 123,
      "quantity": 123,
      "weight": {
        "value": 123
      },
      "unit_price": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

integer

required

ID of the fulfillment order

Body

application/json

ship_date

string<date>

required

Date when the shipment will be sent (YYYY-MM-DD)

tracking_number

string

required

Tracking number for the shipment

carrier_code

string

required

Code identifying the carrier

Example:

"fedex"

ship_to

object

required

Show child attributes

items

object[]

required

Items to be included in this shipment

Minimum array length: 1

Show child attributes

bol_number

string

Bill of Lading Number for logistics tracking

Example:

"BOL-123456789"

pro_number

string

Progressive Rotating Order Number (common in LTL shipping)

Example:

"PRO-987654321"

partner_reference_number

string

General reference number from/for the shipping partner

Example:

"PARTNER-REF-001"

is_return

boolean

Whether this is a return shipment

service_code

string

Code identifying the shipping service

Example:

"ups_ground"

shipment_cost

number<float>

Cost of shipping

insurance_cost

number<float>

Cost of insurance

package_code

string

Code identifying the package type

Example:

"flat_rate_envelope"

warehouse_id

integer | null

ID of the warehouse shipping from

weight

object

Show child attributes

dimensions

object

Show child attributes

Response

Shipment created successfully

integer

Unique identifier for the shipment

sales_order_id

integer

ID of the associated sales order

ship_date

string<date>

Date when the shipment was or will be sent

tracking_number

string

Tracking number for the shipment

bol_number

string

Bill of Lading Number for logistics tracking

Example:

"BOL-123456789"

pro_number

string

Progressive Rotating Order Number (common in LTL shipping)

Example:

"PRO-987654321"

partner_reference_number

string

General reference number from/for the shipping partner

Example:

"PARTNER-REF-001"

is_return

boolean

Whether this is a return shipment

carrier_code

string

Code identifying the carrier (e.g., ups, fedex)

scac

string | null

Standard Carrier Alpha Code (SCAC) for the shipment's carrier; included on outbound EDI 856/810 documents

service_code

string

Code identifying the shipping service

package_code

string

Code identifying the package type

shipment_cost

number<float>

Cost of shipping

insurance_cost

number<float>

Cost of insurance

warehouse_group_id

integer | null

ID of the warehouse group associated with this shipment (from the linked fulfillment order)

status

integer

Status of the shipment

ship_to

object

Show child attributes

weight

object

Show child attributes

dimensions

object

Show child attributes

items

object[]

Items included in this shipment

Show child attributes

created_at

string<date-time>

Timestamp when the shipment was created

updated_at

string<date-time>

Timestamp when the shipment was last updated

Set custom field values on a fulfillment order List shipping carriers

Products & Catalog

Companies & Contacts

Inventory & Warehousing

Purchasing

Sales & Fulfillment

Manufacturing

Accounts Payable

Reports & Analytics

Configuration

Integrations

Create Shipment

Authorizations

Path Parameters

Body

Response