Skip to content
Skunivo Help Center

Ship a partial or full transfer from the source location

POST
/v1/organizations/{organizationId}/transfers/{transferId}/ship

API key scope: transfers:write.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
transferId
required
string

Header Parameters

Section titled “Header Parameters”
X-Request-Id
string

Optional client request id returned in structured errors.

Idempotency-Key
required
string

Unique key used to safely retry transfer shipping.

Request Body

Section titled “Request Body”

Optional partial ship payload. Omit the body to ship the full pending shipment quantity.

Media typeapplication/json
object
quantity

Quantity to ship. Omit to ship the full pending shipment quantity.

number
>= 1
Examplegenerated
{
  "quantity": 1
}

Responses

Section titled “Responses”

201

Section titled “201”

Transfer shipped with ledger movements.

Media typeapplication/json
object
transfer
required
object
id
required
string format: uuid
organizationId
required
string format: uuid
environment
required
string
Allowed values: live test
productId
required
string format: uuid
sourceLocationId
required
string format: uuid
destinationLocationId
required
string format: uuid
ownerId
required
string format: uuid
channelId
required
string format: uuid
quantity
required
number
shippedQuantity
required
number
receivedQuantity
required
number
pendingShipmentQuantity
required
number
pendingReceiveQuantity
required
number
status
required
string
Allowed values: inTransit received cancelled closed
referenceType
object
referenceId
object
metadata
object
key
additional properties
any
createdBy
object
actor
required
object
type
required
string
Allowed values: user api_key system
id
object
label
required
string
shippedAt
object
receivedAt
object
cancelledAt
object
closedAt
object
closeReason
object
product
object
id
required
string format: uuid
name
required
string
sku
required
string
sourceLocation
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
Allowed values: warehouse store virtual
destinationLocation
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
Allowed values: warehouse store virtual
owner
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
channel
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
sourceBalance
required
object
id
required
string format: uuid
organizationId
required
string format: uuid
environment
required
string
Allowed values: live test
productId
required
string format: uuid
locationId
required
string format: uuid
ownerId
required
string format: uuid
channelId
required
string format: uuid
onHand
required
number
available
required
number
reserved
required
number
committed
required
number
incoming
required
number
damaged
required
number
qualityControl
required
number
safetyStock
required
number
version
required
number
product
object
id
required
string format: uuid
name
required
string
sku
required
string
location
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
Allowed values: warehouse store virtual
owner
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
channel
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
movements
required
Array<object>
object
id
required
string format: uuid
organizationId
required
string format: uuid
environment
required
string
Allowed values: live test
productId
required
string format: uuid
locationId
required
string format: uuid
ownerId
required
string format: uuid
channelId
required
string format: uuid
lotId
object
operation
required
string
Allowed values: receive adjust fulfill write_off return_stock move_state reconcile reserve commit release reservation_cancel expire transfer_out transfer_in transfer_cancel transfer_close inbound_expect inbound_receive inbound_close inbound_cancel outbound_allocate outbound_pick outbound_pack outbound_ship outbound_fulfill outbound_cancel composition_assemble_component composition_assemble_output composition_disassemble_input composition_disassemble_component
inventoryState
required
string
Allowed values: onHand available reserved committed incoming damaged qualityControl safetyStock
quantity
required
number
unitCode
object
unitQuantity
object
baseUnitCode
object
balanceBefore
required
number
balanceAfter
required
number
reason
object
referenceType
object
referenceId
object
source
object
idempotencyKey
object
metadata
object
key
additional properties
any
createdBy
object
actor
required
object
type
required
string
Allowed values: user api_key system
id
object
label
required
string
product
object
id
required
string format: uuid
name
required
string
sku
required
string
location
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
Allowed values: warehouse store virtual
owner
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
channel
object
id
required
string format: uuid
name
required
string
code
required
string
type
required
string
lot
object
id
required
string format: uuid
lotCode
required
string
batchCode
object
expiresAt
object
status
required
string
Allowed values: active archived
serials
required
Array<object>
object
id
required
string format: uuid
serialNumber
required
string
status
required
string
Allowed values: in_stock picked packed consumed written_off archived
productId
required
string format: uuid
locationId
required
string format: uuid
ownerId
required
string format: uuid
channelId
required
string format: uuid
lotId
object
createdAt
required
string format: date-time
Example
{
  "transfer": {
    "id": "77777777-7777-4777-8777-777777777777",
    "organizationId": "11111111-1111-4111-8111-111111111111",
    "environment": "test",
    "productId": "22222222-2222-4222-8222-222222222222",
    "sourceLocationId": "33333333-3333-4333-8333-333333333333",
    "destinationLocationId": "44444444-4444-4444-8444-444444444444",
    "quantity": 4,
    "shippedQuantity": 2,
    "receivedQuantity": 0,
    "pendingShipmentQuantity": 2,
    "pendingReceiveQuantity": 2,
    "status": "inTransit",
    "referenceType": "internal_transfer",
    "referenceId": "transfer_01JABC",
    "metadata": {
      "channel": "panel"
    },
    "actor": {
      "type": "api_key",
      "id": "api-key-1",
      "label": "Public test integration"
    },
    "product": {
      "id": "22222222-2222-4222-8222-222222222222",
      "name": "Black T-Shirt - Medium",
      "sku": "TSHIRT-BLACK-M"
    },
    "sourceLocation": {
      "id": "33333333-3333-4333-8333-333333333333",
      "name": "Main Warehouse",
      "code": "MAIN-WH",
      "type": "warehouse"
    },
    "destinationLocation": {
      "id": "44444444-4444-4444-8444-444444444444",
      "name": "Retail Store",
      "code": "STORE-1",
      "type": "store"
    },
    "shippedAt": null,
    "receivedAt": null,
    "cancelledAt": null,
    "closedAt": null,
    "closeReason": null,
    "createdAt": "2026-06-29T10:00:00.000Z",
    "updatedAt": "2026-06-29T10:00:00.000Z"
  },
  "sourceBalance": {
    "id": "55555555-5555-4555-8555-555555555555",
    "organizationId": "11111111-1111-4111-8111-111111111111",
    "environment": "test",
    "productId": "22222222-2222-4222-8222-222222222222",
    "locationId": "33333333-3333-4333-8333-333333333333",
    "onHand": 8,
    "available": 8,
    "reserved": 0,
    "committed": 0,
    "incoming": 0,
    "damaged": 0,
    "qualityControl": 0,
    "safetyStock": 0,
    "version": 1,
    "product": {
      "id": "22222222-2222-4222-8222-222222222222",
      "name": "Black T-Shirt - Medium",
      "sku": "TSHIRT-BLACK-M"
    },
    "location": {
      "id": "33333333-3333-4333-8333-333333333333",
      "name": "Main Warehouse",
      "code": "MAIN-WH",
      "type": "warehouse"
    },
    "createdAt": "2026-06-29T10:00:00.000Z",
    "updatedAt": "2026-06-29T10:00:00.000Z"
  },
  "movements": [
    {
      "id": "88888888-8888-4888-8888-888888888888",
      "organizationId": "11111111-1111-4111-8111-111111111111",
      "environment": "test",
      "productId": "22222222-2222-4222-8222-222222222222",
      "locationId": "33333333-3333-4333-8333-333333333333",
      "lotId": "12121212-1212-4212-8212-121212121212",
      "operation": "transfer_out",
      "inventoryState": "available",
      "quantity": -2,
      "unitCode": "CASE",
      "unitQuantity": 1,
      "baseUnitCode": "EA",
      "balanceBefore": 10,
      "balanceAfter": 8,
      "reason": "Initial receipt",
      "referenceType": "transfer",
      "referenceId": "77777777-7777-4777-8777-777777777777",
      "source": "api_key",
      "idempotencyKey": "receive-unique-key",
      "metadata": {
        "batch": "A1"
      },
      "actor": {
        "type": "api_key",
        "id": "api-key-1",
        "label": "Public test integration"
      },
      "product": {
        "id": "22222222-2222-4222-8222-222222222222",
        "name": "Black T-Shirt - Medium",
        "sku": "TSHIRT-BLACK-M"
      },
      "location": {
        "id": "33333333-3333-4333-8333-333333333333",
        "name": "Main Warehouse",
        "code": "MAIN-WH",
        "type": "warehouse"
      },
      "lot": {
        "id": "12121212-1212-4212-8212-121212121212",
        "lotCode": "LOT-2026-001",
        "batchCode": "BATCH-A",
        "expiresAt": "2027-07-01T00:00:00.000Z",
        "status": "active"
      },
      "serials": [
        {
          "id": "14141414-1414-4414-8414-141414141414",
          "serialNumber": "SN-2026-0001",
          "status": "in_stock",
          "productId": "22222222-2222-4222-8222-222222222222",
          "locationId": "33333333-3333-4333-8333-333333333333",
          "lotId": "12121212-1212-4212-8212-121212121212"
        }
      ],
      "createdAt": "2026-06-29T10:00:00.000Z"
    }
  ]
}

403

Section titled “403”

The organization has exhausted its monthly public API request quota.

The organization has exhausted an applicable monthly billing quota.

Media typeapplication/json
Examples
{
  "error": {
    "code": "PLAN_LIMIT_EXCEEDED",
    "message": "Plan limit exceeded for billable_inventory_operations",
    "requestId": "req_123",
    "details": {
      "entitlementKey": "billable_inventory_operations",
      "scope": "environment",
      "environment": "live",
      "configured": true,
      "limit": "2000",
      "used": "2000",
      "requested": "1",
      "currentPlan": {
        "code": "free",
        "version": 1
      },
      "requiredPlan": {
        "code": "starter",
        "version": 1,
        "requiresOverride": false
      }
    }
  }
}