Shipment

  • created_at
    Type: stringFormat: date-timenullable
    required

    Creation timestamp, if recorded.

  • dimensions
    Type: nullable
    required

    Package dimensions, if known and valid.

    Properties: 4
  • documents
    Type: nullable
    required

    The shipping documents available for this shipment; requires read:customers.

    Properties: 3
  • dropoff_due
    Type: stringFormat: date-timenullable
    required

    Due date at seller-local midnight, serialized with timezone; not the overdue cutoff. Null for pickup, non-pre-transit shipments, or missing inputs.

  • fulfillment_method
    Type: enum
    required

    The method of fulfillment for this shipment.

    values
    shippingpickup
  • hazardous_material
    Type: enumnullable
    required

    The hazardous-material classification of this shipment's contents.

    values
    not_hazardousstandardlithium_battery
  • id
    Type: string
    required

    The shipment's ID.

  • insurance
    Type: nullable
    required

    Shipping insurance, if present.

    Properties: 2
  • recipient
    Type: nullable
    required

    The Whatnot user receiving this shipment; requires read:customers.

    Properties: 3
  • replacement_shipment_id
    Type: stringnullable
    required

    Immediate successor shipment ID after replacement, bundling, or splitting; not the final successor in a chain.

  • required_actions
    Type: array of ShipmentRequiredActionenum
    required

    Actions required before fulfillment.

  • seller_paid_shipping_cost
    Type: nullable
    required

    The seller's share of shipping across this shipment's active orders, set at checkout by the seller's shipping settings. Not the label's purchase price, and excludes later carrier adjustments. Null when none was recorded.

    Properties: 2
  • signature_required
    Type: boolean
    required

    Whether delivery requires a signature.

  • status
    Type: enum
    required

    The current fulfillment status of this shipment.

    values
    • created
    • label_generated
    • dropped_off
    • in_transit
    • delivered
    • failed
    • cancelled
    • cancelled_not_shipped
    • cancelled_not_shipped_with_dropoff
    • cancelled_tracking_stuck
  • tracking
    Type: nullable
    required

    Carrier and tracking information.

    Properties: 4
  • updated_at
    Type: stringFormat: date-timenullable
    required

    Last update timestamp, if recorded.

  • url
    Type: string
    required

    The url of the shipment in the seller's dashboard.

  • weight
    Type: nullable
    required

    Package weight, if known and valid.

    Properties: 2
Previous
SetInventoryItem
Next
ShipmentDocuments