input CreateShipmentInput

Fields

Field	Type	Description
`customer_account_id`	`String`	Use this when you are a 3PL acting on behalf of one of your customers.
`order_id`	`String`!	Public API order ID that identifies the related record.
`warehouse_id`	`String`!	Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.
`address`	AddressInput!	Address details for this shipment.
`line_items`	[CreateShipmentLineItemInput]!	List of line items associated with this shipment.
`labels`	[CreateShipmentShippingLabelInput]	List of labels associated with this shipment.
`notify_customer_via_shiphero`	`Boolean`	Whether Shiphero should notify the customer about this shipment.
`notify_customer_via_store`	`Boolean`	Whether the connected store should notify the customer about this shipment.
`shipped_off_shiphero`	`Boolean`	Whether this shipment was shipped outside Shiphero.
`profile`	`String`	Profile for this shipment.

Referenced By

shipment_create Mutation

Example

{
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "order_id": "T3JkZXI6MTIzNA==",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
  "line_items": [[{sku: "BLUE-TEE-M", quantity: 2}]],
  "labels": [[{tracking_number: "1Z999AA10123456784", carrier: "ups"}]],
  "notify_customer_via_shiphero": true,
  "notify_customer_via_store": true,
  "shipped_off_shiphero": true,
  "profile": "default"
}