Skip to main content

AppCreateExternalShipmentInput

A shipment an installed shipping app booked with its carrier. Lines not yet shipped are shipped through the order's own ship command (stock issues once); lines already shipped get the booking only. A request mixing the two is refused. No price is ever sent.

input AppCreateExternalShipmentInput {
  carrierName: String
  items: [AppExternalShipmentItemInput!]!
  labelKey: String
  notes: String
  parcels: [DeliveryParcelInput!]
  salesOrderId: ID!
  serviceLevelCode: String
  serviceLevelName: String
  trackingNumber: String!
  trackingUrl: String
}

Fields

`AppCreateExternalShipmentInput.carrierName` ● `String` scalar

The courier that carries it, when your service books several couriers.

`AppCreateExternalShipmentInput.items` ● `[AppExternalShipmentItemInput!]!` non-null input

The lines this shipment carries. All of them must be still to ship, or all already shipped and not yet on a shipment.

`AppCreateExternalShipmentInput.labelKey` ● `String` scalar

The key of the shipping label you staged with stagedUploadsCreate (purpose SHIPPING_LABEL). URLs are not accepted.

`AppCreateExternalShipmentInput.notes` ● `String` scalar

A note for staff.

`AppCreateExternalShipmentInput.parcels` ● `[DeliveryParcelInput!]` list input

The parcels booked. Without them the order's packing applies.

`AppCreateExternalShipmentInput.salesOrderId` ● `ID!` non-null scalar

The ID of the sales order.

`AppCreateExternalShipmentInput.serviceLevelCode` ● `String` scalar

The carrier's service code.

`AppCreateExternalShipmentInput.serviceLevelName` ● `String` scalar

The carrier's service name.

`AppCreateExternalShipmentInput.trackingNumber` ● `String!` non-null scalar

The carrier's tracking number for this shipment.

`AppCreateExternalShipmentInput.trackingUrl` ● `String` scalar

The https link to the carrier's tracking page.

Member Of

createExternalShipment mutation

Fields
Member Of