Shipping Orders Mutations

CreateShippingOrderFrom

Creates a shipping order from a Sales Order.

Parameters:

ParameterTypeDescription
inputShippingOrderFromInput!Source orders IDs.

Example Query:

mutation CreateShippingOrderFrom($input: ShippingOrderFromInput!) {
  CreateShippingOrderFrom(input: $input) {
    id
    label
    status
  }
}

UpdateShippingOrder

Updates an existing shipping order.

Parameters:

ParameterTypeDescription
idInt!ID of the shipping order.
inputShippingOrderInput!Updated data.

DeleteShippingOrder / DeleteShippingOrders

Deletes one or multiple shipping orders.


UpdateShippingOrdersStatus

Bulk update status for multiple shipping orders.

Parameters:

ParameterTypeDescription
ids[Int!]!List of shipping order IDs.
statusShippingOrderStatus!New status.

GenerateShippingOrdersPdfs

Generates PDF documents for multiple shipping orders.


Input Data Types

ShippingOrderInput

FieldTypeDescription
idIntID.
labelStringShipping order number.
total_unitsFloatTotal units for the shipping order.
statusShippingOrderStatusStatus.
dated_atDateDocument date.
shipping_atDateExpected shipping date.
notesStringPublic notes.
internal_notesStringPrivate notes.
for_the_attention_ofStringContact person name.
external_referenceStringCustomer reference.
line_items[LineItemShippingOrderInput]Items list.
shipping_addressAddressInputShipping destination address.
account_representativeAccountRepresentativeInputSales rep data.
pdf_templatePdfTemplateInputPDF design for delivery note.
picking_list_pdf_templatePdfTemplateInputPDF design for picking list.
seasonSeasonInputSeason data.
files[FileInput]Attachments.
custom_fields[EntityCustomFieldInput]Custom fields for this entity.

ShippingOrderFromInput

FieldTypeDescription
Order[Int!]Source orders IDs.

Enums

ShippingOrderStatus

ValueDescription
unpublishedDraft status.
pendingDocument processed, shipment pending.
make_the_shipmentReady for pick & tour.
in_preparationPacking in progress.
ready_to_shipBox labeled and ready.
shippedLeft the warehouse.
deliveredReceived by customer.
cancelledDocument cancelled.