Update Picking Order Item

updatePickingOrderItem Mutation

Updates an existing picking order item with new data. This allows modification of item details such as quantity, SKU, and custom data.

Arguments

Name	Type	Description
id	ID!	Required ID of the picking order item to update
input	UpdatePickingOrderItemInput!	Input data for updating the picking order item

Return Type

PickingOrderItemOutput - Contains the updated picking order item and any associated workflows.

Input Fields

UpdatePickingOrderItemInput:

Field	Type	Description
dataTypeID	UUID	Optional data type ID for custom validation
clearDataTypeID	Boolean	Clear the current data type ID
dataTypeSlug	String	Optional data type slug for custom validation
clearDataTypeSlug	Boolean	Clear the current data type slug
data	Map	Custom data associated with the order item
clearData	Boolean	Clear all custom data
sku	String	Stock keeping unit (SKU) of the item
quantity	Int	Quantity of the item to pick
orderID	ID	ID of the picking order this item belongs to

Usage Example

mutation {
  updatePickingOrderItem(
    id: "item-550e8400-e29b-41d4-a716-446655440000",
    input: {
      sku: "WIDGET-456-UPDATED",
      quantity: 15,
      data: {
        "priority": "urgent",
        "location_hint": "Aisle 3, Shelf A",
        "special_handling": "temperature_controlled",
        "notes": "Updated quantity due to inventory adjustment"
      }
    }
  ) {
    pickingOrderItem {
      id
      sku
      quantity
      data
      updatedAt
      order {
        id
        customerID
      }
    }
    workflows {
      id
      type
      id
      runID
      status
    }
  }
}

JavaScript Example

const updatePickingOrderItemMutation = `
  mutation UpdatePickingOrderItem($id: ID!, $input: UpdatePickingOrderItemInput!) {
    updatePickingOrderItem(id: $id, input: $input) {
      pickingOrderItem {
        id
        sku
        quantity
        data
        updatedAt
        order {
          id
          customerID
        }
      }
      workflows {
        id
        type
        id
        runID
        status
      }
    }
  }
`;

const variables = {
  id: "item-550e8400-e29b-41d4-a716-446655440000",
  input: {
    sku: "WIDGET-456-UPDATED",
    quantity: 15,
    data: {
      priority: "urgent",
      location_hint: "Aisle 3, Shelf A",
      special_handling: "temperature_controlled",
      notes: "Updated quantity due to inventory adjustment"
    }
  }
};

// Using fetch or your preferred GraphQL client
const response = await fetch('/graphql', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_TOKEN'
  },
  body: JSON.stringify({
    query: updatePickingOrderItemMutation,
    variables: variables
  })
});

const result = await response.json();
console.log('Updated picking order item:', result.data.updatePickingOrderItem);

Clearing Data Example

You can also clear specific fields using the clear flags:

mutation {
  updatePickingOrderItem(
    id: "item-550e8400-e29b-41d4-a716-446655440000",
    input: {
      clearData: true,
      clearDataTypeID: true,
      quantity: 20
    }
  ) {
    pickingOrderItem {
      id
      sku
      quantity
      data
      dataTypeID
    }
  }
}

Changing Order Association

You can also move an item to a different picking order:

mutation {
  updatePickingOrderItem(
    id: "item-550e8400-e29b-41d4-a716-446655440000",
    input: {
      orderID: "new-order-123e4567-e89b-12d3-a456-426614174000"
    }
  ) {
    pickingOrderItem {
      id
      order {
        id
        customerID
      }
    }
  }
}

Notes

• The picking order item must exist and be accessible to the current user

• Updates may trigger associated workflows depending on system configuration

• Use clear flags (e.g., clearData, clearDataTypeID) to explicitly remove data

• The quantity must be a positive integer if provided

• The sku should correspond to a valid inventory item if provided

• Changing the orderID moves the item to a different picking order

• Some fields may not be editable if the item's picking order is in certain workflow states

• Custom data can include any JSON-serializable information relevant to the item