input CreateInboundShipmentInput

Fields

Field	Type	Description
`customer_account_id`	`String`	Use this when you are a 3PL acting on behalf of one of your customers.
`warehouse_id`	`String`!	Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.
`purchase_order_ids`	[`String`]	List of public API purchase order IDs identifying related records.
`vendor_id`	`String`	Public API vendor ID that identifies the related record.
`carrier`	`String`	Carrier name or carrier code used for shipping.
`pro_number`	`String`	Pro number for this inbound shipment.
`bol_reference`	`String`	Bol reference for this inbound shipment.
`bol_url`	`String`	URL for the BOL URL resource.
`expected_dock`	`String`	Expected dock for this inbound shipment.
`dock_used`	`String`	Dock used for this inbound shipment.
`container_number`	`String`	Container number for this inbound shipment.
`notes`	`String`	Human-readable notes for this inbound shipment.
`estimated_truck_arrival`	ISODateTime	Estimated truck arrival as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`scheduled_at`	ISODateTime	Scheduled at as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`truck_arrived_at`	ISODateTime	Truck arrived at as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`truck_unload_started_at`	ISODateTime	Truck unload started at as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`truck_unload_finished_at`	ISODateTime	Truck unload finished at as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`truck_departure_at`	ISODateTime	Truck departure at as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`booking_contact_email`	`String`	Email address for the booking contact contact.
`booking_contact_name`	`String`	Booking contact name for this inbound shipment.
`booking_contact_number`	`String`	Booking contact number for this inbound shipment.
`container_size`	`String`	Container size for this inbound shipment.
`load_type`	`String`	Load type for this inbound shipment.
`shipment_type`	`String`	Shipment type for this inbound shipment.
`number_carton`	`Int`	Number carton as a whole-unit count.
`pallets_quantity`	`Int`	Pallets quantity as a whole-unit count.
`people_for_unload`	`Int`	People for unload as a whole-unit count.
`people_for_receiving`	`Int`	People for receiving as a whole-unit count.

Referenced By

inbound_shipment_create Mutation

Example

{
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "purchase_order_ids": ["UHVyY2hhc2VPcmRlcjoxMjM0", "UHVyY2hhc2VPcmRlcjo1Njc4"],
  "vendor_id": "VmVuZG9yOjEyMzQ=",
  "carrier": "ups",
  "pro_number": "PRO1234567",
  "bol_reference": "BOL-100045",
  "bol_url": "https://example.com/resource",
  "expected_dock": "Dock 3",
  "dock_used": "Dock 3",
  "container_number": "CONT-100045",
  "notes": "Customer requested expedited handling.",
  "estimated_truck_arrival": "2026-07-09T15:30:00Z",
  "scheduled_at": "2026-07-09T15:30:00Z",
  "truck_arrived_at": "2026-07-09T15:30:00Z",
  "truck_unload_started_at": "2026-07-09T15:30:00Z",
  "truck_unload_finished_at": "2026-07-09T15:30:00Z",
  "truck_departure_at": "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",
  "shipment_type": "transfer",
  "number_carton": 2,
  "pallets_quantity": 2,
  "people_for_unload": 2,
  "people_for_receiving": 2
}