input UpdateInboundShipmentInput

Fields

FieldTypeDescription
customer_account_idString

Use this when you are a 3PL acting on behalf of one of your customers.

inbound_shipment_idString!

Public API inbound shipment ID that identifies the related record.

warehouse_idString!

Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.

purchase_orders_ids[String]!

List of public API purchase orders IDs identifying related records.

carrierString

Carrier name or carrier code used for shipping.

estimated_truck_arrivalISODateTime

Estimated truck arrival as an ISO-8601 datetime, returned in UTC unless otherwise noted.

booking_contact_emailString

Email address for the booking contact contact.

booking_contact_nameString

Booking contact name for this inbound shipment.

booking_contact_numberString

Booking contact number for this inbound shipment.

container_sizeString

Container size for this inbound shipment.

load_typeString

Load type for this inbound shipment.

number_cartonInt

Number carton as a whole-unit count.

pallets_quantityInt

Pallets quantity as a whole-unit count.

pro_numberString

Pro number for this inbound shipment.

shipment_typeString

Shipment type for this inbound shipment.

truck_arrived_atISODateTime

Truck arrived at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

Referenced By

Example

{
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "inbound_shipment_id": "SW5ib3VuZFNoaXBtZW50OjEyMzQ=",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "purchase_orders_ids": ["UHVyY2hhc2VPcmRlcjoxMjM0", "UHVyY2hhc2VPcmRlcjo1Njc4"],
  "carrier": "ups",
  "estimated_truck_arrival": "2026-07-09T15:30:00Z",
  "booking_contact_email": "customer@example.com",
  "booking_contact_name": "Inbound Shipment 1001",
  "booking_contact_number": "+1-555-0100",
  "container_size": "M",
  "load_type": "palletized",
  "number_carton": 2,
  "pallets_quantity": 2,
  "pro_number": "PRO1234567",
  "shipment_type": "transfer",
  "truck_arrived_at": "2026-07-09T15:30:00Z"
}