Create Work Order | ShipBob Developer API

import requests
url = "https://sandbox-api.shipbob.com/Experimental/kitting:create"
payload = {
    "actions": [
        {
            "order": 1,
            "work_order_action_type_id": 1,
            "attachments": [],
            "instructions": "Scan the barcode on the product before kitting",
            "sub_actions": []
        },
        {
            "order": 2,
            "work_order_action_type_id": 2,
            "attachments": [],
            "instructions": "Package items according to kit specifications",
            "sub_actions": [
                {
                    "order": 1,
                    "work_order_action_type_id": 3,
                    "attachments": [
                        {
                            "id": "photo-001",
                            "name": "completed-kit-photo"
                        }
                    ],
                    "instructions": "Take a photo of the completed kit"
                }
            ]
        }
    ],
    "end_kitted_inventory_id": 42,
    "fulfillment_center_id": 1,
    "line_items": [
        {
            "inventory_id": 101,
            "quantity": 10
        }
    ],
    "quantity": 10,
    "workorder_type": "Kitting",
    "lot_date": "2024-01-15T09:00:00Z",
    "lot_number": "LOT-2024-001"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "shipment_id": 0
}

Creates a kitting work order. Currently only Kitting is supported as a work order type.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Request

The work order creation request

actionslist of objectsRequired

The actions (steps) to be performed for the kitting work order.

end_kitted_inventory_idintegerRequired1-2147483647

The inventory identifier for the end kitted product.

fulfillment_center_idintegerRequired1-2147483647

The fulfillment center identifier where the work order will be processed.

line_itemslist of objectsRequired

The line items (component inventory) for the kitting work order.

quantityintegerRequired1-2147483647

The number of kits to produce.

workorder_typeenumRequired

Allowed values:

lot_datedatetime or nullOptional

Optional lot date for the kitting work order.

lot_numberstring or nullOptional0-32 characters

Optional lot number for the kitting work order.

Response

Success

shipment_idinteger

The shipment identifier associated with the created work order.

Errors

500

Internal Server Error