Ship transfer

POST /api/v1/inventory/transfers/{transfer_id}/ship

Mark transfer as shipped (in-transit). Deducts inventory from source location.

Operation ID: ship_transfer_api_v1_inventory_transfers__transfer_id__ship_post · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

transfer_id string required

Request body

Schema: TransferShipRequest

transfer_date string · date: Date of shipment (defaults to today)
tracking_number string
carrier string

Responses

201 Successful Response

Schema: TransferResponse

id string required

business_id string required

transfer_number string

status TransferStatusEnum requiredTransferStatusEnum

from_location_id string required

to_location_id string required

from_location LocationSummary

to_location LocationSummary

transfer_date string · date

expected_arrival_date string · date

received_date string · date

tracking_number string

carrier string

notes string

items array · TransferItemResponse TransferItemResponse

15 fields

variant_id string required: Variant being transferred
quantity integer required: Quantity to transfer
notes string
id string required
transfer_id string required
received_quantity integer
has_damage boolean
damage_notes string
final_quantity integer required
has_discrepancy boolean required
discrepancy_amount integer required
created_at string · date-time required
updated_at string · date-time required
variant_name string
variant_sku string

total_items integer

total_quantity integer

total_received_quantity integer

has_discrepancy boolean

is_editable boolean

can_ship boolean

can_receive boolean

can_cancel boolean

shipped_by_user_id string

received_by_user_id string

version integer

created_at string · date-time required

updated_at string · date-time required

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

POST /api/v1/inventory/transfers/{transfer_id}/ship

bash

curl -X POST 'https://api.ondayzero.com/api/v1/inventory/transfers/{transfer_id}/ship' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "transfer_date": "2026-01-01",
  "tracking_number": "string",
  "carrier": "string"
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/inventory/transfers/{transfer_id}/ship', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "transfer_date": "2026-01-01",
  "tracking_number": "string",
  "carrier": "string"
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "transfer_date": "2026-01-01",
  "tracking_number": "string",
  "carrier": "string"
}

response = httpx.post("https://api.ondayzero.com/api/v1/inventory/transfers/{transfer_id}/ship", headers=headers, json=payload)
data = response.json()